blob: b571fe8254c9f7e1f90522b6908846d60ef1d709 [file] [log] [blame]
Guido van Rossum778983b1993-02-19 15:55:02 +00001/* Array object implementation */
2
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 */
5
Martin v. Löwis18e16552006-02-15 17:27:45 +00006#define PY_SSIZE_T_CLEAN
Roger E. Masse2919eaa1996-12-09 20:10:36 +00007#include "Python.h"
Raymond Hettingercb87bc82004-05-31 00:35:52 +00008#include "structmember.h"
Roger E. Masse5817f8f1996-12-09 22:24:19 +00009
Guido van Rossum0c709541994-08-19 12:01:32 +000010#ifdef STDC_HEADERS
11#include <stddef.h>
Guido van Rossum7f1de831999-08-27 20:33:52 +000012#else /* !STDC_HEADERS */
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +000013#ifdef HAVE_SYS_TYPES_H
Antoine Pitrouc7c96a92010-05-09 15:15:40 +000014#include <sys/types.h> /* For size_t */
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +000015#endif /* HAVE_SYS_TYPES_H */
Guido van Rossum7f1de831999-08-27 20:33:52 +000016#endif /* !STDC_HEADERS */
Guido van Rossum778983b1993-02-19 15:55:02 +000017
18struct arrayobject; /* Forward */
19
Tim Petersbb307342000-09-10 05:22:54 +000020/* 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.
23 */
Guido van Rossum778983b1993-02-19 15:55:02 +000024struct arraydescr {
Antoine Pitrouc7c96a92010-05-09 15:15:40 +000025 int typecode;
26 int itemsize;
27 PyObject * (*getitem)(struct arrayobject *, Py_ssize_t);
28 int (*setitem)(struct arrayobject *, Py_ssize_t, PyObject *);
Guido van Rossum778983b1993-02-19 15:55:02 +000029};
30
31typedef struct arrayobject {
Antoine Pitrouc7c96a92010-05-09 15:15:40 +000032 PyObject_VAR_HEAD
33 char *ob_item;
34 Py_ssize_t allocated;
35 struct arraydescr *ob_descr;
36 PyObject *weakreflist; /* List of weak references */
Guido van Rossum778983b1993-02-19 15:55:02 +000037} arrayobject;
38
Jeremy Hylton938ace62002-07-17 16:30:39 +000039static PyTypeObject Arraytype;
Guido van Rossum778983b1993-02-19 15:55:02 +000040
Martin v. Löwis99866332002-03-01 10:27:01 +000041#define array_Check(op) PyObject_TypeCheck(op, &Arraytype)
Christian Heimese93237d2007-12-19 02:37:44 +000042#define array_CheckExact(op) (Py_TYPE(op) == &Arraytype)
Guido van Rossum778983b1993-02-19 15:55:02 +000043
Raymond Hettinger6e2ee862004-03-14 04:37:50 +000044static int
Martin v. Löwis18e16552006-02-15 17:27:45 +000045array_resize(arrayobject *self, Py_ssize_t newsize)
Raymond Hettinger6e2ee862004-03-14 04:37:50 +000046{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +000047 char *items;
48 size_t _new_size;
Raymond Hettinger6e2ee862004-03-14 04:37:50 +000049
Antoine Pitrouc7c96a92010-05-09 15:15:40 +000050 /* 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.
53 */
Raymond Hettinger6e2ee862004-03-14 04:37:50 +000054
Antoine Pitrouc7c96a92010-05-09 15:15:40 +000055 if (self->allocated >= newsize &&
56 Py_SIZE(self) < newsize + 16 &&
57 self->ob_item != NULL) {
58 Py_SIZE(self) = newsize;
59 return 0;
60 }
Raymond Hettinger6e2ee862004-03-14 04:37:50 +000061
Antoine Pitrouc7c96a92010-05-09 15:15:40 +000062 /* 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.
72 */
Raymond Hettinger6e2ee862004-03-14 04:37:50 +000073
Antoine Pitrouc7c96a92010-05-09 15:15:40 +000074 _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;
85 }
86 self->ob_item = items;
87 Py_SIZE(self) = newsize;
88 self->allocated = _new_size;
89 return 0;
Raymond Hettinger6e2ee862004-03-14 04:37:50 +000090}
91
Tim Petersbb307342000-09-10 05:22:54 +000092/****************************************************************************
93Get and Set functions for each type.
94A Get function takes an arrayobject* and an integer index, returning the
95array value at that index wrapped in an appropriate PyObject*.
96A Set function takes an arrayobject, integer index, and PyObject*; sets
97the array value at that index to the raw C data extracted from the PyObject*,
98and returns 0 if successful, else nonzero on failure (PyObject* not of an
99appropriate type or value).
100Note that the basic Get and Set functions do NOT check that the index is
101in bounds; that's the responsibility of the caller.
102****************************************************************************/
Guido van Rossum778983b1993-02-19 15:55:02 +0000103
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000104static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000105c_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum778983b1993-02-19 15:55:02 +0000106{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000107 return PyString_FromStringAndSize(&((char *)ap->ob_item)[i], 1);
Guido van Rossum778983b1993-02-19 15:55:02 +0000108}
109
110static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000111c_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000112{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000113 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;
Guido van Rossum778983b1993-02-19 15:55:02 +0000119}
120
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000121static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000122b_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum778983b1993-02-19 15:55:02 +0000123{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000124 long x = ((char *)ap->ob_item)[i];
125 if (x >= 128)
126 x -= 256;
127 return PyInt_FromLong(x);
Guido van Rossum778983b1993-02-19 15:55:02 +0000128}
129
130static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000131b_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000132{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000133 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;
143 }
144 else if (x > 127) {
145 PyErr_SetString(PyExc_OverflowError,
146 "signed char is greater than maximum");
147 return -1;
148 }
149 if (i >= 0)
150 ((char *)ap->ob_item)[i] = (char)x;
151 return 0;
Guido van Rossum778983b1993-02-19 15:55:02 +0000152}
153
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000154static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000155BB_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum549ab711997-01-03 19:09:47 +0000156{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000157 long x = ((unsigned char *)ap->ob_item)[i];
158 return PyInt_FromLong(x);
Guido van Rossum549ab711997-01-03 19:09:47 +0000159}
160
Fred Drake541dc3b2000-06-28 17:49:30 +0000161static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000162BB_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Fred Drake541dc3b2000-06-28 17:49:30 +0000163{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000164 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;
Fred Drake541dc3b2000-06-28 17:49:30 +0000171}
Guido van Rossum549ab711997-01-03 19:09:47 +0000172
Martin v. Löwis99866332002-03-01 10:27:01 +0000173#ifdef Py_USING_UNICODE
174static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000175u_getitem(arrayobject *ap, Py_ssize_t i)
Martin v. Löwis99866332002-03-01 10:27:01 +0000176{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000177 return PyUnicode_FromUnicode(&((Py_UNICODE *) ap->ob_item)[i], 1);
Martin v. Löwis99866332002-03-01 10:27:01 +0000178}
179
180static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000181u_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Martin v. Löwis99866332002-03-01 10:27:01 +0000182{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000183 Py_UNICODE *p;
184 Py_ssize_t len;
Martin v. Löwis99866332002-03-01 10:27:01 +0000185
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000186 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;
192 }
193 if (i >= 0)
194 ((Py_UNICODE *)ap->ob_item)[i] = p[0];
195 return 0;
Martin v. Löwis99866332002-03-01 10:27:01 +0000196}
197#endif
198
Guido van Rossum549ab711997-01-03 19:09:47 +0000199static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000200h_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum778983b1993-02-19 15:55:02 +0000201{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000202 return PyInt_FromLong((long) ((short *)ap->ob_item)[i]);
Guido van Rossum778983b1993-02-19 15:55:02 +0000203}
204
205static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000206h_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000207{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000208 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;
Guido van Rossum778983b1993-02-19 15:55:02 +0000215}
216
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000217static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000218HH_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum549ab711997-01-03 19:09:47 +0000219{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000220 return PyInt_FromLong((long) ((unsigned short *)ap->ob_item)[i]);
Guido van Rossum549ab711997-01-03 19:09:47 +0000221}
222
Fred Drake541dc3b2000-06-28 17:49:30 +0000223static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000224HH_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Fred Drake541dc3b2000-06-28 17:49:30 +0000225{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000226 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;
235 }
236 else if (x > USHRT_MAX) {
237 PyErr_SetString(PyExc_OverflowError,
238 "unsigned short is greater than maximum");
239 return -1;
240 }
241 if (i >= 0)
242 ((short *)ap->ob_item)[i] = (short)x;
243 return 0;
Fred Drake541dc3b2000-06-28 17:49:30 +0000244}
Guido van Rossum549ab711997-01-03 19:09:47 +0000245
246static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000247i_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossume77a7571993-11-03 15:01:26 +0000248{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000249 return PyInt_FromLong((long) ((int *)ap->ob_item)[i]);
Guido van Rossume77a7571993-11-03 15:01:26 +0000250}
251
252static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000253i_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Guido van Rossume77a7571993-11-03 15:01:26 +0000254{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000255 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;
Guido van Rossume77a7571993-11-03 15:01:26 +0000262}
263
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000264static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000265II_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum549ab711997-01-03 19:09:47 +0000266{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000267 return PyLong_FromUnsignedLong(
268 (unsigned long) ((unsigned int *)ap->ob_item)[i]);
Guido van Rossum549ab711997-01-03 19:09:47 +0000269}
270
271static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000272II_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Guido van Rossum549ab711997-01-03 19:09:47 +0000273{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000274 unsigned long x;
275 if (PyLong_Check(v)) {
276 x = PyLong_AsUnsignedLong(v);
277 if (x == (unsigned long) -1 && PyErr_Occurred())
278 return -1;
279 }
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;
288 }
289 x = (unsigned long)y;
Tim Petersbb307342000-09-10 05:22:54 +0000290
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000291 }
292 if (x > UINT_MAX) {
293 PyErr_SetString(PyExc_OverflowError,
294 "unsigned int is greater than maximum");
295 return -1;
296 }
Fred Drake541dc3b2000-06-28 17:49:30 +0000297
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000298 if (i >= 0)
299 ((unsigned int *)ap->ob_item)[i] = (unsigned int)x;
300 return 0;
Guido van Rossum549ab711997-01-03 19:09:47 +0000301}
302
303static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000304l_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum778983b1993-02-19 15:55:02 +0000305{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000306 return PyInt_FromLong(((long *)ap->ob_item)[i]);
Guido van Rossum778983b1993-02-19 15:55:02 +0000307}
308
309static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000310l_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000311{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000312 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;
Guido van Rossum778983b1993-02-19 15:55:02 +0000318}
319
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000320static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000321LL_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum549ab711997-01-03 19:09:47 +0000322{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000323 return PyLong_FromUnsignedLong(((unsigned long *)ap->ob_item)[i]);
Guido van Rossum549ab711997-01-03 19:09:47 +0000324}
325
326static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000327LL_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Guido van Rossum549ab711997-01-03 19:09:47 +0000328{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000329 unsigned long x;
330 if (PyLong_Check(v)) {
331 x = PyLong_AsUnsignedLong(v);
332 if (x == (unsigned long) -1 && PyErr_Occurred())
333 return -1;
334 }
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;
343 }
344 x = (unsigned long)y;
Tim Petersbb307342000-09-10 05:22:54 +0000345
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000346 }
347 if (x > ULONG_MAX) {
348 PyErr_SetString(PyExc_OverflowError,
349 "unsigned long is greater than maximum");
350 return -1;
351 }
Tim Petersbb307342000-09-10 05:22:54 +0000352
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000353 if (i >= 0)
354 ((unsigned long *)ap->ob_item)[i] = x;
355 return 0;
Guido van Rossum549ab711997-01-03 19:09:47 +0000356}
357
358static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000359f_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum778983b1993-02-19 15:55:02 +0000360{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000361 return PyFloat_FromDouble((double) ((float *)ap->ob_item)[i]);
Guido van Rossum778983b1993-02-19 15:55:02 +0000362}
363
364static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000365f_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000366{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000367 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;
Guido van Rossum778983b1993-02-19 15:55:02 +0000373}
374
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000375static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000376d_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum778983b1993-02-19 15:55:02 +0000377{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000378 return PyFloat_FromDouble(((double *)ap->ob_item)[i]);
Guido van Rossum778983b1993-02-19 15:55:02 +0000379}
380
381static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000382d_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000383{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000384 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;
Guido van Rossum778983b1993-02-19 15:55:02 +0000390}
391
392/* Description of types */
Guido van Rossum234f9421993-06-17 12:35:49 +0000393static struct arraydescr descriptors[] = {
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000394 {'c', sizeof(char), c_getitem, c_setitem},
395 {'b', sizeof(char), b_getitem, b_setitem},
396 {'B', sizeof(char), BB_getitem, BB_setitem},
Martin v. Löwis99866332002-03-01 10:27:01 +0000397#ifdef Py_USING_UNICODE
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000398 {'u', sizeof(Py_UNICODE), u_getitem, u_setitem},
Martin v. Löwis99866332002-03-01 10:27:01 +0000399#endif
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000400 {'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 */
Guido van Rossum778983b1993-02-19 15:55:02 +0000409};
Tim Petersbb307342000-09-10 05:22:54 +0000410
411/****************************************************************************
412Implementations of array object methods.
413****************************************************************************/
Guido van Rossum778983b1993-02-19 15:55:02 +0000414
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000415static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000416newarrayobject(PyTypeObject *type, Py_ssize_t size, struct arraydescr *descr)
Guido van Rossum778983b1993-02-19 15:55:02 +0000417{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000418 arrayobject *op;
419 size_t nbytes;
Martin v. Löwis99866332002-03-01 10:27:01 +0000420
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000421 if (size < 0) {
422 PyErr_BadInternalCall();
423 return NULL;
424 }
Martin v. Löwis99866332002-03-01 10:27:01 +0000425
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000426 nbytes = size * descr->itemsize;
427 /* Check for overflow */
428 if (nbytes / descr->itemsize != (size_t)size) {
429 return PyErr_NoMemory();
430 }
431 op = (arrayobject *) type->tp_alloc(type, 0);
432 if (op == NULL) {
433 return NULL;
434 }
435 op->ob_descr = descr;
436 op->allocated = size;
437 op->weakreflist = NULL;
438 Py_SIZE(op) = size;
439 if (size <= 0) {
440 op->ob_item = NULL;
441 }
442 else {
443 op->ob_item = PyMem_NEW(char, nbytes);
444 if (op->ob_item == NULL) {
445 Py_DECREF(op);
446 return PyErr_NoMemory();
447 }
448 }
449 return (PyObject *) op;
Guido van Rossum778983b1993-02-19 15:55:02 +0000450}
451
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000452static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000453getarrayitem(PyObject *op, Py_ssize_t i)
Guido van Rossum778983b1993-02-19 15:55:02 +0000454{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000455 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);
Guido van Rossum778983b1993-02-19 15:55:02 +0000460}
461
462static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000463ins1(arrayobject *self, Py_ssize_t where, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000464{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000465 char *items;
466 Py_ssize_t n = Py_SIZE(self);
467 if (v == NULL) {
468 PyErr_BadInternalCall();
469 return -1;
470 }
471 if ((*self->ob_descr->setitem)(self, -1, v) < 0)
472 return -1;
Raymond Hettinger6e2ee862004-03-14 04:37:50 +0000473
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000474 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;
481 }
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);
Guido van Rossum778983b1993-02-19 15:55:02 +0000490}
491
Guido van Rossum778983b1993-02-19 15:55:02 +0000492/* Methods */
493
494static void
Peter Schneider-Kamp9656abd2000-07-13 21:10:57 +0000495array_dealloc(arrayobject *op)
Guido van Rossum778983b1993-02-19 15:55:02 +0000496{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000497 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);
Guido van Rossum778983b1993-02-19 15:55:02 +0000502}
503
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000504static PyObject *
505array_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossum778983b1993-02-19 15:55:02 +0000506{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000507 arrayobject *va, *wa;
508 PyObject *vi = NULL;
509 PyObject *wi = NULL;
510 Py_ssize_t i, k;
511 PyObject *res;
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000512
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000513 if (!array_Check(v) || !array_Check(w)) {
514 Py_INCREF(Py_NotImplemented);
515 return Py_NotImplemented;
516 }
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000517
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000518 va = (arrayobject *)v;
519 wa = (arrayobject *)w;
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000520
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000521 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;
529 }
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000530
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000531 /* 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;
540 }
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;
548 }
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000549
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000550 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 */
563 }
564 if (cmp)
565 res = Py_True;
566 else
567 res = Py_False;
568 Py_INCREF(res);
569 return res;
570 }
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000571
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000572 /* 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;
576 }
577 else if (op == Py_NE) {
578 Py_INCREF(Py_True);
579 res = Py_True;
580 }
581 else {
582 /* Compare the final item again using the proper operator */
583 res = PyObject_RichCompare(vi, wi, op);
584 }
585 Py_DECREF(vi);
586 Py_DECREF(wi);
587 return res;
Guido van Rossum778983b1993-02-19 15:55:02 +0000588}
589
Martin v. Löwis18e16552006-02-15 17:27:45 +0000590static Py_ssize_t
Peter Schneider-Kamp9656abd2000-07-13 21:10:57 +0000591array_length(arrayobject *a)
Guido van Rossum778983b1993-02-19 15:55:02 +0000592{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000593 return Py_SIZE(a);
Guido van Rossum778983b1993-02-19 15:55:02 +0000594}
595
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000596static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000597array_item(arrayobject *a, Py_ssize_t i)
Guido van Rossum778983b1993-02-19 15:55:02 +0000598{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000599 if (i < 0 || i >= Py_SIZE(a)) {
600 PyErr_SetString(PyExc_IndexError, "array index out of range");
601 return NULL;
602 }
603 return getarrayitem((PyObject *)a, i);
Guido van Rossum778983b1993-02-19 15:55:02 +0000604}
605
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000606static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000607array_slice(arrayobject *a, Py_ssize_t ilow, Py_ssize_t ihigh)
Guido van Rossum778983b1993-02-19 15:55:02 +0000608{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000609 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;
Guido van Rossum778983b1993-02-19 15:55:02 +0000626}
627
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000628static PyObject *
Raymond Hettinger3aa82c02004-03-13 18:18:51 +0000629array_copy(arrayobject *a, PyObject *unused)
630{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000631 return array_slice(a, 0, Py_SIZE(a));
Raymond Hettinger3aa82c02004-03-13 18:18:51 +0000632}
633
634PyDoc_STRVAR(copy_doc,
635"copy(array)\n\
636\n\
637 Return a copy of the array.");
638
639static PyObject *
Peter Schneider-Kamp9656abd2000-07-13 21:10:57 +0000640array_concat(arrayobject *a, PyObject *bb)
Guido van Rossum778983b1993-02-19 15:55:02 +0000641{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000642 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;
649 }
Guido van Rossum778983b1993-02-19 15:55:02 +0000650#define b ((arrayobject *)bb)
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000651 if (a->ob_descr != b->ob_descr) {
652 PyErr_BadArgument();
653 return NULL;
654 }
655 if (Py_SIZE(a) > PY_SSIZE_T_MAX - Py_SIZE(b)) {
656 return PyErr_NoMemory();
657 }
658 size = Py_SIZE(a) + Py_SIZE(b);
659 np = (arrayobject *) newarrayobject(&Arraytype, size, a->ob_descr);
660 if (np == NULL) {
661 return NULL;
662 }
663 memcpy(np->ob_item, a->ob_item, Py_SIZE(a)*a->ob_descr->itemsize);
664 memcpy(np->ob_item + Py_SIZE(a)*a->ob_descr->itemsize,
665 b->ob_item, Py_SIZE(b)*b->ob_descr->itemsize);
666 return (PyObject *)np;
Guido van Rossum778983b1993-02-19 15:55:02 +0000667#undef b
668}
669
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000670static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000671array_repeat(arrayobject *a, Py_ssize_t n)
Guido van Rossum778983b1993-02-19 15:55:02 +0000672{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000673 Py_ssize_t i;
674 Py_ssize_t size;
675 arrayobject *np;
676 char *p;
677 Py_ssize_t nbytes;
678 if (n < 0)
679 n = 0;
680 if ((Py_SIZE(a) != 0) && (n > PY_SSIZE_T_MAX / Py_SIZE(a))) {
681 return PyErr_NoMemory();
682 }
683 size = Py_SIZE(a) * n;
684 np = (arrayobject *) newarrayobject(&Arraytype, size, a->ob_descr);
685 if (np == NULL)
686 return NULL;
687 p = np->ob_item;
688 nbytes = Py_SIZE(a) * a->ob_descr->itemsize;
689 for (i = 0; i < n; i++) {
690 memcpy(p, a->ob_item, nbytes);
691 p += nbytes;
692 }
693 return (PyObject *) np;
Guido van Rossum778983b1993-02-19 15:55:02 +0000694}
695
696static int
Martin v. Löwisad0a4622006-02-16 14:30:23 +0000697array_ass_slice(arrayobject *a, Py_ssize_t ilow, Py_ssize_t ihigh, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000698{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000699 char *item;
700 Py_ssize_t n; /* Size of replacement array */
701 Py_ssize_t d; /* Change in size */
Guido van Rossum778983b1993-02-19 15:55:02 +0000702#define b ((arrayobject *)v)
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000703 if (v == NULL)
704 n = 0;
705 else if (array_Check(v)) {
706 n = Py_SIZE(b);
707 if (a == b) {
708 /* Special case "a[i:j] = a" -- copy b first */
709 int ret;
710 v = array_slice(b, 0, n);
711 if (!v)
712 return -1;
713 ret = array_ass_slice(a, ilow, ihigh, v);
714 Py_DECREF(v);
715 return ret;
716 }
717 if (b->ob_descr != a->ob_descr) {
718 PyErr_BadArgument();
719 return -1;
720 }
721 }
722 else {
723 PyErr_Format(PyExc_TypeError,
724 "can only assign array (not \"%.200s\") to array slice",
725 Py_TYPE(v)->tp_name);
726 return -1;
727 }
728 if (ilow < 0)
729 ilow = 0;
730 else if (ilow > Py_SIZE(a))
731 ilow = Py_SIZE(a);
732 if (ihigh < 0)
733 ihigh = 0;
734 if (ihigh < ilow)
735 ihigh = ilow;
736 else if (ihigh > Py_SIZE(a))
737 ihigh = Py_SIZE(a);
738 item = a->ob_item;
739 d = n - (ihigh-ilow);
740 if (d < 0) { /* Delete -d items */
741 memmove(item + (ihigh+d)*a->ob_descr->itemsize,
742 item + ihigh*a->ob_descr->itemsize,
743 (Py_SIZE(a)-ihigh)*a->ob_descr->itemsize);
744 Py_SIZE(a) += d;
745 PyMem_RESIZE(item, char, Py_SIZE(a)*a->ob_descr->itemsize);
746 /* Can't fail */
747 a->ob_item = item;
748 a->allocated = Py_SIZE(a);
749 }
750 else if (d > 0) { /* Insert d items */
751 PyMem_RESIZE(item, char,
752 (Py_SIZE(a) + d)*a->ob_descr->itemsize);
753 if (item == NULL) {
754 PyErr_NoMemory();
755 return -1;
756 }
757 memmove(item + (ihigh+d)*a->ob_descr->itemsize,
758 item + ihigh*a->ob_descr->itemsize,
759 (Py_SIZE(a)-ihigh)*a->ob_descr->itemsize);
760 a->ob_item = item;
761 Py_SIZE(a) += d;
762 a->allocated = Py_SIZE(a);
763 }
764 if (n > 0)
765 memcpy(item + ilow*a->ob_descr->itemsize, b->ob_item,
766 n*b->ob_descr->itemsize);
767 return 0;
Guido van Rossum778983b1993-02-19 15:55:02 +0000768#undef b
769}
770
771static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000772array_ass_item(arrayobject *a, Py_ssize_t i, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000773{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000774 if (i < 0 || i >= Py_SIZE(a)) {
775 PyErr_SetString(PyExc_IndexError,
776 "array assignment index out of range");
777 return -1;
778 }
779 if (v == NULL)
780 return array_ass_slice(a, i, i+1, v);
781 return (*a->ob_descr->setitem)(a, i, v);
Guido van Rossum778983b1993-02-19 15:55:02 +0000782}
783
784static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000785setarrayitem(PyObject *a, Py_ssize_t i, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000786{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000787 assert(array_Check(a));
788 return array_ass_item((arrayobject *)a, i, v);
Guido van Rossum778983b1993-02-19 15:55:02 +0000789}
790
Martin v. Löwis99866332002-03-01 10:27:01 +0000791static int
Raymond Hettinger49f9bd12004-03-14 05:43:59 +0000792array_iter_extend(arrayobject *self, PyObject *bb)
793{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000794 PyObject *it, *v;
Raymond Hettinger49f9bd12004-03-14 05:43:59 +0000795
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000796 it = PyObject_GetIter(bb);
797 if (it == NULL)
798 return -1;
Raymond Hettinger49f9bd12004-03-14 05:43:59 +0000799
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000800 while ((v = PyIter_Next(it)) != NULL) {
801 if (ins1(self, (int) Py_SIZE(self), v) != 0) {
802 Py_DECREF(v);
803 Py_DECREF(it);
804 return -1;
805 }
806 Py_DECREF(v);
807 }
808 Py_DECREF(it);
809 if (PyErr_Occurred())
810 return -1;
811 return 0;
Raymond Hettinger49f9bd12004-03-14 05:43:59 +0000812}
813
814static int
Martin v. Löwis99866332002-03-01 10:27:01 +0000815array_do_extend(arrayobject *self, PyObject *bb)
816{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000817 Py_ssize_t size;
818 char *old_item;
Martin v. Löwis99866332002-03-01 10:27:01 +0000819
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000820 if (!array_Check(bb))
821 return array_iter_extend(self, bb);
Martin v. Löwis99866332002-03-01 10:27:01 +0000822#define b ((arrayobject *)bb)
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000823 if (self->ob_descr != b->ob_descr) {
824 PyErr_SetString(PyExc_TypeError,
825 "can only extend with array of same kind");
826 return -1;
827 }
828 if ((Py_SIZE(self) > PY_SSIZE_T_MAX - Py_SIZE(b)) ||
829 ((Py_SIZE(self) + Py_SIZE(b)) > PY_SSIZE_T_MAX / self->ob_descr->itemsize)) {
830 PyErr_NoMemory();
831 return -1;
832 }
833 size = Py_SIZE(self) + Py_SIZE(b);
834 old_item = self->ob_item;
835 PyMem_RESIZE(self->ob_item, char, size*self->ob_descr->itemsize);
836 if (self->ob_item == NULL) {
837 self->ob_item = old_item;
838 PyErr_NoMemory();
839 return -1;
840 }
841 memcpy(self->ob_item + Py_SIZE(self)*self->ob_descr->itemsize,
842 b->ob_item, Py_SIZE(b)*b->ob_descr->itemsize);
843 Py_SIZE(self) = size;
844 self->allocated = size;
Martin v. Löwis99866332002-03-01 10:27:01 +0000845
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000846 return 0;
Martin v. Löwis99866332002-03-01 10:27:01 +0000847#undef b
848}
849
850static PyObject *
851array_inplace_concat(arrayobject *self, PyObject *bb)
852{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000853 if (!array_Check(bb)) {
854 PyErr_Format(PyExc_TypeError,
855 "can only extend array with array (not \"%.200s\")",
856 Py_TYPE(bb)->tp_name);
857 return NULL;
858 }
859 if (array_do_extend(self, bb) == -1)
860 return NULL;
861 Py_INCREF(self);
862 return (PyObject *)self;
Martin v. Löwis99866332002-03-01 10:27:01 +0000863}
864
865static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000866array_inplace_repeat(arrayobject *self, Py_ssize_t n)
Martin v. Löwis99866332002-03-01 10:27:01 +0000867{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000868 char *items, *p;
869 Py_ssize_t size, i;
Martin v. Löwis99866332002-03-01 10:27:01 +0000870
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000871 if (Py_SIZE(self) > 0) {
872 if (n < 0)
873 n = 0;
874 items = self->ob_item;
875 if ((self->ob_descr->itemsize != 0) &&
876 (Py_SIZE(self) > PY_SSIZE_T_MAX / self->ob_descr->itemsize)) {
877 return PyErr_NoMemory();
878 }
879 size = Py_SIZE(self) * self->ob_descr->itemsize;
880 if (n == 0) {
881 PyMem_FREE(items);
882 self->ob_item = NULL;
883 Py_SIZE(self) = 0;
884 self->allocated = 0;
885 }
886 else {
887 if (size > PY_SSIZE_T_MAX / n) {
888 return PyErr_NoMemory();
889 }
890 PyMem_RESIZE(items, char, n * size);
891 if (items == NULL)
892 return PyErr_NoMemory();
893 p = items;
894 for (i = 1; i < n; i++) {
895 p += size;
896 memcpy(p, items, size);
897 }
898 self->ob_item = items;
899 Py_SIZE(self) *= n;
900 self->allocated = Py_SIZE(self);
901 }
902 }
903 Py_INCREF(self);
904 return (PyObject *)self;
Martin v. Löwis99866332002-03-01 10:27:01 +0000905}
906
907
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000908static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000909ins(arrayobject *self, Py_ssize_t where, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000910{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000911 if (ins1(self, where, v) != 0)
912 return NULL;
913 Py_INCREF(Py_None);
914 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +0000915}
916
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000917static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000918array_count(arrayobject *self, PyObject *v)
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000919{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000920 Py_ssize_t count = 0;
921 Py_ssize_t i;
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000922
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000923 for (i = 0; i < Py_SIZE(self); i++) {
924 PyObject *selfi = getarrayitem((PyObject *)self, i);
925 int cmp = PyObject_RichCompareBool(selfi, v, Py_EQ);
926 Py_DECREF(selfi);
927 if (cmp > 0)
928 count++;
929 else if (cmp < 0)
930 return NULL;
931 }
932 return PyInt_FromSsize_t(count);
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000933}
934
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000935PyDoc_STRVAR(count_doc,
Tim Peters077a11d2000-09-16 22:31:29 +0000936"count(x)\n\
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000937\n\
Jesus Cea585ad8a2009-07-02 15:37:21 +0000938Return number of occurrences of x in the array.");
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000939
940static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000941array_index(arrayobject *self, PyObject *v)
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000942{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000943 Py_ssize_t i;
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000944
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000945 for (i = 0; i < Py_SIZE(self); i++) {
946 PyObject *selfi = getarrayitem((PyObject *)self, i);
947 int cmp = PyObject_RichCompareBool(selfi, v, Py_EQ);
948 Py_DECREF(selfi);
949 if (cmp > 0) {
950 return PyInt_FromLong((long)i);
951 }
952 else if (cmp < 0)
953 return NULL;
954 }
955 PyErr_SetString(PyExc_ValueError, "array.index(x): x not in list");
956 return NULL;
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000957}
958
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000959PyDoc_STRVAR(index_doc,
Tim Peters077a11d2000-09-16 22:31:29 +0000960"index(x)\n\
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000961\n\
Jesus Cea585ad8a2009-07-02 15:37:21 +0000962Return index of first occurrence of x in the array.");
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000963
Raymond Hettinger625812f2003-01-07 01:58:52 +0000964static int
965array_contains(arrayobject *self, PyObject *v)
966{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000967 Py_ssize_t i;
968 int cmp;
Raymond Hettinger625812f2003-01-07 01:58:52 +0000969
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000970 for (i = 0, cmp = 0 ; cmp == 0 && i < Py_SIZE(self); i++) {
971 PyObject *selfi = getarrayitem((PyObject *)self, i);
972 cmp = PyObject_RichCompareBool(selfi, v, Py_EQ);
973 Py_DECREF(selfi);
974 }
975 return cmp;
Raymond Hettinger625812f2003-01-07 01:58:52 +0000976}
977
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000978static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000979array_remove(arrayobject *self, PyObject *v)
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000980{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000981 int i;
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000982
Antoine Pitrouc7c96a92010-05-09 15:15:40 +0000983 for (i = 0; i < Py_SIZE(self); i++) {
984 PyObject *selfi = getarrayitem((PyObject *)self,i);
985 int cmp = PyObject_RichCompareBool(selfi, v, Py_EQ);
986 Py_DECREF(selfi);
987 if (cmp > 0) {
988 if (array_ass_slice(self, i, i+1,
989 (PyObject *)NULL) != 0)
990 return NULL;
991 Py_INCREF(Py_None);
992 return Py_None;
993 }
994 else if (cmp < 0)
995 return NULL;
996 }
997 PyErr_SetString(PyExc_ValueError, "array.remove(x): x not in list");
998 return NULL;
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000999}
1000
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001001PyDoc_STRVAR(remove_doc,
Tim Peters077a11d2000-09-16 22:31:29 +00001002"remove(x)\n\
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001003\n\
Jesus Cea585ad8a2009-07-02 15:37:21 +00001004Remove the first occurrence of x in the array.");
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001005
1006static PyObject *
1007array_pop(arrayobject *self, PyObject *args)
1008{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001009 Py_ssize_t i = -1;
1010 PyObject *v;
1011 if (!PyArg_ParseTuple(args, "|n:pop", &i))
1012 return NULL;
1013 if (Py_SIZE(self) == 0) {
1014 /* Special-case most common failure cause */
1015 PyErr_SetString(PyExc_IndexError, "pop from empty array");
1016 return NULL;
1017 }
1018 if (i < 0)
1019 i += Py_SIZE(self);
1020 if (i < 0 || i >= Py_SIZE(self)) {
1021 PyErr_SetString(PyExc_IndexError, "pop index out of range");
1022 return NULL;
1023 }
1024 v = getarrayitem((PyObject *)self,i);
1025 if (array_ass_slice(self, i, i+1, (PyObject *)NULL) != 0) {
1026 Py_DECREF(v);
1027 return NULL;
1028 }
1029 return v;
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001030}
1031
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001032PyDoc_STRVAR(pop_doc,
Tim Peters077a11d2000-09-16 22:31:29 +00001033"pop([i])\n\
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001034\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001035Return the i-th element and delete it from the array. i defaults to -1.");
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001036
1037static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001038array_extend(arrayobject *self, PyObject *bb)
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001039{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001040 if (array_do_extend(self, bb) == -1)
1041 return NULL;
1042 Py_INCREF(Py_None);
1043 return Py_None;
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001044}
1045
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001046PyDoc_STRVAR(extend_doc,
Raymond Hettinger49f9bd12004-03-14 05:43:59 +00001047"extend(array or iterable)\n\
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001048\n\
Raymond Hettinger49f9bd12004-03-14 05:43:59 +00001049 Append items to the end of the array.");
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001050
1051static PyObject *
Peter Schneider-Kamp9656abd2000-07-13 21:10:57 +00001052array_insert(arrayobject *self, PyObject *args)
Guido van Rossum778983b1993-02-19 15:55:02 +00001053{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001054 Py_ssize_t i;
1055 PyObject *v;
1056 if (!PyArg_ParseTuple(args, "nO:insert", &i, &v))
1057 return NULL;
1058 return ins(self, i, v);
Guido van Rossum778983b1993-02-19 15:55:02 +00001059}
1060
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001061PyDoc_STRVAR(insert_doc,
Tim Peters077a11d2000-09-16 22:31:29 +00001062"insert(i,x)\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001063\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001064Insert a new item x into the array before position i.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001065
1066
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001067static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001068array_buffer_info(arrayobject *self, PyObject *unused)
Guido van Rossumde4a4ca1997-08-12 14:55:56 +00001069{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001070 PyObject* retval = NULL;
1071 retval = PyTuple_New(2);
1072 if (!retval)
1073 return NULL;
Fred Drake541dc3b2000-06-28 17:49:30 +00001074
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001075 PyTuple_SET_ITEM(retval, 0, PyLong_FromVoidPtr(self->ob_item));
1076 PyTuple_SET_ITEM(retval, 1, PyInt_FromLong((long)(Py_SIZE(self))));
Fred Drake541dc3b2000-06-28 17:49:30 +00001077
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001078 return retval;
Guido van Rossumde4a4ca1997-08-12 14:55:56 +00001079}
1080
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001081PyDoc_STRVAR(buffer_info_doc,
Tim Peters077a11d2000-09-16 22:31:29 +00001082"buffer_info() -> (address, length)\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001083\n\
1084Return a tuple (address, length) giving the current memory address and\n\
Guido van Rossum702d08e2001-07-27 16:05:32 +00001085the length in items of the buffer used to hold array's contents\n\
1086The length should be multiplied by the itemsize attribute to calculate\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001087the buffer length in bytes.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001088
1089
Guido van Rossumde4a4ca1997-08-12 14:55:56 +00001090static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001091array_append(arrayobject *self, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +00001092{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001093 return ins(self, (int) Py_SIZE(self), v);
Guido van Rossum778983b1993-02-19 15:55:02 +00001094}
1095
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001096PyDoc_STRVAR(append_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001097"append(x)\n\
1098\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001099Append new value x to the end of the array.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001100
1101
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001102static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001103array_byteswap(arrayobject *self, PyObject *unused)
Guido van Rossum778983b1993-02-19 15:55:02 +00001104{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001105 char *p;
1106 Py_ssize_t i;
Fred Drakebf272981999-12-03 17:15:30 +00001107
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001108 switch (self->ob_descr->itemsize) {
1109 case 1:
1110 break;
1111 case 2:
1112 for (p = self->ob_item, i = Py_SIZE(self); --i >= 0; p += 2) {
1113 char p0 = p[0];
1114 p[0] = p[1];
1115 p[1] = p0;
1116 }
1117 break;
1118 case 4:
1119 for (p = self->ob_item, i = Py_SIZE(self); --i >= 0; p += 4) {
1120 char p0 = p[0];
1121 char p1 = p[1];
1122 p[0] = p[3];
1123 p[1] = p[2];
1124 p[2] = p1;
1125 p[3] = p0;
1126 }
1127 break;
1128 case 8:
1129 for (p = self->ob_item, i = Py_SIZE(self); --i >= 0; p += 8) {
1130 char p0 = p[0];
1131 char p1 = p[1];
1132 char p2 = p[2];
1133 char p3 = p[3];
1134 p[0] = p[7];
1135 p[1] = p[6];
1136 p[2] = p[5];
1137 p[3] = p[4];
1138 p[4] = p3;
1139 p[5] = p2;
1140 p[6] = p1;
1141 p[7] = p0;
1142 }
1143 break;
1144 default:
1145 PyErr_SetString(PyExc_RuntimeError,
1146 "don't know how to byteswap this array type");
1147 return NULL;
1148 }
1149 Py_INCREF(Py_None);
1150 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +00001151}
1152
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001153PyDoc_STRVAR(byteswap_doc,
Fred Drakebf272981999-12-03 17:15:30 +00001154"byteswap()\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001155\n\
Fred Drakebf272981999-12-03 17:15:30 +00001156Byteswap all items of the array. If the items in the array are not 1, 2,\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000011574, or 8 bytes in size, RuntimeError is raised.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001158
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001159static PyObject *
Raymond Hettingerb0900e62004-12-16 16:23:40 +00001160array_reduce(arrayobject *array)
1161{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001162 PyObject *dict, *result;
Raymond Hettingerb0900e62004-12-16 16:23:40 +00001163
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001164 dict = PyObject_GetAttrString((PyObject *)array, "__dict__");
1165 if (dict == NULL) {
1166 PyErr_Clear();
1167 dict = Py_None;
1168 Py_INCREF(dict);
1169 }
1170 if (Py_SIZE(array) > 0) {
1171 if (array->ob_descr->itemsize
1172 > PY_SSIZE_T_MAX / array->ob_size) {
1173 return PyErr_NoMemory();
1174 }
1175 result = Py_BuildValue("O(cs#)O",
1176 Py_TYPE(array),
1177 array->ob_descr->typecode,
1178 array->ob_item,
1179 Py_SIZE(array) * array->ob_descr->itemsize,
1180 dict);
1181 } else {
1182 result = Py_BuildValue("O(c)O",
1183 Py_TYPE(array),
1184 array->ob_descr->typecode,
1185 dict);
1186 }
1187 Py_DECREF(dict);
1188 return result;
Raymond Hettingerb0900e62004-12-16 16:23:40 +00001189}
1190
1191PyDoc_STRVAR(array_doc, "Return state information for pickling.");
1192
1193static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001194array_reverse(arrayobject *self, PyObject *unused)
Guido van Rossum778983b1993-02-19 15:55:02 +00001195{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001196 register Py_ssize_t itemsize = self->ob_descr->itemsize;
1197 register char *p, *q;
1198 /* little buffer to hold items while swapping */
1199 char tmp[256]; /* 8 is probably enough -- but why skimp */
1200 assert((size_t)itemsize <= sizeof(tmp));
Guido van Rossume77a7571993-11-03 15:01:26 +00001201
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001202 if (Py_SIZE(self) > 1) {
1203 for (p = self->ob_item,
1204 q = self->ob_item + (Py_SIZE(self) - 1)*itemsize;
1205 p < q;
1206 p += itemsize, q -= itemsize) {
1207 /* memory areas guaranteed disjoint, so memcpy
1208 * is safe (& memmove may be slower).
1209 */
1210 memcpy(tmp, p, itemsize);
1211 memcpy(p, q, itemsize);
1212 memcpy(q, tmp, itemsize);
1213 }
1214 }
Tim Petersbb307342000-09-10 05:22:54 +00001215
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001216 Py_INCREF(Py_None);
1217 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +00001218}
Guido van Rossume77a7571993-11-03 15:01:26 +00001219
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001220PyDoc_STRVAR(reverse_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001221"reverse()\n\
1222\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001223Reverse the order of the items in the array.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001224
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001225static PyObject *
Peter Schneider-Kamp9656abd2000-07-13 21:10:57 +00001226array_fromfile(arrayobject *self, PyObject *args)
Guido van Rossum778983b1993-02-19 15:55:02 +00001227{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001228 PyObject *f;
1229 Py_ssize_t n;
1230 FILE *fp;
1231 if (!PyArg_ParseTuple(args, "On:fromfile", &f, &n))
1232 return NULL;
1233 fp = PyFile_AsFile(f);
1234 if (fp == NULL) {
1235 PyErr_SetString(PyExc_TypeError, "arg1 must be open file");
1236 return NULL;
1237 }
1238 if (n > 0) {
1239 char *item = self->ob_item;
1240 Py_ssize_t itemsize = self->ob_descr->itemsize;
1241 size_t nread;
1242 Py_ssize_t newlength;
1243 size_t newbytes;
1244 /* Be careful here about overflow */
1245 if ((newlength = Py_SIZE(self) + n) <= 0 ||
1246 (newbytes = newlength * itemsize) / itemsize !=
1247 (size_t)newlength)
1248 goto nomem;
1249 PyMem_RESIZE(item, char, newbytes);
1250 if (item == NULL) {
1251 nomem:
1252 PyErr_NoMemory();
1253 return NULL;
1254 }
1255 self->ob_item = item;
1256 Py_SIZE(self) += n;
1257 self->allocated = Py_SIZE(self);
1258 nread = fread(item + (Py_SIZE(self) - n) * itemsize,
1259 itemsize, n, fp);
1260 if (nread < (size_t)n) {
1261 Py_SIZE(self) -= (n - nread);
1262 PyMem_RESIZE(item, char, Py_SIZE(self)*itemsize);
1263 self->ob_item = item;
1264 self->allocated = Py_SIZE(self);
1265 PyErr_SetString(PyExc_EOFError,
1266 "not enough items in file");
1267 return NULL;
1268 }
1269 }
1270 Py_INCREF(Py_None);
1271 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +00001272}
1273
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001274PyDoc_STRVAR(fromfile_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001275"fromfile(f, n)\n\
1276\n\
1277Read n objects from the file object f and append them to the end of the\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001278array. Also called as read.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001279
1280
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001281static PyObject *
Georg Brandl1e7c3752008-03-25 08:37:23 +00001282array_fromfile_as_read(arrayobject *self, PyObject *args)
1283{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001284 if (PyErr_WarnPy3k("array.read() not supported in 3.x; "
1285 "use array.fromfile()", 1) < 0)
1286 return NULL;
1287 return array_fromfile(self, args);
Georg Brandl1e7c3752008-03-25 08:37:23 +00001288}
1289
1290
1291static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001292array_tofile(arrayobject *self, PyObject *f)
Guido van Rossum778983b1993-02-19 15:55:02 +00001293{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001294 FILE *fp;
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001295
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001296 fp = PyFile_AsFile(f);
1297 if (fp == NULL) {
1298 PyErr_SetString(PyExc_TypeError, "arg must be open file");
1299 return NULL;
1300 }
1301 if (self->ob_size > 0) {
1302 if (fwrite(self->ob_item, self->ob_descr->itemsize,
1303 self->ob_size, fp) != (size_t)self->ob_size) {
1304 PyErr_SetFromErrno(PyExc_IOError);
1305 clearerr(fp);
1306 return NULL;
1307 }
1308 }
1309 Py_INCREF(Py_None);
1310 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +00001311}
1312
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001313PyDoc_STRVAR(tofile_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001314"tofile(f)\n\
1315\n\
1316Write all items (as machine values) to the file object f. Also called as\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001317write.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001318
1319
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001320static PyObject *
Georg Brandl1e7c3752008-03-25 08:37:23 +00001321array_tofile_as_write(arrayobject *self, PyObject *f)
1322{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001323 if (PyErr_WarnPy3k("array.write() not supported in 3.x; "
1324 "use array.tofile()", 1) < 0)
1325 return NULL;
1326 return array_tofile(self, f);
Georg Brandl1e7c3752008-03-25 08:37:23 +00001327}
1328
1329
1330static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001331array_fromlist(arrayobject *self, PyObject *list)
Guido van Rossum778983b1993-02-19 15:55:02 +00001332{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001333 Py_ssize_t n;
1334 Py_ssize_t itemsize = self->ob_descr->itemsize;
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001335
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001336 if (!PyList_Check(list)) {
1337 PyErr_SetString(PyExc_TypeError, "arg must be list");
1338 return NULL;
1339 }
1340 n = PyList_Size(list);
1341 if (n > 0) {
1342 char *item = self->ob_item;
1343 Py_ssize_t i;
1344 PyMem_RESIZE(item, char, (Py_SIZE(self) + n) * itemsize);
1345 if (item == NULL) {
1346 PyErr_NoMemory();
1347 return NULL;
1348 }
1349 self->ob_item = item;
1350 Py_SIZE(self) += n;
1351 self->allocated = Py_SIZE(self);
1352 for (i = 0; i < n; i++) {
1353 PyObject *v = PyList_GetItem(list, i);
1354 if ((*self->ob_descr->setitem)(self,
1355 Py_SIZE(self) - n + i, v) != 0) {
1356 Py_SIZE(self) -= n;
1357 if (itemsize && (self->ob_size > PY_SSIZE_T_MAX / itemsize)) {
1358 return PyErr_NoMemory();
1359 }
1360 PyMem_RESIZE(item, char,
1361 Py_SIZE(self) * itemsize);
1362 self->ob_item = item;
1363 self->allocated = Py_SIZE(self);
1364 return NULL;
1365 }
1366 }
1367 }
1368 Py_INCREF(Py_None);
1369 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +00001370}
1371
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001372PyDoc_STRVAR(fromlist_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001373"fromlist(list)\n\
1374\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001375Append items to array from list.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001376
1377
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001378static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001379array_tolist(arrayobject *self, PyObject *unused)
Guido van Rossum778983b1993-02-19 15:55:02 +00001380{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001381 PyObject *list = PyList_New(Py_SIZE(self));
1382 Py_ssize_t i;
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001383
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001384 if (list == NULL)
1385 return NULL;
1386 for (i = 0; i < Py_SIZE(self); i++) {
1387 PyObject *v = getarrayitem((PyObject *)self, i);
1388 if (v == NULL) {
1389 Py_DECREF(list);
1390 return NULL;
1391 }
1392 PyList_SetItem(list, i, v);
1393 }
1394 return list;
Guido van Rossum778983b1993-02-19 15:55:02 +00001395}
1396
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001397PyDoc_STRVAR(tolist_doc,
Guido van Rossumfc6aba51998-10-14 02:52:31 +00001398"tolist() -> list\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001399\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001400Convert array to an ordinary list with the same items.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001401
1402
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001403static PyObject *
Peter Schneider-Kamp9656abd2000-07-13 21:10:57 +00001404array_fromstring(arrayobject *self, PyObject *args)
Guido van Rossum778983b1993-02-19 15:55:02 +00001405{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001406 char *str;
1407 Py_ssize_t n;
1408 int itemsize = self->ob_descr->itemsize;
1409 if (!PyArg_ParseTuple(args, "s#:fromstring", &str, &n))
1410 return NULL;
1411 if (n % itemsize != 0) {
1412 PyErr_SetString(PyExc_ValueError,
1413 "string length not a multiple of item size");
1414 return NULL;
1415 }
1416 n = n / itemsize;
1417 if (n > 0) {
1418 char *item = self->ob_item;
1419 if ((n > PY_SSIZE_T_MAX - Py_SIZE(self)) ||
1420 ((Py_SIZE(self) + n) > PY_SSIZE_T_MAX / itemsize)) {
1421 return PyErr_NoMemory();
1422 }
1423 PyMem_RESIZE(item, char, (Py_SIZE(self) + n) * itemsize);
1424 if (item == NULL) {
1425 PyErr_NoMemory();
1426 return NULL;
1427 }
1428 self->ob_item = item;
1429 Py_SIZE(self) += n;
1430 self->allocated = Py_SIZE(self);
1431 memcpy(item + (Py_SIZE(self) - n) * itemsize,
1432 str, itemsize*n);
1433 }
1434 Py_INCREF(Py_None);
1435 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +00001436}
1437
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001438PyDoc_STRVAR(fromstring_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001439"fromstring(string)\n\
1440\n\
1441Appends items from the string, interpreting it as an array of machine\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001442values,as if it had been read from a file using the fromfile() method).");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001443
1444
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001445static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001446array_tostring(arrayobject *self, PyObject *unused)
Guido van Rossum778983b1993-02-19 15:55:02 +00001447{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001448 if (self->ob_size <= PY_SSIZE_T_MAX / self->ob_descr->itemsize) {
1449 return PyString_FromStringAndSize(self->ob_item,
1450 Py_SIZE(self) * self->ob_descr->itemsize);
1451 } else {
1452 return PyErr_NoMemory();
1453 }
Guido van Rossum778983b1993-02-19 15:55:02 +00001454}
1455
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001456PyDoc_STRVAR(tostring_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001457"tostring() -> string\n\
1458\n\
1459Convert the array to an array of machine values and return the string\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001460representation.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001461
Martin v. Löwis99866332002-03-01 10:27:01 +00001462
1463
1464#ifdef Py_USING_UNICODE
1465static PyObject *
1466array_fromunicode(arrayobject *self, PyObject *args)
1467{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001468 Py_UNICODE *ustr;
1469 Py_ssize_t n;
Martin v. Löwis99866332002-03-01 10:27:01 +00001470
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001471 if (!PyArg_ParseTuple(args, "u#:fromunicode", &ustr, &n))
1472 return NULL;
1473 if (self->ob_descr->typecode != 'u') {
1474 PyErr_SetString(PyExc_ValueError,
1475 "fromunicode() may only be called on "
1476 "type 'u' arrays");
1477 return NULL;
1478 }
1479 if (n > 0) {
1480 Py_UNICODE *item = (Py_UNICODE *) self->ob_item;
1481 if (Py_SIZE(self) > PY_SSIZE_T_MAX - n) {
1482 return PyErr_NoMemory();
1483 }
1484 PyMem_RESIZE(item, Py_UNICODE, Py_SIZE(self) + n);
1485 if (item == NULL) {
1486 PyErr_NoMemory();
1487 return NULL;
1488 }
1489 self->ob_item = (char *) item;
1490 Py_SIZE(self) += n;
1491 self->allocated = Py_SIZE(self);
1492 memcpy(item + Py_SIZE(self) - n,
1493 ustr, n * sizeof(Py_UNICODE));
1494 }
Martin v. Löwis99866332002-03-01 10:27:01 +00001495
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001496 Py_INCREF(Py_None);
1497 return Py_None;
Martin v. Löwis99866332002-03-01 10:27:01 +00001498}
1499
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001500PyDoc_STRVAR(fromunicode_doc,
Martin v. Löwis99866332002-03-01 10:27:01 +00001501"fromunicode(ustr)\n\
1502\n\
1503Extends this array with data from the unicode string ustr.\n\
1504The array must be a type 'u' array; otherwise a ValueError\n\
1505is raised. Use array.fromstring(ustr.decode(...)) to\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001506append Unicode data to an array of some other type.");
Martin v. Löwis99866332002-03-01 10:27:01 +00001507
1508
1509static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001510array_tounicode(arrayobject *self, PyObject *unused)
Martin v. Löwis99866332002-03-01 10:27:01 +00001511{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001512 if (self->ob_descr->typecode != 'u') {
1513 PyErr_SetString(PyExc_ValueError,
1514 "tounicode() may only be called on type 'u' arrays");
1515 return NULL;
1516 }
1517 return PyUnicode_FromUnicode((Py_UNICODE *) self->ob_item, Py_SIZE(self));
Martin v. Löwis99866332002-03-01 10:27:01 +00001518}
1519
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001520PyDoc_STRVAR(tounicode_doc,
Martin v. Löwis99866332002-03-01 10:27:01 +00001521"tounicode() -> unicode\n\
1522\n\
1523Convert the array to a unicode string. The array must be\n\
1524a type 'u' array; otherwise a ValueError is raised. Use\n\
1525array.tostring().decode() to obtain a unicode string from\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001526an array of some other type.");
Martin v. Löwis99866332002-03-01 10:27:01 +00001527
1528#endif /* Py_USING_UNICODE */
1529
1530
1531static PyObject *
1532array_get_typecode(arrayobject *a, void *closure)
1533{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001534 char tc = a->ob_descr->typecode;
1535 return PyString_FromStringAndSize(&tc, 1);
Martin v. Löwis99866332002-03-01 10:27:01 +00001536}
1537
1538static PyObject *
1539array_get_itemsize(arrayobject *a, void *closure)
1540{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001541 return PyInt_FromLong((long)a->ob_descr->itemsize);
Martin v. Löwis99866332002-03-01 10:27:01 +00001542}
1543
1544static PyGetSetDef array_getsets [] = {
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001545 {"typecode", (getter) array_get_typecode, NULL,
1546 "the typecode character used to create the array"},
1547 {"itemsize", (getter) array_get_itemsize, NULL,
1548 "the size, in bytes, of one array item"},
1549 {NULL}
Martin v. Löwis99866332002-03-01 10:27:01 +00001550};
1551
Martin v. Löwis111c1802008-06-13 07:47:47 +00001552static PyMethodDef array_methods[] = {
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001553 {"append", (PyCFunction)array_append, METH_O,
1554 append_doc},
1555 {"buffer_info", (PyCFunction)array_buffer_info, METH_NOARGS,
1556 buffer_info_doc},
1557 {"byteswap", (PyCFunction)array_byteswap, METH_NOARGS,
1558 byteswap_doc},
1559 {"__copy__", (PyCFunction)array_copy, METH_NOARGS,
1560 copy_doc},
1561 {"count", (PyCFunction)array_count, METH_O,
1562 count_doc},
1563 {"__deepcopy__",(PyCFunction)array_copy, METH_O,
1564 copy_doc},
1565 {"extend", (PyCFunction)array_extend, METH_O,
1566 extend_doc},
1567 {"fromfile", (PyCFunction)array_fromfile, METH_VARARGS,
1568 fromfile_doc},
1569 {"fromlist", (PyCFunction)array_fromlist, METH_O,
1570 fromlist_doc},
1571 {"fromstring", (PyCFunction)array_fromstring, METH_VARARGS,
1572 fromstring_doc},
Martin v. Löwis99866332002-03-01 10:27:01 +00001573#ifdef Py_USING_UNICODE
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001574 {"fromunicode", (PyCFunction)array_fromunicode, METH_VARARGS,
1575 fromunicode_doc},
Martin v. Löwis99866332002-03-01 10:27:01 +00001576#endif
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001577 {"index", (PyCFunction)array_index, METH_O,
1578 index_doc},
1579 {"insert", (PyCFunction)array_insert, METH_VARARGS,
1580 insert_doc},
1581 {"pop", (PyCFunction)array_pop, METH_VARARGS,
1582 pop_doc},
1583 {"read", (PyCFunction)array_fromfile_as_read, METH_VARARGS,
1584 fromfile_doc},
1585 {"__reduce__", (PyCFunction)array_reduce, METH_NOARGS,
1586 array_doc},
1587 {"remove", (PyCFunction)array_remove, METH_O,
1588 remove_doc},
1589 {"reverse", (PyCFunction)array_reverse, METH_NOARGS,
1590 reverse_doc},
1591/* {"sort", (PyCFunction)array_sort, METH_VARARGS,
1592 sort_doc},*/
1593 {"tofile", (PyCFunction)array_tofile, METH_O,
1594 tofile_doc},
1595 {"tolist", (PyCFunction)array_tolist, METH_NOARGS,
1596 tolist_doc},
1597 {"tostring", (PyCFunction)array_tostring, METH_NOARGS,
1598 tostring_doc},
Martin v. Löwis99866332002-03-01 10:27:01 +00001599#ifdef Py_USING_UNICODE
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001600 {"tounicode", (PyCFunction)array_tounicode, METH_NOARGS,
1601 tounicode_doc},
Martin v. Löwis99866332002-03-01 10:27:01 +00001602#endif
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001603 {"write", (PyCFunction)array_tofile_as_write, METH_O,
1604 tofile_doc},
1605 {NULL, NULL} /* sentinel */
Guido van Rossum778983b1993-02-19 15:55:02 +00001606};
1607
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001608static PyObject *
Peter Schneider-Kamp9656abd2000-07-13 21:10:57 +00001609array_repr(arrayobject *a)
Guido van Rossum778983b1993-02-19 15:55:02 +00001610{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001611 char buf[256], typecode;
1612 PyObject *s, *t, *v = NULL;
1613 Py_ssize_t len;
Martin v. Löwis99866332002-03-01 10:27:01 +00001614
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001615 len = Py_SIZE(a);
1616 typecode = a->ob_descr->typecode;
1617 if (len == 0) {
1618 PyOS_snprintf(buf, sizeof(buf), "array('%c')", typecode);
1619 return PyString_FromString(buf);
1620 }
1621
1622 if (typecode == 'c')
1623 v = array_tostring(a, NULL);
Michael W. Hudson1755ad92002-05-13 10:14:59 +00001624#ifdef Py_USING_UNICODE
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001625 else if (typecode == 'u')
1626 v = array_tounicode(a, NULL);
Michael W. Hudson1755ad92002-05-13 10:14:59 +00001627#endif
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001628 else
1629 v = array_tolist(a, NULL);
1630 t = PyObject_Repr(v);
1631 Py_XDECREF(v);
Raymond Hettinger88ba1e32003-04-23 17:27:00 +00001632
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001633 PyOS_snprintf(buf, sizeof(buf), "array('%c', ", typecode);
1634 s = PyString_FromString(buf);
1635 PyString_ConcatAndDel(&s, t);
1636 PyString_ConcatAndDel(&s, PyString_FromString(")"));
1637 return s;
Guido van Rossum778983b1993-02-19 15:55:02 +00001638}
1639
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001640static PyObject*
1641array_subscr(arrayobject* self, PyObject* item)
1642{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001643 if (PyIndex_Check(item)) {
1644 Py_ssize_t i = PyNumber_AsSsize_t(item, PyExc_IndexError);
1645 if (i==-1 && PyErr_Occurred()) {
1646 return NULL;
1647 }
1648 if (i < 0)
1649 i += Py_SIZE(self);
1650 return array_item(self, i);
1651 }
1652 else if (PySlice_Check(item)) {
1653 Py_ssize_t start, stop, step, slicelength, cur, i;
1654 PyObject* result;
1655 arrayobject* ar;
1656 int itemsize = self->ob_descr->itemsize;
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001657
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001658 if (PySlice_GetIndicesEx((PySliceObject*)item, Py_SIZE(self),
1659 &start, &stop, &step, &slicelength) < 0) {
1660 return NULL;
1661 }
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001662
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001663 if (slicelength <= 0) {
1664 return newarrayobject(&Arraytype, 0, self->ob_descr);
1665 }
1666 else if (step == 1) {
1667 PyObject *result = newarrayobject(&Arraytype,
1668 slicelength, self->ob_descr);
1669 if (result == NULL)
1670 return NULL;
1671 memcpy(((arrayobject *)result)->ob_item,
1672 self->ob_item + start * itemsize,
1673 slicelength * itemsize);
1674 return result;
1675 }
1676 else {
1677 result = newarrayobject(&Arraytype, slicelength, self->ob_descr);
1678 if (!result) return NULL;
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001679
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001680 ar = (arrayobject*)result;
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001681
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001682 for (cur = start, i = 0; i < slicelength;
1683 cur += step, i++) {
1684 memcpy(ar->ob_item + i*itemsize,
1685 self->ob_item + cur*itemsize,
1686 itemsize);
1687 }
1688
1689 return result;
1690 }
1691 }
1692 else {
1693 PyErr_SetString(PyExc_TypeError,
1694 "array indices must be integers");
1695 return NULL;
1696 }
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001697}
1698
1699static int
1700array_ass_subscr(arrayobject* self, PyObject* item, PyObject* value)
1701{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001702 Py_ssize_t start, stop, step, slicelength, needed;
1703 arrayobject* other;
1704 int itemsize;
Thomas Wouters3ccec682007-08-28 15:28:19 +00001705
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001706 if (PyIndex_Check(item)) {
1707 Py_ssize_t i = PyNumber_AsSsize_t(item, PyExc_IndexError);
Mark Dickinson02733542010-01-29 17:16:18 +00001708
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001709 if (i == -1 && PyErr_Occurred())
1710 return -1;
1711 if (i < 0)
1712 i += Py_SIZE(self);
1713 if (i < 0 || i >= Py_SIZE(self)) {
1714 PyErr_SetString(PyExc_IndexError,
1715 "array assignment index out of range");
1716 return -1;
1717 }
1718 if (value == NULL) {
1719 /* Fall through to slice assignment */
1720 start = i;
1721 stop = i + 1;
1722 step = 1;
1723 slicelength = 1;
1724 }
1725 else
1726 return (*self->ob_descr->setitem)(self, i, value);
1727 }
1728 else if (PySlice_Check(item)) {
1729 if (PySlice_GetIndicesEx((PySliceObject *)item,
1730 Py_SIZE(self), &start, &stop,
1731 &step, &slicelength) < 0) {
1732 return -1;
1733 }
1734 }
1735 else {
1736 PyErr_SetString(PyExc_TypeError,
1737 "array indices must be integer");
1738 return -1;
1739 }
1740 if (value == NULL) {
1741 other = NULL;
1742 needed = 0;
1743 }
1744 else if (array_Check(value)) {
1745 other = (arrayobject *)value;
1746 needed = Py_SIZE(other);
1747 if (self == other) {
1748 /* Special case "self[i:j] = self" -- copy self first */
1749 int ret;
1750 value = array_slice(other, 0, needed);
1751 if (value == NULL)
1752 return -1;
1753 ret = array_ass_subscr(self, item, value);
1754 Py_DECREF(value);
1755 return ret;
1756 }
1757 if (other->ob_descr != self->ob_descr) {
1758 PyErr_BadArgument();
1759 return -1;
1760 }
1761 }
1762 else {
1763 PyErr_Format(PyExc_TypeError,
1764 "can only assign array (not \"%.200s\") to array slice",
1765 Py_TYPE(value)->tp_name);
1766 return -1;
1767 }
1768 itemsize = self->ob_descr->itemsize;
1769 /* for 'a[2:1] = ...', the insertion point is 'start', not 'stop' */
1770 if ((step > 0 && stop < start) ||
1771 (step < 0 && stop > start))
1772 stop = start;
1773 if (step == 1) {
1774 if (slicelength > needed) {
1775 memmove(self->ob_item + (start + needed) * itemsize,
1776 self->ob_item + stop * itemsize,
1777 (Py_SIZE(self) - stop) * itemsize);
1778 if (array_resize(self, Py_SIZE(self) +
1779 needed - slicelength) < 0)
1780 return -1;
1781 }
1782 else if (slicelength < needed) {
1783 if (array_resize(self, Py_SIZE(self) +
1784 needed - slicelength) < 0)
1785 return -1;
1786 memmove(self->ob_item + (start + needed) * itemsize,
1787 self->ob_item + stop * itemsize,
1788 (Py_SIZE(self) - start - needed) * itemsize);
1789 }
1790 if (needed > 0)
1791 memcpy(self->ob_item + start * itemsize,
1792 other->ob_item, needed * itemsize);
1793 return 0;
1794 }
1795 else if (needed == 0) {
1796 /* Delete slice */
1797 size_t cur;
1798 Py_ssize_t i;
Thomas Wouters3ccec682007-08-28 15:28:19 +00001799
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001800 if (step < 0) {
1801 stop = start + 1;
1802 start = stop + step * (slicelength - 1) - 1;
1803 step = -step;
1804 }
1805 for (cur = start, i = 0; i < slicelength;
1806 cur += step, i++) {
1807 Py_ssize_t lim = step - 1;
Thomas Wouters3ccec682007-08-28 15:28:19 +00001808
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001809 if (cur + step >= (size_t)Py_SIZE(self))
1810 lim = Py_SIZE(self) - cur - 1;
1811 memmove(self->ob_item + (cur - i) * itemsize,
1812 self->ob_item + (cur + 1) * itemsize,
1813 lim * itemsize);
1814 }
1815 cur = start + slicelength * step;
1816 if (cur < (size_t)Py_SIZE(self)) {
1817 memmove(self->ob_item + (cur-slicelength) * itemsize,
1818 self->ob_item + cur * itemsize,
1819 (Py_SIZE(self) - cur) * itemsize);
1820 }
1821 if (array_resize(self, Py_SIZE(self) - slicelength) < 0)
1822 return -1;
1823 return 0;
1824 }
1825 else {
1826 Py_ssize_t cur, i;
1827
1828 if (needed != slicelength) {
1829 PyErr_Format(PyExc_ValueError,
1830 "attempt to assign array of size %zd "
1831 "to extended slice of size %zd",
1832 needed, slicelength);
1833 return -1;
1834 }
1835 for (cur = start, i = 0; i < slicelength;
1836 cur += step, i++) {
1837 memcpy(self->ob_item + cur * itemsize,
1838 other->ob_item + i * itemsize,
1839 itemsize);
1840 }
1841 return 0;
1842 }
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001843}
1844
1845static PyMappingMethods array_as_mapping = {
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001846 (lenfunc)array_length,
1847 (binaryfunc)array_subscr,
1848 (objobjargproc)array_ass_subscr
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001849};
1850
Raymond Hettinger01a807d2007-04-02 22:54:21 +00001851static const void *emptybuf = "";
1852
Martin v. Löwis18e16552006-02-15 17:27:45 +00001853static Py_ssize_t
1854array_buffer_getreadbuf(arrayobject *self, Py_ssize_t index, const void **ptr)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001855{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001856 if ( index != 0 ) {
1857 PyErr_SetString(PyExc_SystemError,
1858 "Accessing non-existent array segment");
1859 return -1;
1860 }
1861 *ptr = (void *)self->ob_item;
1862 if (*ptr == NULL)
1863 *ptr = emptybuf;
1864 return Py_SIZE(self)*self->ob_descr->itemsize;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001865}
1866
Martin v. Löwis18e16552006-02-15 17:27:45 +00001867static Py_ssize_t
1868array_buffer_getwritebuf(arrayobject *self, Py_ssize_t index, const void **ptr)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001869{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001870 if ( index != 0 ) {
1871 PyErr_SetString(PyExc_SystemError,
1872 "Accessing non-existent array segment");
1873 return -1;
1874 }
1875 *ptr = (void *)self->ob_item;
1876 if (*ptr == NULL)
1877 *ptr = emptybuf;
1878 return Py_SIZE(self)*self->ob_descr->itemsize;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001879}
1880
Martin v. Löwis18e16552006-02-15 17:27:45 +00001881static Py_ssize_t
1882array_buffer_getsegcount(arrayobject *self, Py_ssize_t *lenp)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001883{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001884 if ( lenp )
1885 *lenp = Py_SIZE(self)*self->ob_descr->itemsize;
1886 return 1;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001887}
1888
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001889static PySequenceMethods array_as_sequence = {
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001890 (lenfunc)array_length, /*sq_length*/
1891 (binaryfunc)array_concat, /*sq_concat*/
1892 (ssizeargfunc)array_repeat, /*sq_repeat*/
1893 (ssizeargfunc)array_item, /*sq_item*/
1894 (ssizessizeargfunc)array_slice, /*sq_slice*/
1895 (ssizeobjargproc)array_ass_item, /*sq_ass_item*/
1896 (ssizessizeobjargproc)array_ass_slice, /*sq_ass_slice*/
1897 (objobjproc)array_contains, /*sq_contains*/
1898 (binaryfunc)array_inplace_concat, /*sq_inplace_concat*/
1899 (ssizeargfunc)array_inplace_repeat /*sq_inplace_repeat*/
Guido van Rossum778983b1993-02-19 15:55:02 +00001900};
1901
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001902static PyBufferProcs array_as_buffer = {
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001903 (readbufferproc)array_buffer_getreadbuf,
1904 (writebufferproc)array_buffer_getwritebuf,
1905 (segcountproc)array_buffer_getsegcount,
1906 NULL,
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001907};
1908
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001909static PyObject *
Martin v. Löwis99866332002-03-01 10:27:01 +00001910array_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
Guido van Rossum778983b1993-02-19 15:55:02 +00001911{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001912 char c;
1913 PyObject *initial = NULL, *it = NULL;
1914 struct arraydescr *descr;
Martin v. Löwis99866332002-03-01 10:27:01 +00001915
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001916 if (type == &Arraytype && !_PyArg_NoKeywords("array.array()", kwds))
1917 return NULL;
Martin v. Löwis99866332002-03-01 10:27:01 +00001918
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001919 if (!PyArg_ParseTuple(args, "c|O:array", &c, &initial))
1920 return NULL;
Raymond Hettinger84fc9aa2003-04-24 10:41:55 +00001921
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001922 if (!(initial == NULL || PyList_Check(initial)
1923 || PyString_Check(initial) || PyTuple_Check(initial)
1924 || (c == 'u' && PyUnicode_Check(initial)))) {
1925 it = PyObject_GetIter(initial);
1926 if (it == NULL)
1927 return NULL;
1928 /* We set initial to NULL so that the subsequent code
1929 will create an empty array of the appropriate type
1930 and afterwards we can use array_iter_extend to populate
1931 the array.
1932 */
1933 initial = NULL;
1934 }
1935 for (descr = descriptors; descr->typecode != '\0'; descr++) {
1936 if (descr->typecode == c) {
1937 PyObject *a;
1938 Py_ssize_t len;
Martin v. Löwis99866332002-03-01 10:27:01 +00001939
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001940 if (initial == NULL || !(PyList_Check(initial)
1941 || PyTuple_Check(initial)))
1942 len = 0;
1943 else
1944 len = PySequence_Size(initial);
Martin v. Löwis99866332002-03-01 10:27:01 +00001945
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001946 a = newarrayobject(type, len, descr);
1947 if (a == NULL)
1948 return NULL;
1949
1950 if (len > 0) {
1951 Py_ssize_t i;
1952 for (i = 0; i < len; i++) {
1953 PyObject *v =
1954 PySequence_GetItem(initial, i);
1955 if (v == NULL) {
1956 Py_DECREF(a);
1957 return NULL;
1958 }
1959 if (setarrayitem(a, i, v) != 0) {
1960 Py_DECREF(v);
1961 Py_DECREF(a);
1962 return NULL;
1963 }
1964 Py_DECREF(v);
1965 }
1966 } else if (initial != NULL && PyString_Check(initial)) {
1967 PyObject *t_initial, *v;
1968 t_initial = PyTuple_Pack(1, initial);
1969 if (t_initial == NULL) {
1970 Py_DECREF(a);
1971 return NULL;
1972 }
1973 v = array_fromstring((arrayobject *)a,
1974 t_initial);
1975 Py_DECREF(t_initial);
1976 if (v == NULL) {
1977 Py_DECREF(a);
1978 return NULL;
1979 }
1980 Py_DECREF(v);
Martin v. Löwis99866332002-03-01 10:27:01 +00001981#ifdef Py_USING_UNICODE
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001982 } else if (initial != NULL && PyUnicode_Check(initial)) {
1983 Py_ssize_t n = PyUnicode_GET_DATA_SIZE(initial);
1984 if (n > 0) {
1985 arrayobject *self = (arrayobject *)a;
1986 char *item = self->ob_item;
1987 item = (char *)PyMem_Realloc(item, n);
1988 if (item == NULL) {
1989 PyErr_NoMemory();
1990 Py_DECREF(a);
1991 return NULL;
1992 }
1993 self->ob_item = item;
1994 Py_SIZE(self) = n / sizeof(Py_UNICODE);
1995 memcpy(item, PyUnicode_AS_DATA(initial), n);
1996 self->allocated = Py_SIZE(self);
1997 }
Martin v. Löwis99866332002-03-01 10:27:01 +00001998#endif
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00001999 }
2000 if (it != NULL) {
2001 if (array_iter_extend((arrayobject *)a, it) == -1) {
2002 Py_DECREF(it);
2003 Py_DECREF(a);
2004 return NULL;
2005 }
2006 Py_DECREF(it);
2007 }
2008 return a;
2009 }
2010 }
2011 PyErr_SetString(PyExc_ValueError,
2012 "bad typecode (must be c, b, B, u, h, H, i, I, l, L, f or d)");
2013 return NULL;
Guido van Rossum778983b1993-02-19 15:55:02 +00002014}
2015
Guido van Rossum778983b1993-02-19 15:55:02 +00002016
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002017PyDoc_STRVAR(module_doc,
Martin v. Löwis99866332002-03-01 10:27:01 +00002018"This module defines an object type which can efficiently represent\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002019an array of basic values: characters, integers, floating point\n\
2020numbers. Arrays are sequence types and behave very much like lists,\n\
2021except that the type of objects stored in them is constrained. The\n\
2022type is specified at object creation time by using a type code, which\n\
2023is a single character. The following type codes are defined:\n\
2024\n\
2025 Type code C Type Minimum size in bytes \n\
2026 'c' character 1 \n\
2027 'b' signed integer 1 \n\
2028 'B' unsigned integer 1 \n\
Martin v. Löwis99866332002-03-01 10:27:01 +00002029 'u' Unicode character 2 \n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002030 'h' signed integer 2 \n\
2031 'H' unsigned integer 2 \n\
2032 'i' signed integer 2 \n\
2033 'I' unsigned integer 2 \n\
2034 'l' signed integer 4 \n\
2035 'L' unsigned integer 4 \n\
2036 'f' floating point 4 \n\
2037 'd' floating point 8 \n\
2038\n\
Martin v. Löwis99866332002-03-01 10:27:01 +00002039The constructor is:\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002040\n\
2041array(typecode [, initializer]) -- create a new array\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002042");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002043
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002044PyDoc_STRVAR(arraytype_doc,
Martin v. Löwis99866332002-03-01 10:27:01 +00002045"array(typecode [, initializer]) -> array\n\
2046\n\
2047Return a new array whose items are restricted by typecode, and\n\
Raymond Hettinger6ab78cd2004-08-29 07:50:43 +00002048initialized from the optional initializer value, which must be a list,\n\
2049string. or iterable over elements of the appropriate type.\n\
Martin v. Löwis99866332002-03-01 10:27:01 +00002050\n\
2051Arrays represent basic values and behave very much like lists, except\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002052the type of objects stored in them is constrained.\n\
2053\n\
2054Methods:\n\
2055\n\
2056append() -- append a new item to the end of the array\n\
2057buffer_info() -- return information giving the current memory info\n\
2058byteswap() -- byteswap all the items of the array\n\
Jesus Cea585ad8a2009-07-02 15:37:21 +00002059count() -- return number of occurrences of an object\n\
Raymond Hettinger49f9bd12004-03-14 05:43:59 +00002060extend() -- extend array by appending multiple elements from an iterable\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002061fromfile() -- read items from a file object\n\
2062fromlist() -- append items from the list\n\
2063fromstring() -- append items from the string\n\
Jesus Cea585ad8a2009-07-02 15:37:21 +00002064index() -- return index of first occurrence of an object\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002065insert() -- insert a new item into the array at a provided position\n\
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00002066pop() -- remove and return item (default last)\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002067read() -- DEPRECATED, use fromfile()\n\
Jesus Cea585ad8a2009-07-02 15:37:21 +00002068remove() -- remove first occurrence of an object\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002069reverse() -- reverse the order of the items in the array\n\
2070tofile() -- write all items to a file object\n\
2071tolist() -- return the array converted to an ordinary list\n\
2072tostring() -- return the array converted to a string\n\
2073write() -- DEPRECATED, use tofile()\n\
2074\n\
Martin v. Löwis99866332002-03-01 10:27:01 +00002075Attributes:\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002076\n\
2077typecode -- the typecode character used to create the array\n\
2078itemsize -- the length in bytes of one array item\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002079");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002080
Raymond Hettinger625812f2003-01-07 01:58:52 +00002081static PyObject *array_iter(arrayobject *ao);
2082
Tim Peters0c322792002-07-17 16:49:03 +00002083static PyTypeObject Arraytype = {
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00002084 PyVarObject_HEAD_INIT(NULL, 0)
2085 "array.array",
2086 sizeof(arrayobject),
2087 0,
2088 (destructor)array_dealloc, /* tp_dealloc */
2089 0, /* tp_print */
2090 0, /* tp_getattr */
2091 0, /* tp_setattr */
2092 0, /* tp_compare */
2093 (reprfunc)array_repr, /* tp_repr */
2094 0, /* tp_as_number*/
2095 &array_as_sequence, /* tp_as_sequence*/
2096 &array_as_mapping, /* tp_as_mapping*/
2097 0, /* tp_hash */
2098 0, /* tp_call */
2099 0, /* tp_str */
2100 PyObject_GenericGetAttr, /* tp_getattro */
2101 0, /* tp_setattro */
2102 &array_as_buffer, /* tp_as_buffer*/
2103 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_WEAKREFS, /* tp_flags */
2104 arraytype_doc, /* tp_doc */
2105 0, /* tp_traverse */
2106 0, /* tp_clear */
2107 array_richcompare, /* tp_richcompare */
2108 offsetof(arrayobject, weakreflist), /* tp_weaklistoffset */
2109 (getiterfunc)array_iter, /* tp_iter */
2110 0, /* tp_iternext */
2111 array_methods, /* tp_methods */
2112 0, /* tp_members */
2113 array_getsets, /* tp_getset */
2114 0, /* tp_base */
2115 0, /* tp_dict */
2116 0, /* tp_descr_get */
2117 0, /* tp_descr_set */
2118 0, /* tp_dictoffset */
2119 0, /* tp_init */
2120 PyType_GenericAlloc, /* tp_alloc */
2121 array_new, /* tp_new */
2122 PyObject_Del, /* tp_free */
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002123};
2124
Raymond Hettinger625812f2003-01-07 01:58:52 +00002125
2126/*********************** Array Iterator **************************/
2127
2128typedef struct {
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00002129 PyObject_HEAD
2130 Py_ssize_t index;
2131 arrayobject *ao;
2132 PyObject * (*getitem)(struct arrayobject *, Py_ssize_t);
Raymond Hettinger625812f2003-01-07 01:58:52 +00002133} arrayiterobject;
2134
2135static PyTypeObject PyArrayIter_Type;
2136
2137#define PyArrayIter_Check(op) PyObject_TypeCheck(op, &PyArrayIter_Type)
2138
2139static PyObject *
2140array_iter(arrayobject *ao)
2141{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00002142 arrayiterobject *it;
Raymond Hettinger625812f2003-01-07 01:58:52 +00002143
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00002144 if (!array_Check(ao)) {
2145 PyErr_BadInternalCall();
2146 return NULL;
2147 }
Raymond Hettinger625812f2003-01-07 01:58:52 +00002148
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00002149 it = PyObject_GC_New(arrayiterobject, &PyArrayIter_Type);
2150 if (it == NULL)
2151 return NULL;
Raymond Hettinger625812f2003-01-07 01:58:52 +00002152
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00002153 Py_INCREF(ao);
2154 it->ao = ao;
2155 it->index = 0;
2156 it->getitem = ao->ob_descr->getitem;
2157 PyObject_GC_Track(it);
2158 return (PyObject *)it;
Raymond Hettinger625812f2003-01-07 01:58:52 +00002159}
2160
2161static PyObject *
Raymond Hettinger625812f2003-01-07 01:58:52 +00002162arrayiter_next(arrayiterobject *it)
2163{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00002164 assert(PyArrayIter_Check(it));
2165 if (it->index < Py_SIZE(it->ao))
2166 return (*it->getitem)(it->ao, it->index++);
2167 return NULL;
Raymond Hettinger625812f2003-01-07 01:58:52 +00002168}
2169
2170static void
2171arrayiter_dealloc(arrayiterobject *it)
2172{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00002173 PyObject_GC_UnTrack(it);
2174 Py_XDECREF(it->ao);
2175 PyObject_GC_Del(it);
Raymond Hettinger625812f2003-01-07 01:58:52 +00002176}
2177
2178static int
2179arrayiter_traverse(arrayiterobject *it, visitproc visit, void *arg)
2180{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00002181 Py_VISIT(it->ao);
2182 return 0;
Raymond Hettinger625812f2003-01-07 01:58:52 +00002183}
2184
2185static PyTypeObject PyArrayIter_Type = {
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00002186 PyVarObject_HEAD_INIT(NULL, 0)
2187 "arrayiterator", /* tp_name */
2188 sizeof(arrayiterobject), /* tp_basicsize */
2189 0, /* tp_itemsize */
2190 /* methods */
2191 (destructor)arrayiter_dealloc, /* tp_dealloc */
2192 0, /* tp_print */
2193 0, /* tp_getattr */
2194 0, /* tp_setattr */
2195 0, /* tp_compare */
2196 0, /* tp_repr */
2197 0, /* tp_as_number */
2198 0, /* tp_as_sequence */
2199 0, /* tp_as_mapping */
2200 0, /* tp_hash */
2201 0, /* tp_call */
2202 0, /* tp_str */
2203 PyObject_GenericGetAttr, /* tp_getattro */
2204 0, /* tp_setattro */
2205 0, /* tp_as_buffer */
2206 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
2207 0, /* tp_doc */
2208 (traverseproc)arrayiter_traverse, /* tp_traverse */
2209 0, /* tp_clear */
2210 0, /* tp_richcompare */
2211 0, /* tp_weaklistoffset */
2212 PyObject_SelfIter, /* tp_iter */
2213 (iternextfunc)arrayiter_next, /* tp_iternext */
2214 0, /* tp_methods */
Raymond Hettinger625812f2003-01-07 01:58:52 +00002215};
2216
2217
2218/*********************** Install Module **************************/
2219
Martin v. Löwis99866332002-03-01 10:27:01 +00002220/* No functions in array module. */
2221static PyMethodDef a_methods[] = {
2222 {NULL, NULL, 0, NULL} /* Sentinel */
2223};
2224
2225
Mark Hammondfe51c6d2002-08-02 02:27:13 +00002226PyMODINIT_FUNC
Thomas Woutersf3f33dc2000-07-21 06:00:07 +00002227initarray(void)
Guido van Rossum778983b1993-02-19 15:55:02 +00002228{
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00002229 PyObject *m;
Fred Drake0d40ba42000-02-04 20:33:49 +00002230
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00002231 Arraytype.ob_type = &PyType_Type;
2232 PyArrayIter_Type.ob_type = &PyType_Type;
2233 m = Py_InitModule3("array", a_methods, module_doc);
2234 if (m == NULL)
2235 return;
Fred Drakef4e34842002-04-01 03:45:06 +00002236
Antoine Pitrouc7c96a92010-05-09 15:15:40 +00002237 Py_INCREF((PyObject *)&Arraytype);
2238 PyModule_AddObject(m, "ArrayType", (PyObject *)&Arraytype);
2239 Py_INCREF((PyObject *)&Arraytype);
2240 PyModule_AddObject(m, "array", (PyObject *)&Arraytype);
2241 /* No need to check the error here, the caller will do that */
Guido van Rossum778983b1993-02-19 15:55:02 +00002242}