Change to flush and close logic to fix #1760556.
[python.git] / Modules / arraymodule.c
blobb2ee5b016db43ddba92af1bc6a784d7a62a38bc7
1 /* Array object implementation */
3 /* An array is a uniform list -- all items have the same type.
4 The item type is restricted to simple C types like int or float */
6 #define PY_SSIZE_T_CLEAN
7 #include "Python.h"
8 #include "structmember.h"
10 #ifdef STDC_HEADERS
11 #include <stddef.h>
12 #else /* !STDC_HEADERS */
13 #ifdef HAVE_SYS_TYPES_H
14 #include <sys/types.h> /* For size_t */
15 #endif /* HAVE_SYS_TYPES_H */
16 #endif /* !STDC_HEADERS */
18 struct arrayobject; /* Forward */
20 /* All possible arraydescr values are defined in the vector "descriptors"
21 * below. That's defined later because the appropriate get and set
22 * functions aren't visible yet.
24 struct arraydescr {
25 int typecode;
26 int itemsize;
27 PyObject * (*getitem)(struct arrayobject *, Py_ssize_t);
28 int (*setitem)(struct arrayobject *, Py_ssize_t, PyObject *);
31 typedef struct arrayobject {
32 PyObject_VAR_HEAD
33 char *ob_item;
34 Py_ssize_t allocated;
35 struct arraydescr *ob_descr;
36 PyObject *weakreflist; /* List of weak references */
37 } arrayobject;
39 static PyTypeObject Arraytype;
41 #define array_Check(op) PyObject_TypeCheck(op, &Arraytype)
42 #define array_CheckExact(op) (Py_Type(op) == &Arraytype)
44 static int
45 array_resize(arrayobject *self, Py_ssize_t newsize)
47 char *items;
48 size_t _new_size;
50 /* Bypass realloc() when a previous overallocation is large enough
51 to accommodate the newsize. If the newsize is 16 smaller than the
52 current size, then proceed with the realloc() to shrink the list.
55 if (self->allocated >= newsize &&
56 Py_Size(self) < newsize + 16 &&
57 self->ob_item != NULL) {
58 Py_Size(self) = newsize;
59 return 0;
62 /* This over-allocates proportional to the array size, making room
63 * for additional growth. The over-allocation is mild, but is
64 * enough to give linear-time amortized behavior over a long
65 * sequence of appends() in the presence of a poorly-performing
66 * system realloc().
67 * The growth pattern is: 0, 4, 8, 16, 25, 34, 46, 56, 67, 79, ...
68 * Note, the pattern starts out the same as for lists but then
69 * grows at a smaller rate so that larger arrays only overallocate
70 * by about 1/16th -- this is done because arrays are presumed to be more
71 * memory critical.
74 _new_size = (newsize >> 4) + (Py_Size(self) < 8 ? 3 : 7) + newsize;
75 items = self->ob_item;
76 /* XXX The following multiplication and division does not optimize away
77 like it does for lists since the size is not known at compile time */
78 if (_new_size <= ((~(size_t)0) / self->ob_descr->itemsize))
79 PyMem_RESIZE(items, char, (_new_size * self->ob_descr->itemsize));
80 else
81 items = NULL;
82 if (items == NULL) {
83 PyErr_NoMemory();
84 return -1;
86 self->ob_item = items;
87 Py_Size(self) = newsize;
88 self->allocated = _new_size;
89 return 0;
92 /****************************************************************************
93 Get and Set functions for each type.
94 A Get function takes an arrayobject* and an integer index, returning the
95 array value at that index wrapped in an appropriate PyObject*.
96 A Set function takes an arrayobject, integer index, and PyObject*; sets
97 the array value at that index to the raw C data extracted from the PyObject*,
98 and returns 0 if successful, else nonzero on failure (PyObject* not of an
99 appropriate type or value).
100 Note that the basic Get and Set functions do NOT check that the index is
101 in bounds; that's the responsibility of the caller.
102 ****************************************************************************/
104 static PyObject *
105 c_getitem(arrayobject *ap, Py_ssize_t i)
107 return PyString_FromStringAndSize(&((char *)ap->ob_item)[i], 1);
110 static int
111 c_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
113 char x;
114 if (!PyArg_Parse(v, "c;array item must be char", &x))
115 return -1;
116 if (i >= 0)
117 ((char *)ap->ob_item)[i] = x;
118 return 0;
121 static PyObject *
122 b_getitem(arrayobject *ap, Py_ssize_t i)
124 long x = ((char *)ap->ob_item)[i];
125 if (x >= 128)
126 x -= 256;
127 return PyInt_FromLong(x);
130 static int
131 b_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
133 short x;
134 /* PyArg_Parse's 'b' formatter is for an unsigned char, therefore
135 must use the next size up that is signed ('h') and manually do
136 the overflow checking */
137 if (!PyArg_Parse(v, "h;array item must be integer", &x))
138 return -1;
139 else if (x < -128) {
140 PyErr_SetString(PyExc_OverflowError,
141 "signed char is less than minimum");
142 return -1;
144 else if (x > 127) {
145 PyErr_SetString(PyExc_OverflowError,
146 "signed char is greater than maximum");
147 return -1;
149 if (i >= 0)
150 ((char *)ap->ob_item)[i] = (char)x;
151 return 0;
154 static PyObject *
155 BB_getitem(arrayobject *ap, Py_ssize_t i)
157 long x = ((unsigned char *)ap->ob_item)[i];
158 return PyInt_FromLong(x);
161 static int
162 BB_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
164 unsigned char x;
165 /* 'B' == unsigned char, maps to PyArg_Parse's 'b' formatter */
166 if (!PyArg_Parse(v, "b;array item must be integer", &x))
167 return -1;
168 if (i >= 0)
169 ((char *)ap->ob_item)[i] = x;
170 return 0;
173 #ifdef Py_USING_UNICODE
174 static PyObject *
175 u_getitem(arrayobject *ap, Py_ssize_t i)
177 return PyUnicode_FromUnicode(&((Py_UNICODE *) ap->ob_item)[i], 1);
180 static int
181 u_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
183 Py_UNICODE *p;
184 Py_ssize_t len;
186 if (!PyArg_Parse(v, "u#;array item must be unicode character", &p, &len))
187 return -1;
188 if (len != 1) {
189 PyErr_SetString(PyExc_TypeError,
190 "array item must be unicode character");
191 return -1;
193 if (i >= 0)
194 ((Py_UNICODE *)ap->ob_item)[i] = p[0];
195 return 0;
197 #endif
199 static PyObject *
200 h_getitem(arrayobject *ap, Py_ssize_t i)
202 return PyInt_FromLong((long) ((short *)ap->ob_item)[i]);
205 static int
206 h_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
208 short x;
209 /* 'h' == signed short, maps to PyArg_Parse's 'h' formatter */
210 if (!PyArg_Parse(v, "h;array item must be integer", &x))
211 return -1;
212 if (i >= 0)
213 ((short *)ap->ob_item)[i] = x;
214 return 0;
217 static PyObject *
218 HH_getitem(arrayobject *ap, Py_ssize_t i)
220 return PyInt_FromLong((long) ((unsigned short *)ap->ob_item)[i]);
223 static int
224 HH_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
226 int x;
227 /* PyArg_Parse's 'h' formatter is for a signed short, therefore
228 must use the next size up and manually do the overflow checking */
229 if (!PyArg_Parse(v, "i;array item must be integer", &x))
230 return -1;
231 else if (x < 0) {
232 PyErr_SetString(PyExc_OverflowError,
233 "unsigned short is less than minimum");
234 return -1;
236 else if (x > USHRT_MAX) {
237 PyErr_SetString(PyExc_OverflowError,
238 "unsigned short is greater than maximum");
239 return -1;
241 if (i >= 0)
242 ((short *)ap->ob_item)[i] = (short)x;
243 return 0;
246 static PyObject *
247 i_getitem(arrayobject *ap, Py_ssize_t i)
249 return PyInt_FromLong((long) ((int *)ap->ob_item)[i]);
252 static int
253 i_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
255 int x;
256 /* 'i' == signed int, maps to PyArg_Parse's 'i' formatter */
257 if (!PyArg_Parse(v, "i;array item must be integer", &x))
258 return -1;
259 if (i >= 0)
260 ((int *)ap->ob_item)[i] = x;
261 return 0;
264 static PyObject *
265 II_getitem(arrayobject *ap, Py_ssize_t i)
267 return PyLong_FromUnsignedLong(
268 (unsigned long) ((unsigned int *)ap->ob_item)[i]);
271 static int
272 II_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
274 unsigned long x;
275 if (PyLong_Check(v)) {
276 x = PyLong_AsUnsignedLong(v);
277 if (x == (unsigned long) -1 && PyErr_Occurred())
278 return -1;
280 else {
281 long y;
282 if (!PyArg_Parse(v, "l;array item must be integer", &y))
283 return -1;
284 if (y < 0) {
285 PyErr_SetString(PyExc_OverflowError,
286 "unsigned int is less than minimum");
287 return -1;
289 x = (unsigned long)y;
292 if (x > UINT_MAX) {
293 PyErr_SetString(PyExc_OverflowError,
294 "unsigned int is greater than maximum");
295 return -1;
298 if (i >= 0)
299 ((unsigned int *)ap->ob_item)[i] = (unsigned int)x;
300 return 0;
303 static PyObject *
304 l_getitem(arrayobject *ap, Py_ssize_t i)
306 return PyInt_FromLong(((long *)ap->ob_item)[i]);
309 static int
310 l_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
312 long x;
313 if (!PyArg_Parse(v, "l;array item must be integer", &x))
314 return -1;
315 if (i >= 0)
316 ((long *)ap->ob_item)[i] = x;
317 return 0;
320 static PyObject *
321 LL_getitem(arrayobject *ap, Py_ssize_t i)
323 return PyLong_FromUnsignedLong(((unsigned long *)ap->ob_item)[i]);
326 static int
327 LL_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
329 unsigned long x;
330 if (PyLong_Check(v)) {
331 x = PyLong_AsUnsignedLong(v);
332 if (x == (unsigned long) -1 && PyErr_Occurred())
333 return -1;
335 else {
336 long y;
337 if (!PyArg_Parse(v, "l;array item must be integer", &y))
338 return -1;
339 if (y < 0) {
340 PyErr_SetString(PyExc_OverflowError,
341 "unsigned long is less than minimum");
342 return -1;
344 x = (unsigned long)y;
347 if (x > ULONG_MAX) {
348 PyErr_SetString(PyExc_OverflowError,
349 "unsigned long is greater than maximum");
350 return -1;
353 if (i >= 0)
354 ((unsigned long *)ap->ob_item)[i] = x;
355 return 0;
358 static PyObject *
359 f_getitem(arrayobject *ap, Py_ssize_t i)
361 return PyFloat_FromDouble((double) ((float *)ap->ob_item)[i]);
364 static int
365 f_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
367 float x;
368 if (!PyArg_Parse(v, "f;array item must be float", &x))
369 return -1;
370 if (i >= 0)
371 ((float *)ap->ob_item)[i] = x;
372 return 0;
375 static PyObject *
376 d_getitem(arrayobject *ap, Py_ssize_t i)
378 return PyFloat_FromDouble(((double *)ap->ob_item)[i]);
381 static int
382 d_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
384 double x;
385 if (!PyArg_Parse(v, "d;array item must be float", &x))
386 return -1;
387 if (i >= 0)
388 ((double *)ap->ob_item)[i] = x;
389 return 0;
392 /* Description of types */
393 static struct arraydescr descriptors[] = {
394 {'c', sizeof(char), c_getitem, c_setitem},
395 {'b', sizeof(char), b_getitem, b_setitem},
396 {'B', sizeof(char), BB_getitem, BB_setitem},
397 #ifdef Py_USING_UNICODE
398 {'u', sizeof(Py_UNICODE), u_getitem, u_setitem},
399 #endif
400 {'h', sizeof(short), h_getitem, h_setitem},
401 {'H', sizeof(short), HH_getitem, HH_setitem},
402 {'i', sizeof(int), i_getitem, i_setitem},
403 {'I', sizeof(int), II_getitem, II_setitem},
404 {'l', sizeof(long), l_getitem, l_setitem},
405 {'L', sizeof(long), LL_getitem, LL_setitem},
406 {'f', sizeof(float), f_getitem, f_setitem},
407 {'d', sizeof(double), d_getitem, d_setitem},
408 {'\0', 0, 0, 0} /* Sentinel */
411 /****************************************************************************
412 Implementations of array object methods.
413 ****************************************************************************/
415 static PyObject *
416 newarrayobject(PyTypeObject *type, Py_ssize_t size, struct arraydescr *descr)
418 arrayobject *op;
419 size_t nbytes;
421 if (size < 0) {
422 PyErr_BadInternalCall();
423 return NULL;
426 nbytes = size * descr->itemsize;
427 /* Check for overflow */
428 if (nbytes / descr->itemsize != (size_t)size) {
429 return PyErr_NoMemory();
431 op = (arrayobject *) type->tp_alloc(type, 0);
432 if (op == NULL) {
433 return NULL;
435 Py_Size(op) = size;
436 if (size <= 0) {
437 op->ob_item = NULL;
439 else {
440 op->ob_item = PyMem_NEW(char, nbytes);
441 if (op->ob_item == NULL) {
442 PyObject_Del(op);
443 return PyErr_NoMemory();
446 op->ob_descr = descr;
447 op->allocated = size;
448 op->weakreflist = NULL;
449 return (PyObject *) op;
452 static PyObject *
453 getarrayitem(PyObject *op, Py_ssize_t i)
455 register arrayobject *ap;
456 assert(array_Check(op));
457 ap = (arrayobject *)op;
458 assert(i>=0 && i<Py_Size(ap));
459 return (*ap->ob_descr->getitem)(ap, i);
462 static int
463 ins1(arrayobject *self, Py_ssize_t where, PyObject *v)
465 char *items;
466 Py_ssize_t n = Py_Size(self);
467 if (v == NULL) {
468 PyErr_BadInternalCall();
469 return -1;
471 if ((*self->ob_descr->setitem)(self, -1, v) < 0)
472 return -1;
474 if (array_resize(self, n+1) == -1)
475 return -1;
476 items = self->ob_item;
477 if (where < 0) {
478 where += n;
479 if (where < 0)
480 where = 0;
482 if (where > n)
483 where = n;
484 /* appends don't need to call memmove() */
485 if (where != n)
486 memmove(items + (where+1)*self->ob_descr->itemsize,
487 items + where*self->ob_descr->itemsize,
488 (n-where)*self->ob_descr->itemsize);
489 return (*self->ob_descr->setitem)(self, where, v);
492 /* Methods */
494 static void
495 array_dealloc(arrayobject *op)
497 if (op->weakreflist != NULL)
498 PyObject_ClearWeakRefs((PyObject *) op);
499 if (op->ob_item != NULL)
500 PyMem_DEL(op->ob_item);
501 Py_Type(op)->tp_free((PyObject *)op);
504 static PyObject *
505 array_richcompare(PyObject *v, PyObject *w, int op)
507 arrayobject *va, *wa;
508 PyObject *vi = NULL;
509 PyObject *wi = NULL;
510 Py_ssize_t i, k;
511 PyObject *res;
513 if (!array_Check(v) || !array_Check(w)) {
514 Py_INCREF(Py_NotImplemented);
515 return Py_NotImplemented;
518 va = (arrayobject *)v;
519 wa = (arrayobject *)w;
521 if (Py_Size(va) != Py_Size(wa) && (op == Py_EQ || op == Py_NE)) {
522 /* Shortcut: if the lengths differ, the arrays differ */
523 if (op == Py_EQ)
524 res = Py_False;
525 else
526 res = Py_True;
527 Py_INCREF(res);
528 return res;
531 /* Search for the first index where items are different */
532 k = 1;
533 for (i = 0; i < Py_Size(va) && i < Py_Size(wa); i++) {
534 vi = getarrayitem(v, i);
535 wi = getarrayitem(w, i);
536 if (vi == NULL || wi == NULL) {
537 Py_XDECREF(vi);
538 Py_XDECREF(wi);
539 return NULL;
541 k = PyObject_RichCompareBool(vi, wi, Py_EQ);
542 if (k == 0)
543 break; /* Keeping vi and wi alive! */
544 Py_DECREF(vi);
545 Py_DECREF(wi);
546 if (k < 0)
547 return NULL;
550 if (k) {
551 /* No more items to compare -- compare sizes */
552 Py_ssize_t vs = Py_Size(va);
553 Py_ssize_t ws = Py_Size(wa);
554 int cmp;
555 switch (op) {
556 case Py_LT: cmp = vs < ws; break;
557 case Py_LE: cmp = vs <= ws; break;
558 case Py_EQ: cmp = vs == ws; break;
559 case Py_NE: cmp = vs != ws; break;
560 case Py_GT: cmp = vs > ws; break;
561 case Py_GE: cmp = vs >= ws; break;
562 default: return NULL; /* cannot happen */
564 if (cmp)
565 res = Py_True;
566 else
567 res = Py_False;
568 Py_INCREF(res);
569 return res;
572 /* We have an item that differs. First, shortcuts for EQ/NE */
573 if (op == Py_EQ) {
574 Py_INCREF(Py_False);
575 res = Py_False;
577 else if (op == Py_NE) {
578 Py_INCREF(Py_True);
579 res = Py_True;
581 else {
582 /* Compare the final item again using the proper operator */
583 res = PyObject_RichCompare(vi, wi, op);
585 Py_DECREF(vi);
586 Py_DECREF(wi);
587 return res;
590 static Py_ssize_t
591 array_length(arrayobject *a)
593 return Py_Size(a);
596 static PyObject *
597 array_item(arrayobject *a, Py_ssize_t i)
599 if (i < 0 || i >= Py_Size(a)) {
600 PyErr_SetString(PyExc_IndexError, "array index out of range");
601 return NULL;
603 return getarrayitem((PyObject *)a, i);
606 static PyObject *
607 array_slice(arrayobject *a, Py_ssize_t ilow, Py_ssize_t ihigh)
609 arrayobject *np;
610 if (ilow < 0)
611 ilow = 0;
612 else if (ilow > Py_Size(a))
613 ilow = Py_Size(a);
614 if (ihigh < 0)
615 ihigh = 0;
616 if (ihigh < ilow)
617 ihigh = ilow;
618 else if (ihigh > Py_Size(a))
619 ihigh = Py_Size(a);
620 np = (arrayobject *) newarrayobject(&Arraytype, ihigh - ilow, a->ob_descr);
621 if (np == NULL)
622 return NULL;
623 memcpy(np->ob_item, a->ob_item + ilow * a->ob_descr->itemsize,
624 (ihigh-ilow) * a->ob_descr->itemsize);
625 return (PyObject *)np;
628 static PyObject *
629 array_copy(arrayobject *a, PyObject *unused)
631 return array_slice(a, 0, Py_Size(a));
634 PyDoc_STRVAR(copy_doc,
635 "copy(array)\n\
637 Return a copy of the array.");
639 static PyObject *
640 array_concat(arrayobject *a, PyObject *bb)
642 Py_ssize_t size;
643 arrayobject *np;
644 if (!array_Check(bb)) {
645 PyErr_Format(PyExc_TypeError,
646 "can only append array (not \"%.200s\") to array",
647 Py_Type(bb)->tp_name);
648 return NULL;
650 #define b ((arrayobject *)bb)
651 if (a->ob_descr != b->ob_descr) {
652 PyErr_BadArgument();
653 return NULL;
655 size = Py_Size(a) + Py_Size(b);
656 np = (arrayobject *) newarrayobject(&Arraytype, size, a->ob_descr);
657 if (np == NULL) {
658 return NULL;
660 memcpy(np->ob_item, a->ob_item, Py_Size(a)*a->ob_descr->itemsize);
661 memcpy(np->ob_item + Py_Size(a)*a->ob_descr->itemsize,
662 b->ob_item, Py_Size(b)*b->ob_descr->itemsize);
663 return (PyObject *)np;
664 #undef b
667 static PyObject *
668 array_repeat(arrayobject *a, Py_ssize_t n)
670 Py_ssize_t i;
671 Py_ssize_t size;
672 arrayobject *np;
673 char *p;
674 Py_ssize_t nbytes;
675 if (n < 0)
676 n = 0;
677 size = Py_Size(a) * n;
678 np = (arrayobject *) newarrayobject(&Arraytype, size, a->ob_descr);
679 if (np == NULL)
680 return NULL;
681 p = np->ob_item;
682 nbytes = Py_Size(a) * a->ob_descr->itemsize;
683 for (i = 0; i < n; i++) {
684 memcpy(p, a->ob_item, nbytes);
685 p += nbytes;
687 return (PyObject *) np;
690 static int
691 array_ass_slice(arrayobject *a, Py_ssize_t ilow, Py_ssize_t ihigh, PyObject *v)
693 char *item;
694 Py_ssize_t n; /* Size of replacement array */
695 Py_ssize_t d; /* Change in size */
696 #define b ((arrayobject *)v)
697 if (v == NULL)
698 n = 0;
699 else if (array_Check(v)) {
700 n = Py_Size(b);
701 if (a == b) {
702 /* Special case "a[i:j] = a" -- copy b first */
703 int ret;
704 v = array_slice(b, 0, n);
705 if (!v)
706 return -1;
707 ret = array_ass_slice(a, ilow, ihigh, v);
708 Py_DECREF(v);
709 return ret;
711 if (b->ob_descr != a->ob_descr) {
712 PyErr_BadArgument();
713 return -1;
716 else {
717 PyErr_Format(PyExc_TypeError,
718 "can only assign array (not \"%.200s\") to array slice",
719 Py_Type(v)->tp_name);
720 return -1;
722 if (ilow < 0)
723 ilow = 0;
724 else if (ilow > Py_Size(a))
725 ilow = Py_Size(a);
726 if (ihigh < 0)
727 ihigh = 0;
728 if (ihigh < ilow)
729 ihigh = ilow;
730 else if (ihigh > Py_Size(a))
731 ihigh = Py_Size(a);
732 item = a->ob_item;
733 d = n - (ihigh-ilow);
734 if (d < 0) { /* Delete -d items */
735 memmove(item + (ihigh+d)*a->ob_descr->itemsize,
736 item + ihigh*a->ob_descr->itemsize,
737 (Py_Size(a)-ihigh)*a->ob_descr->itemsize);
738 Py_Size(a) += d;
739 PyMem_RESIZE(item, char, Py_Size(a)*a->ob_descr->itemsize);
740 /* Can't fail */
741 a->ob_item = item;
742 a->allocated = Py_Size(a);
744 else if (d > 0) { /* Insert d items */
745 PyMem_RESIZE(item, char,
746 (Py_Size(a) + d)*a->ob_descr->itemsize);
747 if (item == NULL) {
748 PyErr_NoMemory();
749 return -1;
751 memmove(item + (ihigh+d)*a->ob_descr->itemsize,
752 item + ihigh*a->ob_descr->itemsize,
753 (Py_Size(a)-ihigh)*a->ob_descr->itemsize);
754 a->ob_item = item;
755 Py_Size(a) += d;
756 a->allocated = Py_Size(a);
758 if (n > 0)
759 memcpy(item + ilow*a->ob_descr->itemsize, b->ob_item,
760 n*b->ob_descr->itemsize);
761 return 0;
762 #undef b
765 static int
766 array_ass_item(arrayobject *a, Py_ssize_t i, PyObject *v)
768 if (i < 0 || i >= Py_Size(a)) {
769 PyErr_SetString(PyExc_IndexError,
770 "array assignment index out of range");
771 return -1;
773 if (v == NULL)
774 return array_ass_slice(a, i, i+1, v);
775 return (*a->ob_descr->setitem)(a, i, v);
778 static int
779 setarrayitem(PyObject *a, Py_ssize_t i, PyObject *v)
781 assert(array_Check(a));
782 return array_ass_item((arrayobject *)a, i, v);
785 static int
786 array_iter_extend(arrayobject *self, PyObject *bb)
788 PyObject *it, *v;
790 it = PyObject_GetIter(bb);
791 if (it == NULL)
792 return -1;
794 while ((v = PyIter_Next(it)) != NULL) {
795 if (ins1(self, (int) Py_Size(self), v) != 0) {
796 Py_DECREF(v);
797 Py_DECREF(it);
798 return -1;
800 Py_DECREF(v);
802 Py_DECREF(it);
803 if (PyErr_Occurred())
804 return -1;
805 return 0;
808 static int
809 array_do_extend(arrayobject *self, PyObject *bb)
811 Py_ssize_t size;
813 if (!array_Check(bb))
814 return array_iter_extend(self, bb);
815 #define b ((arrayobject *)bb)
816 if (self->ob_descr != b->ob_descr) {
817 PyErr_SetString(PyExc_TypeError,
818 "can only extend with array of same kind");
819 return -1;
821 size = Py_Size(self) + Py_Size(b);
822 PyMem_RESIZE(self->ob_item, char, size*self->ob_descr->itemsize);
823 if (self->ob_item == NULL) {
824 PyObject_Del(self);
825 PyErr_NoMemory();
826 return -1;
828 memcpy(self->ob_item + Py_Size(self)*self->ob_descr->itemsize,
829 b->ob_item, Py_Size(b)*b->ob_descr->itemsize);
830 Py_Size(self) = size;
831 self->allocated = size;
833 return 0;
834 #undef b
837 static PyObject *
838 array_inplace_concat(arrayobject *self, PyObject *bb)
840 if (!array_Check(bb)) {
841 PyErr_Format(PyExc_TypeError,
842 "can only extend array with array (not \"%.200s\")",
843 Py_Type(bb)->tp_name);
844 return NULL;
846 if (array_do_extend(self, bb) == -1)
847 return NULL;
848 Py_INCREF(self);
849 return (PyObject *)self;
852 static PyObject *
853 array_inplace_repeat(arrayobject *self, Py_ssize_t n)
855 char *items, *p;
856 Py_ssize_t size, i;
858 if (Py_Size(self) > 0) {
859 if (n < 0)
860 n = 0;
861 items = self->ob_item;
862 size = Py_Size(self) * self->ob_descr->itemsize;
863 if (n == 0) {
864 PyMem_FREE(items);
865 self->ob_item = NULL;
866 Py_Size(self) = 0;
867 self->allocated = 0;
869 else {
870 PyMem_Resize(items, char, n * size);
871 if (items == NULL)
872 return PyErr_NoMemory();
873 p = items;
874 for (i = 1; i < n; i++) {
875 p += size;
876 memcpy(p, items, size);
878 self->ob_item = items;
879 Py_Size(self) *= n;
880 self->allocated = Py_Size(self);
883 Py_INCREF(self);
884 return (PyObject *)self;
888 static PyObject *
889 ins(arrayobject *self, Py_ssize_t where, PyObject *v)
891 if (ins1(self, where, v) != 0)
892 return NULL;
893 Py_INCREF(Py_None);
894 return Py_None;
897 static PyObject *
898 array_count(arrayobject *self, PyObject *v)
900 Py_ssize_t count = 0;
901 Py_ssize_t i;
903 for (i = 0; i < Py_Size(self); i++) {
904 PyObject *selfi = getarrayitem((PyObject *)self, i);
905 int cmp = PyObject_RichCompareBool(selfi, v, Py_EQ);
906 Py_DECREF(selfi);
907 if (cmp > 0)
908 count++;
909 else if (cmp < 0)
910 return NULL;
912 return PyInt_FromSsize_t(count);
915 PyDoc_STRVAR(count_doc,
916 "count(x)\n\
918 Return number of occurences of x in the array.");
920 static PyObject *
921 array_index(arrayobject *self, PyObject *v)
923 Py_ssize_t i;
925 for (i = 0; i < Py_Size(self); i++) {
926 PyObject *selfi = getarrayitem((PyObject *)self, i);
927 int cmp = PyObject_RichCompareBool(selfi, v, Py_EQ);
928 Py_DECREF(selfi);
929 if (cmp > 0) {
930 return PyInt_FromLong((long)i);
932 else if (cmp < 0)
933 return NULL;
935 PyErr_SetString(PyExc_ValueError, "array.index(x): x not in list");
936 return NULL;
939 PyDoc_STRVAR(index_doc,
940 "index(x)\n\
942 Return index of first occurence of x in the array.");
944 static int
945 array_contains(arrayobject *self, PyObject *v)
947 Py_ssize_t i;
948 int cmp;
950 for (i = 0, cmp = 0 ; cmp == 0 && i < Py_Size(self); i++) {
951 PyObject *selfi = getarrayitem((PyObject *)self, i);
952 cmp = PyObject_RichCompareBool(selfi, v, Py_EQ);
953 Py_DECREF(selfi);
955 return cmp;
958 static PyObject *
959 array_remove(arrayobject *self, PyObject *v)
961 int i;
963 for (i = 0; i < Py_Size(self); i++) {
964 PyObject *selfi = getarrayitem((PyObject *)self,i);
965 int cmp = PyObject_RichCompareBool(selfi, v, Py_EQ);
966 Py_DECREF(selfi);
967 if (cmp > 0) {
968 if (array_ass_slice(self, i, i+1,
969 (PyObject *)NULL) != 0)
970 return NULL;
971 Py_INCREF(Py_None);
972 return Py_None;
974 else if (cmp < 0)
975 return NULL;
977 PyErr_SetString(PyExc_ValueError, "array.remove(x): x not in list");
978 return NULL;
981 PyDoc_STRVAR(remove_doc,
982 "remove(x)\n\
984 Remove the first occurence of x in the array.");
986 static PyObject *
987 array_pop(arrayobject *self, PyObject *args)
989 Py_ssize_t i = -1;
990 PyObject *v;
991 if (!PyArg_ParseTuple(args, "|n:pop", &i))
992 return NULL;
993 if (Py_Size(self) == 0) {
994 /* Special-case most common failure cause */
995 PyErr_SetString(PyExc_IndexError, "pop from empty array");
996 return NULL;
998 if (i < 0)
999 i += Py_Size(self);
1000 if (i < 0 || i >= Py_Size(self)) {
1001 PyErr_SetString(PyExc_IndexError, "pop index out of range");
1002 return NULL;
1004 v = getarrayitem((PyObject *)self,i);
1005 if (array_ass_slice(self, i, i+1, (PyObject *)NULL) != 0) {
1006 Py_DECREF(v);
1007 return NULL;
1009 return v;
1012 PyDoc_STRVAR(pop_doc,
1013 "pop([i])\n\
1015 Return the i-th element and delete it from the array. i defaults to -1.");
1017 static PyObject *
1018 array_extend(arrayobject *self, PyObject *bb)
1020 if (array_do_extend(self, bb) == -1)
1021 return NULL;
1022 Py_INCREF(Py_None);
1023 return Py_None;
1026 PyDoc_STRVAR(extend_doc,
1027 "extend(array or iterable)\n\
1029 Append items to the end of the array.");
1031 static PyObject *
1032 array_insert(arrayobject *self, PyObject *args)
1034 Py_ssize_t i;
1035 PyObject *v;
1036 if (!PyArg_ParseTuple(args, "nO:insert", &i, &v))
1037 return NULL;
1038 return ins(self, i, v);
1041 PyDoc_STRVAR(insert_doc,
1042 "insert(i,x)\n\
1044 Insert a new item x into the array before position i.");
1047 static PyObject *
1048 array_buffer_info(arrayobject *self, PyObject *unused)
1050 PyObject* retval = NULL;
1051 retval = PyTuple_New(2);
1052 if (!retval)
1053 return NULL;
1055 PyTuple_SET_ITEM(retval, 0, PyLong_FromVoidPtr(self->ob_item));
1056 PyTuple_SET_ITEM(retval, 1, PyInt_FromLong((long)(Py_Size(self))));
1058 return retval;
1061 PyDoc_STRVAR(buffer_info_doc,
1062 "buffer_info() -> (address, length)\n\
1064 Return a tuple (address, length) giving the current memory address and\n\
1065 the length in items of the buffer used to hold array's contents\n\
1066 The length should be multiplied by the itemsize attribute to calculate\n\
1067 the buffer length in bytes.");
1070 static PyObject *
1071 array_append(arrayobject *self, PyObject *v)
1073 return ins(self, (int) Py_Size(self), v);
1076 PyDoc_STRVAR(append_doc,
1077 "append(x)\n\
1079 Append new value x to the end of the array.");
1082 static PyObject *
1083 array_byteswap(arrayobject *self, PyObject *unused)
1085 char *p;
1086 Py_ssize_t i;
1088 switch (self->ob_descr->itemsize) {
1089 case 1:
1090 break;
1091 case 2:
1092 for (p = self->ob_item, i = Py_Size(self); --i >= 0; p += 2) {
1093 char p0 = p[0];
1094 p[0] = p[1];
1095 p[1] = p0;
1097 break;
1098 case 4:
1099 for (p = self->ob_item, i = Py_Size(self); --i >= 0; p += 4) {
1100 char p0 = p[0];
1101 char p1 = p[1];
1102 p[0] = p[3];
1103 p[1] = p[2];
1104 p[2] = p1;
1105 p[3] = p0;
1107 break;
1108 case 8:
1109 for (p = self->ob_item, i = Py_Size(self); --i >= 0; p += 8) {
1110 char p0 = p[0];
1111 char p1 = p[1];
1112 char p2 = p[2];
1113 char p3 = p[3];
1114 p[0] = p[7];
1115 p[1] = p[6];
1116 p[2] = p[5];
1117 p[3] = p[4];
1118 p[4] = p3;
1119 p[5] = p2;
1120 p[6] = p1;
1121 p[7] = p0;
1123 break;
1124 default:
1125 PyErr_SetString(PyExc_RuntimeError,
1126 "don't know how to byteswap this array type");
1127 return NULL;
1129 Py_INCREF(Py_None);
1130 return Py_None;
1133 PyDoc_STRVAR(byteswap_doc,
1134 "byteswap()\n\
1136 Byteswap all items of the array. If the items in the array are not 1, 2,\n\
1137 4, or 8 bytes in size, RuntimeError is raised.");
1139 static PyObject *
1140 array_reduce(arrayobject *array)
1142 PyObject *dict, *result;
1144 dict = PyObject_GetAttrString((PyObject *)array, "__dict__");
1145 if (dict == NULL) {
1146 PyErr_Clear();
1147 dict = Py_None;
1148 Py_INCREF(dict);
1150 if (Py_Size(array) > 0) {
1151 result = Py_BuildValue("O(cs#)O",
1152 Py_Type(array),
1153 array->ob_descr->typecode,
1154 array->ob_item,
1155 Py_Size(array) * array->ob_descr->itemsize,
1156 dict);
1157 } else {
1158 result = Py_BuildValue("O(c)O",
1159 Py_Type(array),
1160 array->ob_descr->typecode,
1161 dict);
1163 Py_DECREF(dict);
1164 return result;
1167 PyDoc_STRVAR(array_doc, "Return state information for pickling.");
1169 static PyObject *
1170 array_reverse(arrayobject *self, PyObject *unused)
1172 register Py_ssize_t itemsize = self->ob_descr->itemsize;
1173 register char *p, *q;
1174 /* little buffer to hold items while swapping */
1175 char tmp[256]; /* 8 is probably enough -- but why skimp */
1176 assert((size_t)itemsize <= sizeof(tmp));
1178 if (Py_Size(self) > 1) {
1179 for (p = self->ob_item,
1180 q = self->ob_item + (Py_Size(self) - 1)*itemsize;
1181 p < q;
1182 p += itemsize, q -= itemsize) {
1183 /* memory areas guaranteed disjoint, so memcpy
1184 * is safe (& memmove may be slower).
1186 memcpy(tmp, p, itemsize);
1187 memcpy(p, q, itemsize);
1188 memcpy(q, tmp, itemsize);
1192 Py_INCREF(Py_None);
1193 return Py_None;
1196 PyDoc_STRVAR(reverse_doc,
1197 "reverse()\n\
1199 Reverse the order of the items in the array.");
1201 static PyObject *
1202 array_fromfile(arrayobject *self, PyObject *args)
1204 PyObject *f;
1205 Py_ssize_t n;
1206 FILE *fp;
1207 if (!PyArg_ParseTuple(args, "On:fromfile", &f, &n))
1208 return NULL;
1209 fp = PyFile_AsFile(f);
1210 if (fp == NULL) {
1211 PyErr_SetString(PyExc_TypeError, "arg1 must be open file");
1212 return NULL;
1214 if (n > 0) {
1215 char *item = self->ob_item;
1216 Py_ssize_t itemsize = self->ob_descr->itemsize;
1217 size_t nread;
1218 Py_ssize_t newlength;
1219 size_t newbytes;
1220 /* Be careful here about overflow */
1221 if ((newlength = Py_Size(self) + n) <= 0 ||
1222 (newbytes = newlength * itemsize) / itemsize !=
1223 (size_t)newlength)
1224 goto nomem;
1225 PyMem_RESIZE(item, char, newbytes);
1226 if (item == NULL) {
1227 nomem:
1228 PyErr_NoMemory();
1229 return NULL;
1231 self->ob_item = item;
1232 Py_Size(self) += n;
1233 self->allocated = Py_Size(self);
1234 nread = fread(item + (Py_Size(self) - n) * itemsize,
1235 itemsize, n, fp);
1236 if (nread < (size_t)n) {
1237 Py_Size(self) -= (n - nread);
1238 PyMem_RESIZE(item, char, Py_Size(self)*itemsize);
1239 self->ob_item = item;
1240 self->allocated = Py_Size(self);
1241 PyErr_SetString(PyExc_EOFError,
1242 "not enough items in file");
1243 return NULL;
1246 Py_INCREF(Py_None);
1247 return Py_None;
1250 PyDoc_STRVAR(fromfile_doc,
1251 "fromfile(f, n)\n\
1253 Read n objects from the file object f and append them to the end of the\n\
1254 array. Also called as read.");
1257 static PyObject *
1258 array_tofile(arrayobject *self, PyObject *f)
1260 FILE *fp;
1262 fp = PyFile_AsFile(f);
1263 if (fp == NULL) {
1264 PyErr_SetString(PyExc_TypeError, "arg must be open file");
1265 return NULL;
1267 if (self->ob_size > 0) {
1268 if (fwrite(self->ob_item, self->ob_descr->itemsize,
1269 self->ob_size, fp) != (size_t)self->ob_size) {
1270 PyErr_SetFromErrno(PyExc_IOError);
1271 clearerr(fp);
1272 return NULL;
1275 Py_INCREF(Py_None);
1276 return Py_None;
1279 PyDoc_STRVAR(tofile_doc,
1280 "tofile(f)\n\
1282 Write all items (as machine values) to the file object f. Also called as\n\
1283 write.");
1286 static PyObject *
1287 array_fromlist(arrayobject *self, PyObject *list)
1289 Py_ssize_t n;
1290 Py_ssize_t itemsize = self->ob_descr->itemsize;
1292 if (!PyList_Check(list)) {
1293 PyErr_SetString(PyExc_TypeError, "arg must be list");
1294 return NULL;
1296 n = PyList_Size(list);
1297 if (n > 0) {
1298 char *item = self->ob_item;
1299 Py_ssize_t i;
1300 PyMem_RESIZE(item, char, (Py_Size(self) + n) * itemsize);
1301 if (item == NULL) {
1302 PyErr_NoMemory();
1303 return NULL;
1305 self->ob_item = item;
1306 Py_Size(self) += n;
1307 self->allocated = Py_Size(self);
1308 for (i = 0; i < n; i++) {
1309 PyObject *v = PyList_GetItem(list, i);
1310 if ((*self->ob_descr->setitem)(self,
1311 Py_Size(self) - n + i, v) != 0) {
1312 Py_Size(self) -= n;
1313 PyMem_RESIZE(item, char,
1314 Py_Size(self) * itemsize);
1315 self->ob_item = item;
1316 self->allocated = Py_Size(self);
1317 return NULL;
1321 Py_INCREF(Py_None);
1322 return Py_None;
1325 PyDoc_STRVAR(fromlist_doc,
1326 "fromlist(list)\n\
1328 Append items to array from list.");
1331 static PyObject *
1332 array_tolist(arrayobject *self, PyObject *unused)
1334 PyObject *list = PyList_New(Py_Size(self));
1335 Py_ssize_t i;
1337 if (list == NULL)
1338 return NULL;
1339 for (i = 0; i < Py_Size(self); i++) {
1340 PyObject *v = getarrayitem((PyObject *)self, i);
1341 if (v == NULL) {
1342 Py_DECREF(list);
1343 return NULL;
1345 PyList_SetItem(list, i, v);
1347 return list;
1350 PyDoc_STRVAR(tolist_doc,
1351 "tolist() -> list\n\
1353 Convert array to an ordinary list with the same items.");
1356 static PyObject *
1357 array_fromstring(arrayobject *self, PyObject *args)
1359 char *str;
1360 Py_ssize_t n;
1361 int itemsize = self->ob_descr->itemsize;
1362 if (!PyArg_ParseTuple(args, "s#:fromstring", &str, &n))
1363 return NULL;
1364 if (n % itemsize != 0) {
1365 PyErr_SetString(PyExc_ValueError,
1366 "string length not a multiple of item size");
1367 return NULL;
1369 n = n / itemsize;
1370 if (n > 0) {
1371 char *item = self->ob_item;
1372 PyMem_RESIZE(item, char, (Py_Size(self) + n) * itemsize);
1373 if (item == NULL) {
1374 PyErr_NoMemory();
1375 return NULL;
1377 self->ob_item = item;
1378 Py_Size(self) += n;
1379 self->allocated = Py_Size(self);
1380 memcpy(item + (Py_Size(self) - n) * itemsize,
1381 str, itemsize*n);
1383 Py_INCREF(Py_None);
1384 return Py_None;
1387 PyDoc_STRVAR(fromstring_doc,
1388 "fromstring(string)\n\
1390 Appends items from the string, interpreting it as an array of machine\n\
1391 values,as if it had been read from a file using the fromfile() method).");
1394 static PyObject *
1395 array_tostring(arrayobject *self, PyObject *unused)
1397 return PyString_FromStringAndSize(self->ob_item,
1398 Py_Size(self) * self->ob_descr->itemsize);
1401 PyDoc_STRVAR(tostring_doc,
1402 "tostring() -> string\n\
1404 Convert the array to an array of machine values and return the string\n\
1405 representation.");
1409 #ifdef Py_USING_UNICODE
1410 static PyObject *
1411 array_fromunicode(arrayobject *self, PyObject *args)
1413 Py_UNICODE *ustr;
1414 Py_ssize_t n;
1416 if (!PyArg_ParseTuple(args, "u#:fromunicode", &ustr, &n))
1417 return NULL;
1418 if (self->ob_descr->typecode != 'u') {
1419 PyErr_SetString(PyExc_ValueError,
1420 "fromunicode() may only be called on "
1421 "type 'u' arrays");
1422 return NULL;
1424 if (n > 0) {
1425 Py_UNICODE *item = (Py_UNICODE *) self->ob_item;
1426 PyMem_RESIZE(item, Py_UNICODE, Py_Size(self) + n);
1427 if (item == NULL) {
1428 PyErr_NoMemory();
1429 return NULL;
1431 self->ob_item = (char *) item;
1432 Py_Size(self) += n;
1433 self->allocated = Py_Size(self);
1434 memcpy(item + Py_Size(self) - n,
1435 ustr, n * sizeof(Py_UNICODE));
1438 Py_INCREF(Py_None);
1439 return Py_None;
1442 PyDoc_STRVAR(fromunicode_doc,
1443 "fromunicode(ustr)\n\
1445 Extends this array with data from the unicode string ustr.\n\
1446 The array must be a type 'u' array; otherwise a ValueError\n\
1447 is raised. Use array.fromstring(ustr.decode(...)) to\n\
1448 append Unicode data to an array of some other type.");
1451 static PyObject *
1452 array_tounicode(arrayobject *self, PyObject *unused)
1454 if (self->ob_descr->typecode != 'u') {
1455 PyErr_SetString(PyExc_ValueError,
1456 "tounicode() may only be called on type 'u' arrays");
1457 return NULL;
1459 return PyUnicode_FromUnicode((Py_UNICODE *) self->ob_item, Py_Size(self));
1462 PyDoc_STRVAR(tounicode_doc,
1463 "tounicode() -> unicode\n\
1465 Convert the array to a unicode string. The array must be\n\
1466 a type 'u' array; otherwise a ValueError is raised. Use\n\
1467 array.tostring().decode() to obtain a unicode string from\n\
1468 an array of some other type.");
1470 #endif /* Py_USING_UNICODE */
1473 static PyObject *
1474 array_get_typecode(arrayobject *a, void *closure)
1476 char tc = a->ob_descr->typecode;
1477 return PyString_FromStringAndSize(&tc, 1);
1480 static PyObject *
1481 array_get_itemsize(arrayobject *a, void *closure)
1483 return PyInt_FromLong((long)a->ob_descr->itemsize);
1486 static PyGetSetDef array_getsets [] = {
1487 {"typecode", (getter) array_get_typecode, NULL,
1488 "the typecode character used to create the array"},
1489 {"itemsize", (getter) array_get_itemsize, NULL,
1490 "the size, in bytes, of one array item"},
1491 {NULL}
1494 PyMethodDef array_methods[] = {
1495 {"append", (PyCFunction)array_append, METH_O,
1496 append_doc},
1497 {"buffer_info", (PyCFunction)array_buffer_info, METH_NOARGS,
1498 buffer_info_doc},
1499 {"byteswap", (PyCFunction)array_byteswap, METH_NOARGS,
1500 byteswap_doc},
1501 {"__copy__", (PyCFunction)array_copy, METH_NOARGS,
1502 copy_doc},
1503 {"count", (PyCFunction)array_count, METH_O,
1504 count_doc},
1505 {"__deepcopy__",(PyCFunction)array_copy, METH_O,
1506 copy_doc},
1507 {"extend", (PyCFunction)array_extend, METH_O,
1508 extend_doc},
1509 {"fromfile", (PyCFunction)array_fromfile, METH_VARARGS,
1510 fromfile_doc},
1511 {"fromlist", (PyCFunction)array_fromlist, METH_O,
1512 fromlist_doc},
1513 {"fromstring", (PyCFunction)array_fromstring, METH_VARARGS,
1514 fromstring_doc},
1515 #ifdef Py_USING_UNICODE
1516 {"fromunicode", (PyCFunction)array_fromunicode, METH_VARARGS,
1517 fromunicode_doc},
1518 #endif
1519 {"index", (PyCFunction)array_index, METH_O,
1520 index_doc},
1521 {"insert", (PyCFunction)array_insert, METH_VARARGS,
1522 insert_doc},
1523 {"pop", (PyCFunction)array_pop, METH_VARARGS,
1524 pop_doc},
1525 {"read", (PyCFunction)array_fromfile, METH_VARARGS,
1526 fromfile_doc},
1527 {"__reduce__", (PyCFunction)array_reduce, METH_NOARGS,
1528 array_doc},
1529 {"remove", (PyCFunction)array_remove, METH_O,
1530 remove_doc},
1531 {"reverse", (PyCFunction)array_reverse, METH_NOARGS,
1532 reverse_doc},
1533 /* {"sort", (PyCFunction)array_sort, METH_VARARGS,
1534 sort_doc},*/
1535 {"tofile", (PyCFunction)array_tofile, METH_O,
1536 tofile_doc},
1537 {"tolist", (PyCFunction)array_tolist, METH_NOARGS,
1538 tolist_doc},
1539 {"tostring", (PyCFunction)array_tostring, METH_NOARGS,
1540 tostring_doc},
1541 #ifdef Py_USING_UNICODE
1542 {"tounicode", (PyCFunction)array_tounicode, METH_NOARGS,
1543 tounicode_doc},
1544 #endif
1545 {"write", (PyCFunction)array_tofile, METH_O,
1546 tofile_doc},
1547 {NULL, NULL} /* sentinel */
1550 static PyObject *
1551 array_repr(arrayobject *a)
1553 char buf[256], typecode;
1554 PyObject *s, *t, *v = NULL;
1555 Py_ssize_t len;
1557 len = Py_Size(a);
1558 typecode = a->ob_descr->typecode;
1559 if (len == 0) {
1560 PyOS_snprintf(buf, sizeof(buf), "array('%c')", typecode);
1561 return PyString_FromString(buf);
1564 if (typecode == 'c')
1565 v = array_tostring(a, NULL);
1566 #ifdef Py_USING_UNICODE
1567 else if (typecode == 'u')
1568 v = array_tounicode(a, NULL);
1569 #endif
1570 else
1571 v = array_tolist(a, NULL);
1572 t = PyObject_Repr(v);
1573 Py_XDECREF(v);
1575 PyOS_snprintf(buf, sizeof(buf), "array('%c', ", typecode);
1576 s = PyString_FromString(buf);
1577 PyString_ConcatAndDel(&s, t);
1578 PyString_ConcatAndDel(&s, PyString_FromString(")"));
1579 return s;
1582 static PyObject*
1583 array_subscr(arrayobject* self, PyObject* item)
1585 if (PyIndex_Check(item)) {
1586 Py_ssize_t i = PyNumber_AsSsize_t(item, PyExc_IndexError);
1587 if (i==-1 && PyErr_Occurred()) {
1588 return NULL;
1590 if (i < 0)
1591 i += Py_Size(self);
1592 return array_item(self, i);
1594 else if (PySlice_Check(item)) {
1595 Py_ssize_t start, stop, step, slicelength, cur, i;
1596 PyObject* result;
1597 arrayobject* ar;
1598 int itemsize = self->ob_descr->itemsize;
1600 if (PySlice_GetIndicesEx((PySliceObject*)item, Py_Size(self),
1601 &start, &stop, &step, &slicelength) < 0) {
1602 return NULL;
1605 if (slicelength <= 0) {
1606 return newarrayobject(&Arraytype, 0, self->ob_descr);
1608 else if (step == 1) {
1609 PyObject *result = newarrayobject(&Arraytype,
1610 slicelength, self->ob_descr);
1611 if (result == NULL)
1612 return NULL;
1613 memcpy(((arrayobject *)result)->ob_item,
1614 self->ob_item + start * itemsize,
1615 slicelength * itemsize);
1616 return result;
1618 else {
1619 result = newarrayobject(&Arraytype, slicelength, self->ob_descr);
1620 if (!result) return NULL;
1622 ar = (arrayobject*)result;
1624 for (cur = start, i = 0; i < slicelength;
1625 cur += step, i++) {
1626 memcpy(ar->ob_item + i*itemsize,
1627 self->ob_item + cur*itemsize,
1628 itemsize);
1631 return result;
1634 else {
1635 PyErr_SetString(PyExc_TypeError,
1636 "array indices must be integers");
1637 return NULL;
1641 static int
1642 array_ass_subscr(arrayobject* self, PyObject* item, PyObject* value)
1644 Py_ssize_t start, stop, step, slicelength, needed;
1645 arrayobject* other;
1646 int itemsize;
1648 if (PyIndex_Check(item)) {
1649 Py_ssize_t i = PyNumber_AsSsize_t(item, PyExc_IndexError);
1651 if (i == -1 && PyErr_Occurred())
1652 return -1;
1653 if (i < 0)
1654 i += Py_Size(self);
1655 if (i < 0 || i >= Py_Size(self)) {
1656 PyErr_SetString(PyExc_IndexError,
1657 "array assignment index out of range");
1658 return -1;
1660 if (value == NULL) {
1661 /* Fall through to slice assignment */
1662 start = i;
1663 stop = i + 1;
1664 step = 1;
1665 slicelength = 1;
1667 else
1668 return (*self->ob_descr->setitem)(self, i, value);
1670 else if (PySlice_Check(item)) {
1671 if (PySlice_GetIndicesEx((PySliceObject *)item,
1672 Py_Size(self), &start, &stop,
1673 &step, &slicelength) < 0) {
1674 return -1;
1677 else {
1678 PyErr_SetString(PyExc_TypeError,
1679 "array indices must be integer");
1680 return -1;
1682 if (value == NULL) {
1683 other = NULL;
1684 needed = 0;
1686 else if (array_Check(value)) {
1687 other = (arrayobject *)value;
1688 needed = Py_Size(other);
1689 if (self == other) {
1690 /* Special case "self[i:j] = self" -- copy self first */
1691 int ret;
1692 value = array_slice(other, 0, needed);
1693 if (value == NULL)
1694 return -1;
1695 ret = array_ass_subscr(self, item, value);
1696 Py_DECREF(value);
1697 return ret;
1699 if (other->ob_descr != self->ob_descr) {
1700 PyErr_BadArgument();
1701 return -1;
1704 else {
1705 PyErr_Format(PyExc_TypeError,
1706 "can only assign array (not \"%.200s\") to array slice",
1707 Py_Type(value)->tp_name);
1708 return -1;
1710 itemsize = self->ob_descr->itemsize;
1711 /* for 'a[2:1] = ...', the insertion point is 'start', not 'stop' */
1712 if ((step > 0 && stop < start) ||
1713 (step < 0 && stop > start))
1714 stop = start;
1715 if (step == 1) {
1716 if (slicelength > needed) {
1717 memmove(self->ob_item + (start + needed) * itemsize,
1718 self->ob_item + stop * itemsize,
1719 (Py_Size(self) - stop) * itemsize);
1720 if (array_resize(self, Py_Size(self) +
1721 needed - slicelength) < 0)
1722 return -1;
1724 else if (slicelength < needed) {
1725 if (array_resize(self, Py_Size(self) +
1726 needed - slicelength) < 0)
1727 return -1;
1728 memmove(self->ob_item + (start + needed) * itemsize,
1729 self->ob_item + stop * itemsize,
1730 (Py_Size(self) - start - needed) * itemsize);
1732 if (needed > 0)
1733 memcpy(self->ob_item + start * itemsize,
1734 other->ob_item, needed * itemsize);
1735 return 0;
1737 else if (needed == 0) {
1738 /* Delete slice */
1739 Py_ssize_t cur, i;
1741 if (step < 0) {
1742 stop = start + 1;
1743 start = stop + step * (slicelength - 1) - 1;
1744 step = -step;
1746 for (cur = start, i = 0; i < slicelength;
1747 cur += step, i++) {
1748 Py_ssize_t lim = step - 1;
1750 if (cur + step >= Py_Size(self))
1751 lim = Py_Size(self) - cur - 1;
1752 memmove(self->ob_item + (cur - i) * itemsize,
1753 self->ob_item + (cur + 1) * itemsize,
1754 lim * itemsize);
1756 cur = start + slicelength * step;
1757 if (cur < Py_Size(self)) {
1758 memmove(self->ob_item + (cur-slicelength) * itemsize,
1759 self->ob_item + cur * itemsize,
1760 (Py_Size(self) - cur) * itemsize);
1762 if (array_resize(self, Py_Size(self) - slicelength) < 0)
1763 return -1;
1764 return 0;
1766 else {
1767 Py_ssize_t cur, i;
1769 if (needed != slicelength) {
1770 PyErr_Format(PyExc_ValueError,
1771 "attempt to assign array of size %zd "
1772 "to extended slice of size %zd",
1773 needed, slicelength);
1774 return -1;
1776 for (cur = start, i = 0; i < slicelength;
1777 cur += step, i++) {
1778 memcpy(self->ob_item + cur * itemsize,
1779 other->ob_item + i * itemsize,
1780 itemsize);
1782 return 0;
1786 static PyMappingMethods array_as_mapping = {
1787 (lenfunc)array_length,
1788 (binaryfunc)array_subscr,
1789 (objobjargproc)array_ass_subscr
1792 static const void *emptybuf = "";
1794 static Py_ssize_t
1795 array_buffer_getreadbuf(arrayobject *self, Py_ssize_t index, const void **ptr)
1797 if ( index != 0 ) {
1798 PyErr_SetString(PyExc_SystemError,
1799 "Accessing non-existent array segment");
1800 return -1;
1802 *ptr = (void *)self->ob_item;
1803 if (*ptr == NULL)
1804 *ptr = emptybuf;
1805 return Py_Size(self)*self->ob_descr->itemsize;
1808 static Py_ssize_t
1809 array_buffer_getwritebuf(arrayobject *self, Py_ssize_t index, const void **ptr)
1811 if ( index != 0 ) {
1812 PyErr_SetString(PyExc_SystemError,
1813 "Accessing non-existent array segment");
1814 return -1;
1816 *ptr = (void *)self->ob_item;
1817 if (*ptr == NULL)
1818 *ptr = emptybuf;
1819 return Py_Size(self)*self->ob_descr->itemsize;
1822 static Py_ssize_t
1823 array_buffer_getsegcount(arrayobject *self, Py_ssize_t *lenp)
1825 if ( lenp )
1826 *lenp = Py_Size(self)*self->ob_descr->itemsize;
1827 return 1;
1830 static PySequenceMethods array_as_sequence = {
1831 (lenfunc)array_length, /*sq_length*/
1832 (binaryfunc)array_concat, /*sq_concat*/
1833 (ssizeargfunc)array_repeat, /*sq_repeat*/
1834 (ssizeargfunc)array_item, /*sq_item*/
1835 (ssizessizeargfunc)array_slice, /*sq_slice*/
1836 (ssizeobjargproc)array_ass_item, /*sq_ass_item*/
1837 (ssizessizeobjargproc)array_ass_slice, /*sq_ass_slice*/
1838 (objobjproc)array_contains, /*sq_contains*/
1839 (binaryfunc)array_inplace_concat, /*sq_inplace_concat*/
1840 (ssizeargfunc)array_inplace_repeat /*sq_inplace_repeat*/
1843 static PyBufferProcs array_as_buffer = {
1844 (readbufferproc)array_buffer_getreadbuf,
1845 (writebufferproc)array_buffer_getwritebuf,
1846 (segcountproc)array_buffer_getsegcount,
1847 NULL,
1850 static PyObject *
1851 array_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1853 char c;
1854 PyObject *initial = NULL, *it = NULL;
1855 struct arraydescr *descr;
1857 if (type == &Arraytype && !_PyArg_NoKeywords("array.array()", kwds))
1858 return NULL;
1860 if (!PyArg_ParseTuple(args, "c|O:array", &c, &initial))
1861 return NULL;
1863 if (!(initial == NULL || PyList_Check(initial)
1864 || PyString_Check(initial) || PyTuple_Check(initial)
1865 || (c == 'u' && PyUnicode_Check(initial)))) {
1866 it = PyObject_GetIter(initial);
1867 if (it == NULL)
1868 return NULL;
1869 /* We set initial to NULL so that the subsequent code
1870 will create an empty array of the appropriate type
1871 and afterwards we can use array_iter_extend to populate
1872 the array.
1874 initial = NULL;
1876 for (descr = descriptors; descr->typecode != '\0'; descr++) {
1877 if (descr->typecode == c) {
1878 PyObject *a;
1879 Py_ssize_t len;
1881 if (initial == NULL || !(PyList_Check(initial)
1882 || PyTuple_Check(initial)))
1883 len = 0;
1884 else
1885 len = PySequence_Size(initial);
1887 a = newarrayobject(type, len, descr);
1888 if (a == NULL)
1889 return NULL;
1891 if (len > 0) {
1892 Py_ssize_t i;
1893 for (i = 0; i < len; i++) {
1894 PyObject *v =
1895 PySequence_GetItem(initial, i);
1896 if (v == NULL) {
1897 Py_DECREF(a);
1898 return NULL;
1900 if (setarrayitem(a, i, v) != 0) {
1901 Py_DECREF(v);
1902 Py_DECREF(a);
1903 return NULL;
1905 Py_DECREF(v);
1907 } else if (initial != NULL && PyString_Check(initial)) {
1908 PyObject *t_initial, *v;
1909 t_initial = PyTuple_Pack(1, initial);
1910 if (t_initial == NULL) {
1911 Py_DECREF(a);
1912 return NULL;
1914 v = array_fromstring((arrayobject *)a,
1915 t_initial);
1916 Py_DECREF(t_initial);
1917 if (v == NULL) {
1918 Py_DECREF(a);
1919 return NULL;
1921 Py_DECREF(v);
1922 #ifdef Py_USING_UNICODE
1923 } else if (initial != NULL && PyUnicode_Check(initial)) {
1924 Py_ssize_t n = PyUnicode_GET_DATA_SIZE(initial);
1925 if (n > 0) {
1926 arrayobject *self = (arrayobject *)a;
1927 char *item = self->ob_item;
1928 item = (char *)PyMem_Realloc(item, n);
1929 if (item == NULL) {
1930 PyErr_NoMemory();
1931 Py_DECREF(a);
1932 return NULL;
1934 self->ob_item = item;
1935 Py_Size(self) = n / sizeof(Py_UNICODE);
1936 memcpy(item, PyUnicode_AS_DATA(initial), n);
1937 self->allocated = Py_Size(self);
1939 #endif
1941 if (it != NULL) {
1942 if (array_iter_extend((arrayobject *)a, it) == -1) {
1943 Py_DECREF(it);
1944 Py_DECREF(a);
1945 return NULL;
1947 Py_DECREF(it);
1949 return a;
1952 PyErr_SetString(PyExc_ValueError,
1953 "bad typecode (must be c, b, B, u, h, H, i, I, l, L, f or d)");
1954 return NULL;
1958 PyDoc_STRVAR(module_doc,
1959 "This module defines an object type which can efficiently represent\n\
1960 an array of basic values: characters, integers, floating point\n\
1961 numbers. Arrays are sequence types and behave very much like lists,\n\
1962 except that the type of objects stored in them is constrained. The\n\
1963 type is specified at object creation time by using a type code, which\n\
1964 is a single character. The following type codes are defined:\n\
1966 Type code C Type Minimum size in bytes \n\
1967 'c' character 1 \n\
1968 'b' signed integer 1 \n\
1969 'B' unsigned integer 1 \n\
1970 'u' Unicode character 2 \n\
1971 'h' signed integer 2 \n\
1972 'H' unsigned integer 2 \n\
1973 'i' signed integer 2 \n\
1974 'I' unsigned integer 2 \n\
1975 'l' signed integer 4 \n\
1976 'L' unsigned integer 4 \n\
1977 'f' floating point 4 \n\
1978 'd' floating point 8 \n\
1980 The constructor is:\n\
1982 array(typecode [, initializer]) -- create a new array\n\
1985 PyDoc_STRVAR(arraytype_doc,
1986 "array(typecode [, initializer]) -> array\n\
1988 Return a new array whose items are restricted by typecode, and\n\
1989 initialized from the optional initializer value, which must be a list,\n\
1990 string. or iterable over elements of the appropriate type.\n\
1992 Arrays represent basic values and behave very much like lists, except\n\
1993 the type of objects stored in them is constrained.\n\
1995 Methods:\n\
1997 append() -- append a new item to the end of the array\n\
1998 buffer_info() -- return information giving the current memory info\n\
1999 byteswap() -- byteswap all the items of the array\n\
2000 count() -- return number of occurences of an object\n\
2001 extend() -- extend array by appending multiple elements from an iterable\n\
2002 fromfile() -- read items from a file object\n\
2003 fromlist() -- append items from the list\n\
2004 fromstring() -- append items from the string\n\
2005 index() -- return index of first occurence of an object\n\
2006 insert() -- insert a new item into the array at a provided position\n\
2007 pop() -- remove and return item (default last)\n\
2008 read() -- DEPRECATED, use fromfile()\n\
2009 remove() -- remove first occurence of an object\n\
2010 reverse() -- reverse the order of the items in the array\n\
2011 tofile() -- write all items to a file object\n\
2012 tolist() -- return the array converted to an ordinary list\n\
2013 tostring() -- return the array converted to a string\n\
2014 write() -- DEPRECATED, use tofile()\n\
2016 Attributes:\n\
2018 typecode -- the typecode character used to create the array\n\
2019 itemsize -- the length in bytes of one array item\n\
2022 static PyObject *array_iter(arrayobject *ao);
2024 static PyTypeObject Arraytype = {
2025 PyVarObject_HEAD_INIT(NULL, 0)
2026 "array.array",
2027 sizeof(arrayobject),
2029 (destructor)array_dealloc, /* tp_dealloc */
2030 0, /* tp_print */
2031 0, /* tp_getattr */
2032 0, /* tp_setattr */
2033 0, /* tp_compare */
2034 (reprfunc)array_repr, /* tp_repr */
2035 0, /* tp_as_number*/
2036 &array_as_sequence, /* tp_as_sequence*/
2037 &array_as_mapping, /* tp_as_mapping*/
2038 0, /* tp_hash */
2039 0, /* tp_call */
2040 0, /* tp_str */
2041 PyObject_GenericGetAttr, /* tp_getattro */
2042 0, /* tp_setattro */
2043 &array_as_buffer, /* tp_as_buffer*/
2044 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_WEAKREFS, /* tp_flags */
2045 arraytype_doc, /* tp_doc */
2046 0, /* tp_traverse */
2047 0, /* tp_clear */
2048 array_richcompare, /* tp_richcompare */
2049 offsetof(arrayobject, weakreflist), /* tp_weaklistoffset */
2050 (getiterfunc)array_iter, /* tp_iter */
2051 0, /* tp_iternext */
2052 array_methods, /* tp_methods */
2053 0, /* tp_members */
2054 array_getsets, /* tp_getset */
2055 0, /* tp_base */
2056 0, /* tp_dict */
2057 0, /* tp_descr_get */
2058 0, /* tp_descr_set */
2059 0, /* tp_dictoffset */
2060 0, /* tp_init */
2061 PyType_GenericAlloc, /* tp_alloc */
2062 array_new, /* tp_new */
2063 PyObject_Del, /* tp_free */
2067 /*********************** Array Iterator **************************/
2069 typedef struct {
2070 PyObject_HEAD
2071 Py_ssize_t index;
2072 arrayobject *ao;
2073 PyObject * (*getitem)(struct arrayobject *, Py_ssize_t);
2074 } arrayiterobject;
2076 static PyTypeObject PyArrayIter_Type;
2078 #define PyArrayIter_Check(op) PyObject_TypeCheck(op, &PyArrayIter_Type)
2080 static PyObject *
2081 array_iter(arrayobject *ao)
2083 arrayiterobject *it;
2085 if (!array_Check(ao)) {
2086 PyErr_BadInternalCall();
2087 return NULL;
2090 it = PyObject_GC_New(arrayiterobject, &PyArrayIter_Type);
2091 if (it == NULL)
2092 return NULL;
2094 Py_INCREF(ao);
2095 it->ao = ao;
2096 it->index = 0;
2097 it->getitem = ao->ob_descr->getitem;
2098 PyObject_GC_Track(it);
2099 return (PyObject *)it;
2102 static PyObject *
2103 arrayiter_next(arrayiterobject *it)
2105 assert(PyArrayIter_Check(it));
2106 if (it->index < Py_Size(it->ao))
2107 return (*it->getitem)(it->ao, it->index++);
2108 return NULL;
2111 static void
2112 arrayiter_dealloc(arrayiterobject *it)
2114 PyObject_GC_UnTrack(it);
2115 Py_XDECREF(it->ao);
2116 PyObject_GC_Del(it);
2119 static int
2120 arrayiter_traverse(arrayiterobject *it, visitproc visit, void *arg)
2122 Py_VISIT(it->ao);
2123 return 0;
2126 static PyTypeObject PyArrayIter_Type = {
2127 PyVarObject_HEAD_INIT(NULL, 0)
2128 "arrayiterator", /* tp_name */
2129 sizeof(arrayiterobject), /* tp_basicsize */
2130 0, /* tp_itemsize */
2131 /* methods */
2132 (destructor)arrayiter_dealloc, /* tp_dealloc */
2133 0, /* tp_print */
2134 0, /* tp_getattr */
2135 0, /* tp_setattr */
2136 0, /* tp_compare */
2137 0, /* tp_repr */
2138 0, /* tp_as_number */
2139 0, /* tp_as_sequence */
2140 0, /* tp_as_mapping */
2141 0, /* tp_hash */
2142 0, /* tp_call */
2143 0, /* tp_str */
2144 PyObject_GenericGetAttr, /* tp_getattro */
2145 0, /* tp_setattro */
2146 0, /* tp_as_buffer */
2147 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
2148 0, /* tp_doc */
2149 (traverseproc)arrayiter_traverse, /* tp_traverse */
2150 0, /* tp_clear */
2151 0, /* tp_richcompare */
2152 0, /* tp_weaklistoffset */
2153 PyObject_SelfIter, /* tp_iter */
2154 (iternextfunc)arrayiter_next, /* tp_iternext */
2155 0, /* tp_methods */
2159 /*********************** Install Module **************************/
2161 /* No functions in array module. */
2162 static PyMethodDef a_methods[] = {
2163 {NULL, NULL, 0, NULL} /* Sentinel */
2167 PyMODINIT_FUNC
2168 initarray(void)
2170 PyObject *m;
2172 Arraytype.ob_type = &PyType_Type;
2173 PyArrayIter_Type.ob_type = &PyType_Type;
2174 m = Py_InitModule3("array", a_methods, module_doc);
2175 if (m == NULL)
2176 return;
2178 Py_INCREF((PyObject *)&Arraytype);
2179 PyModule_AddObject(m, "ArrayType", (PyObject *)&Arraytype);
2180 Py_INCREF((PyObject *)&Arraytype);
2181 PyModule_AddObject(m, "array", (PyObject *)&Arraytype);
2182 /* No need to check the error here, the caller will do that */