blob: 403f646cfa354f70bb3e64d0e0621279fcbe2c88 [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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +000047 char *items;
48 size_t _new_size;
Raymond Hettinger6e2ee862004-03-14 04:37:50 +000049
Antoine Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +0000183 Py_UNICODE *p;
184 Py_ssize_t len;
Martin v. Löwis99866332002-03-01 10:27:01 +0000185
Antoine Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +0000398 {'u', sizeof(Py_UNICODE), u_getitem, u_setitem},
Martin v. Löwis99866332002-03-01 10:27:01 +0000399#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +0000418 arrayobject *op;
419 size_t nbytes;
Martin v. Löwis99866332002-03-01 10:27:01 +0000420
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000421 if (size < 0) {
422 PyErr_BadInternalCall();
423 return NULL;
424 }
Martin v. Löwis99866332002-03-01 10:27:01 +0000425
Antoine Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +0000518 va = (arrayobject *)v;
519 wa = (arrayobject *)w;
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000520
Antoine Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +0000794 PyObject *it, *v;
Raymond Hettinger49f9bd12004-03-14 05:43:59 +0000795
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000796 it = PyObject_GetIter(bb);
797 if (it == NULL)
798 return -1;
Raymond Hettinger49f9bd12004-03-14 05:43:59 +0000799
Antoine Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +0000817 Py_ssize_t size;
818 char *old_item;
Martin v. Löwis99866332002-03-01 10:27:01 +0000819
Antoine Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +0000868 char *items, *p;
869 Py_ssize_t size, i;
Martin v. Löwis99866332002-03-01 10:27:01 +0000870
Antoine Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +0000920 Py_ssize_t count = 0;
921 Py_ssize_t i;
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000922
Antoine Pitrouc83ea132010-05-09 14:46:46 +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\
Mark Dickinson3e4caeb2009-02-21 20:27:01 +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 Pitrouc83ea132010-05-09 14:46:46 +0000943 Py_ssize_t i;
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000944
Antoine Pitrouc83ea132010-05-09 14:46:46 +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\
Mark Dickinson3e4caeb2009-02-21 20:27:01 +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 Pitrouc83ea132010-05-09 14:46:46 +0000967 Py_ssize_t i;
968 int cmp;
Raymond Hettinger625812f2003-01-07 01:58:52 +0000969
Antoine Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +0000981 int i;
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000982
Antoine Pitrouc83ea132010-05-09 14:46:46 +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\
Mark Dickinson3e4caeb2009-02-21 20:27:01 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +00001070 PyObject* retval = NULL;
1071 retval = PyTuple_New(2);
1072 if (!retval)
1073 return NULL;
Fred Drake541dc3b2000-06-28 17:49:30 +00001074
Antoine Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +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 Pitrouc83ea132010-05-09 14:46:46 +00001105 char *p;
1106 Py_ssize_t i;
Fred Drakebf272981999-12-03 17:15:30 +00001107
Antoine Pitrouc83ea132010-05-09 14:46:46 +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 Hettinger36cd2bf2003-01-03 08:24:58 +00001160array_reverse(arrayobject *self, PyObject *unused)
Guido van Rossum778983b1993-02-19 15:55:02 +00001161{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001162 register Py_ssize_t itemsize = self->ob_descr->itemsize;
1163 register char *p, *q;
1164 /* little buffer to hold items while swapping */
1165 char tmp[256]; /* 8 is probably enough -- but why skimp */
1166 assert((size_t)itemsize <= sizeof(tmp));
Guido van Rossume77a7571993-11-03 15:01:26 +00001167
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001168 if (Py_SIZE(self) > 1) {
1169 for (p = self->ob_item,
1170 q = self->ob_item + (Py_SIZE(self) - 1)*itemsize;
1171 p < q;
1172 p += itemsize, q -= itemsize) {
1173 /* memory areas guaranteed disjoint, so memcpy
1174 * is safe (& memmove may be slower).
1175 */
1176 memcpy(tmp, p, itemsize);
1177 memcpy(p, q, itemsize);
1178 memcpy(q, tmp, itemsize);
1179 }
1180 }
Tim Petersbb307342000-09-10 05:22:54 +00001181
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001182 Py_INCREF(Py_None);
1183 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +00001184}
Guido van Rossume77a7571993-11-03 15:01:26 +00001185
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001186PyDoc_STRVAR(reverse_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001187"reverse()\n\
1188\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001189Reverse the order of the items in the array.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001190
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001191static PyObject *
Peter Schneider-Kamp9656abd2000-07-13 21:10:57 +00001192array_fromfile(arrayobject *self, PyObject *args)
Guido van Rossum778983b1993-02-19 15:55:02 +00001193{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001194 PyObject *f;
1195 Py_ssize_t n;
1196 FILE *fp;
1197 if (!PyArg_ParseTuple(args, "On:fromfile", &f, &n))
1198 return NULL;
1199 fp = PyFile_AsFile(f);
1200 if (fp == NULL) {
1201 PyErr_SetString(PyExc_TypeError, "arg1 must be open file");
1202 return NULL;
1203 }
1204 if (n > 0) {
1205 char *item = self->ob_item;
1206 Py_ssize_t itemsize = self->ob_descr->itemsize;
1207 size_t nread;
1208 Py_ssize_t newlength;
1209 size_t newbytes;
1210 /* Be careful here about overflow */
1211 if ((newlength = Py_SIZE(self) + n) <= 0 ||
1212 (newbytes = newlength * itemsize) / itemsize !=
1213 (size_t)newlength)
1214 goto nomem;
1215 PyMem_RESIZE(item, char, newbytes);
1216 if (item == NULL) {
1217 nomem:
1218 PyErr_NoMemory();
1219 return NULL;
1220 }
1221 self->ob_item = item;
1222 Py_SIZE(self) += n;
1223 self->allocated = Py_SIZE(self);
1224 nread = fread(item + (Py_SIZE(self) - n) * itemsize,
1225 itemsize, n, fp);
1226 if (nread < (size_t)n) {
1227 Py_SIZE(self) -= (n - nread);
1228 PyMem_RESIZE(item, char, Py_SIZE(self)*itemsize);
1229 self->ob_item = item;
1230 self->allocated = Py_SIZE(self);
1231 PyErr_SetString(PyExc_EOFError,
1232 "not enough items in file");
1233 return NULL;
1234 }
1235 }
1236 Py_INCREF(Py_None);
1237 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +00001238}
1239
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001240PyDoc_STRVAR(fromfile_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001241"fromfile(f, n)\n\
1242\n\
1243Read 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 +00001244array. Also called as read.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001245
1246
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001247static PyObject *
Georg Brandl1e7c3752008-03-25 08:37:23 +00001248array_fromfile_as_read(arrayobject *self, PyObject *args)
1249{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001250 if (PyErr_WarnPy3k("array.read() not supported in 3.x; "
1251 "use array.fromfile()", 1) < 0)
1252 return NULL;
1253 return array_fromfile(self, args);
Georg Brandl1e7c3752008-03-25 08:37:23 +00001254}
1255
1256
1257static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001258array_tofile(arrayobject *self, PyObject *f)
Guido van Rossum778983b1993-02-19 15:55:02 +00001259{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001260 FILE *fp;
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001261
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001262 fp = PyFile_AsFile(f);
1263 if (fp == NULL) {
1264 PyErr_SetString(PyExc_TypeError, "arg must be open file");
1265 return NULL;
1266 }
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;
1273 }
1274 }
1275 Py_INCREF(Py_None);
1276 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +00001277}
1278
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001279PyDoc_STRVAR(tofile_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001280"tofile(f)\n\
1281\n\
1282Write all items (as machine values) to the file object f. Also called as\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001283write.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001284
1285
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001286static PyObject *
Georg Brandl1e7c3752008-03-25 08:37:23 +00001287array_tofile_as_write(arrayobject *self, PyObject *f)
1288{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001289 if (PyErr_WarnPy3k("array.write() not supported in 3.x; "
1290 "use array.tofile()", 1) < 0)
1291 return NULL;
1292 return array_tofile(self, f);
Georg Brandl1e7c3752008-03-25 08:37:23 +00001293}
1294
1295
1296static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001297array_fromlist(arrayobject *self, PyObject *list)
Guido van Rossum778983b1993-02-19 15:55:02 +00001298{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001299 Py_ssize_t n;
1300 Py_ssize_t itemsize = self->ob_descr->itemsize;
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001301
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001302 if (!PyList_Check(list)) {
1303 PyErr_SetString(PyExc_TypeError, "arg must be list");
1304 return NULL;
1305 }
1306 n = PyList_Size(list);
1307 if (n > 0) {
1308 char *item = self->ob_item;
1309 Py_ssize_t i;
1310 PyMem_RESIZE(item, char, (Py_SIZE(self) + n) * itemsize);
1311 if (item == NULL) {
1312 PyErr_NoMemory();
1313 return NULL;
1314 }
1315 self->ob_item = item;
1316 Py_SIZE(self) += n;
1317 self->allocated = Py_SIZE(self);
1318 for (i = 0; i < n; i++) {
1319 PyObject *v = PyList_GetItem(list, i);
1320 if ((*self->ob_descr->setitem)(self,
1321 Py_SIZE(self) - n + i, v) != 0) {
1322 Py_SIZE(self) -= n;
1323 if (itemsize && (self->ob_size > PY_SSIZE_T_MAX / itemsize)) {
1324 return PyErr_NoMemory();
1325 }
1326 PyMem_RESIZE(item, char,
1327 Py_SIZE(self) * itemsize);
1328 self->ob_item = item;
1329 self->allocated = Py_SIZE(self);
1330 return NULL;
1331 }
1332 }
1333 }
1334 Py_INCREF(Py_None);
1335 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +00001336}
1337
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001338PyDoc_STRVAR(fromlist_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001339"fromlist(list)\n\
1340\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001341Append items to array from list.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001342
1343
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001344static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001345array_tolist(arrayobject *self, PyObject *unused)
Guido van Rossum778983b1993-02-19 15:55:02 +00001346{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001347 PyObject *list = PyList_New(Py_SIZE(self));
1348 Py_ssize_t i;
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001349
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001350 if (list == NULL)
1351 return NULL;
1352 for (i = 0; i < Py_SIZE(self); i++) {
1353 PyObject *v = getarrayitem((PyObject *)self, i);
1354 if (v == NULL) {
1355 Py_DECREF(list);
1356 return NULL;
1357 }
1358 PyList_SetItem(list, i, v);
1359 }
1360 return list;
Guido van Rossum778983b1993-02-19 15:55:02 +00001361}
1362
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001363PyDoc_STRVAR(tolist_doc,
Guido van Rossumfc6aba51998-10-14 02:52:31 +00001364"tolist() -> list\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001365\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001366Convert array to an ordinary list with the same items.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001367
1368
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001369static PyObject *
Peter Schneider-Kamp9656abd2000-07-13 21:10:57 +00001370array_fromstring(arrayobject *self, PyObject *args)
Guido van Rossum778983b1993-02-19 15:55:02 +00001371{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001372 char *str;
1373 Py_ssize_t n;
1374 int itemsize = self->ob_descr->itemsize;
1375 if (!PyArg_ParseTuple(args, "s#:fromstring", &str, &n))
1376 return NULL;
1377 if (n % itemsize != 0) {
1378 PyErr_SetString(PyExc_ValueError,
1379 "string length not a multiple of item size");
1380 return NULL;
1381 }
1382 n = n / itemsize;
1383 if (n > 0) {
1384 char *item = self->ob_item;
1385 if ((n > PY_SSIZE_T_MAX - Py_SIZE(self)) ||
1386 ((Py_SIZE(self) + n) > PY_SSIZE_T_MAX / itemsize)) {
1387 return PyErr_NoMemory();
1388 }
1389 PyMem_RESIZE(item, char, (Py_SIZE(self) + n) * itemsize);
1390 if (item == NULL) {
1391 PyErr_NoMemory();
1392 return NULL;
1393 }
1394 self->ob_item = item;
1395 Py_SIZE(self) += n;
1396 self->allocated = Py_SIZE(self);
1397 memcpy(item + (Py_SIZE(self) - n) * itemsize,
1398 str, itemsize*n);
1399 }
1400 Py_INCREF(Py_None);
1401 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +00001402}
1403
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001404PyDoc_STRVAR(fromstring_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001405"fromstring(string)\n\
1406\n\
1407Appends items from the string, interpreting it as an array of machine\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001408values,as if it had been read from a file using the fromfile() method).");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001409
1410
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001411static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001412array_tostring(arrayobject *self, PyObject *unused)
Guido van Rossum778983b1993-02-19 15:55:02 +00001413{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001414 if (self->ob_size <= PY_SSIZE_T_MAX / self->ob_descr->itemsize) {
1415 return PyString_FromStringAndSize(self->ob_item,
1416 Py_SIZE(self) * self->ob_descr->itemsize);
1417 } else {
1418 return PyErr_NoMemory();
1419 }
Guido van Rossum778983b1993-02-19 15:55:02 +00001420}
1421
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001422PyDoc_STRVAR(tostring_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001423"tostring() -> string\n\
1424\n\
1425Convert the array to an array of machine values and return the string\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001426representation.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001427
Martin v. Löwis99866332002-03-01 10:27:01 +00001428
1429
1430#ifdef Py_USING_UNICODE
1431static PyObject *
1432array_fromunicode(arrayobject *self, PyObject *args)
1433{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001434 Py_UNICODE *ustr;
1435 Py_ssize_t n;
Martin v. Löwis99866332002-03-01 10:27:01 +00001436
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001437 if (!PyArg_ParseTuple(args, "u#:fromunicode", &ustr, &n))
1438 return NULL;
1439 if (self->ob_descr->typecode != 'u') {
1440 PyErr_SetString(PyExc_ValueError,
1441 "fromunicode() may only be called on "
1442 "type 'u' arrays");
1443 return NULL;
1444 }
1445 if (n > 0) {
1446 Py_UNICODE *item = (Py_UNICODE *) self->ob_item;
1447 if (Py_SIZE(self) > PY_SSIZE_T_MAX - n) {
1448 return PyErr_NoMemory();
1449 }
1450 PyMem_RESIZE(item, Py_UNICODE, Py_SIZE(self) + n);
1451 if (item == NULL) {
1452 PyErr_NoMemory();
1453 return NULL;
1454 }
1455 self->ob_item = (char *) item;
1456 Py_SIZE(self) += n;
1457 self->allocated = Py_SIZE(self);
1458 memcpy(item + Py_SIZE(self) - n,
1459 ustr, n * sizeof(Py_UNICODE));
1460 }
Martin v. Löwis99866332002-03-01 10:27:01 +00001461
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001462 Py_INCREF(Py_None);
1463 return Py_None;
Martin v. Löwis99866332002-03-01 10:27:01 +00001464}
1465
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001466PyDoc_STRVAR(fromunicode_doc,
Martin v. Löwis99866332002-03-01 10:27:01 +00001467"fromunicode(ustr)\n\
1468\n\
1469Extends this array with data from the unicode string ustr.\n\
1470The array must be a type 'u' array; otherwise a ValueError\n\
1471is raised. Use array.fromstring(ustr.decode(...)) to\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001472append Unicode data to an array of some other type.");
Martin v. Löwis99866332002-03-01 10:27:01 +00001473
1474
1475static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001476array_tounicode(arrayobject *self, PyObject *unused)
Martin v. Löwis99866332002-03-01 10:27:01 +00001477{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001478 if (self->ob_descr->typecode != 'u') {
1479 PyErr_SetString(PyExc_ValueError,
1480 "tounicode() may only be called on type 'u' arrays");
1481 return NULL;
1482 }
1483 return PyUnicode_FromUnicode((Py_UNICODE *) self->ob_item, Py_SIZE(self));
Martin v. Löwis99866332002-03-01 10:27:01 +00001484}
1485
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001486PyDoc_STRVAR(tounicode_doc,
Martin v. Löwis99866332002-03-01 10:27:01 +00001487"tounicode() -> unicode\n\
1488\n\
1489Convert the array to a unicode string. The array must be\n\
1490a type 'u' array; otherwise a ValueError is raised. Use\n\
1491array.tostring().decode() to obtain a unicode string from\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001492an array of some other type.");
Martin v. Löwis99866332002-03-01 10:27:01 +00001493
1494#endif /* Py_USING_UNICODE */
1495
Alexandre Vassalotti999ecc02009-07-15 18:19:47 +00001496static PyObject *
1497array_reduce(arrayobject *array)
1498{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001499 PyObject *dict, *result, *list;
Alexandre Vassalotti999ecc02009-07-15 18:19:47 +00001500
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001501 dict = PyObject_GetAttrString((PyObject *)array, "__dict__");
1502 if (dict == NULL) {
1503 if (!PyErr_ExceptionMatches(PyExc_AttributeError))
1504 return NULL;
1505 PyErr_Clear();
1506 dict = Py_None;
1507 Py_INCREF(dict);
1508 }
1509 /* Unlike in Python 3.x, we never use the more efficient memory
1510 * representation of an array for pickling. This is unfortunately
1511 * necessary to allow array objects to be unpickled by Python 3.x,
1512 * since str objects from 2.x are always decoded to unicode in
1513 * Python 3.x.
1514 */
1515 list = array_tolist(array, NULL);
1516 if (list == NULL) {
1517 Py_DECREF(dict);
1518 return NULL;
1519 }
1520 result = Py_BuildValue(
1521 "O(cO)O", Py_TYPE(array), array->ob_descr->typecode, list, dict);
1522 Py_DECREF(list);
1523 Py_DECREF(dict);
1524 return result;
Alexandre Vassalotti999ecc02009-07-15 18:19:47 +00001525}
1526
1527PyDoc_STRVAR(reduce_doc, "Return state information for pickling.");
Martin v. Löwis99866332002-03-01 10:27:01 +00001528
1529static PyObject *
1530array_get_typecode(arrayobject *a, void *closure)
1531{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001532 char tc = a->ob_descr->typecode;
1533 return PyString_FromStringAndSize(&tc, 1);
Martin v. Löwis99866332002-03-01 10:27:01 +00001534}
1535
1536static PyObject *
1537array_get_itemsize(arrayobject *a, void *closure)
1538{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001539 return PyInt_FromLong((long)a->ob_descr->itemsize);
Martin v. Löwis99866332002-03-01 10:27:01 +00001540}
1541
1542static PyGetSetDef array_getsets [] = {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001543 {"typecode", (getter) array_get_typecode, NULL,
1544 "the typecode character used to create the array"},
1545 {"itemsize", (getter) array_get_itemsize, NULL,
1546 "the size, in bytes, of one array item"},
1547 {NULL}
Martin v. Löwis99866332002-03-01 10:27:01 +00001548};
1549
Martin v. Löwis111c1802008-06-13 07:47:47 +00001550static PyMethodDef array_methods[] = {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001551 {"append", (PyCFunction)array_append, METH_O,
1552 append_doc},
1553 {"buffer_info", (PyCFunction)array_buffer_info, METH_NOARGS,
1554 buffer_info_doc},
1555 {"byteswap", (PyCFunction)array_byteswap, METH_NOARGS,
1556 byteswap_doc},
1557 {"__copy__", (PyCFunction)array_copy, METH_NOARGS,
1558 copy_doc},
1559 {"count", (PyCFunction)array_count, METH_O,
1560 count_doc},
1561 {"__deepcopy__",(PyCFunction)array_copy, METH_O,
1562 copy_doc},
1563 {"extend", (PyCFunction)array_extend, METH_O,
1564 extend_doc},
1565 {"fromfile", (PyCFunction)array_fromfile, METH_VARARGS,
1566 fromfile_doc},
1567 {"fromlist", (PyCFunction)array_fromlist, METH_O,
1568 fromlist_doc},
1569 {"fromstring", (PyCFunction)array_fromstring, METH_VARARGS,
1570 fromstring_doc},
Martin v. Löwis99866332002-03-01 10:27:01 +00001571#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001572 {"fromunicode", (PyCFunction)array_fromunicode, METH_VARARGS,
1573 fromunicode_doc},
Martin v. Löwis99866332002-03-01 10:27:01 +00001574#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001575 {"index", (PyCFunction)array_index, METH_O,
1576 index_doc},
1577 {"insert", (PyCFunction)array_insert, METH_VARARGS,
1578 insert_doc},
1579 {"pop", (PyCFunction)array_pop, METH_VARARGS,
1580 pop_doc},
1581 {"read", (PyCFunction)array_fromfile_as_read, METH_VARARGS,
1582 fromfile_doc},
1583 {"__reduce__", (PyCFunction)array_reduce, METH_NOARGS,
1584 reduce_doc},
1585 {"remove", (PyCFunction)array_remove, METH_O,
1586 remove_doc},
1587 {"reverse", (PyCFunction)array_reverse, METH_NOARGS,
1588 reverse_doc},
1589/* {"sort", (PyCFunction)array_sort, METH_VARARGS,
1590 sort_doc},*/
1591 {"tofile", (PyCFunction)array_tofile, METH_O,
1592 tofile_doc},
1593 {"tolist", (PyCFunction)array_tolist, METH_NOARGS,
1594 tolist_doc},
1595 {"tostring", (PyCFunction)array_tostring, METH_NOARGS,
1596 tostring_doc},
Martin v. Löwis99866332002-03-01 10:27:01 +00001597#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001598 {"tounicode", (PyCFunction)array_tounicode, METH_NOARGS,
1599 tounicode_doc},
Martin v. Löwis99866332002-03-01 10:27:01 +00001600#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001601 {"write", (PyCFunction)array_tofile_as_write, METH_O,
1602 tofile_doc},
1603 {NULL, NULL} /* sentinel */
Guido van Rossum778983b1993-02-19 15:55:02 +00001604};
1605
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001606static PyObject *
Peter Schneider-Kamp9656abd2000-07-13 21:10:57 +00001607array_repr(arrayobject *a)
Guido van Rossum778983b1993-02-19 15:55:02 +00001608{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001609 char buf[256], typecode;
1610 PyObject *s, *t, *v = NULL;
1611 Py_ssize_t len;
Martin v. Löwis99866332002-03-01 10:27:01 +00001612
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001613 len = Py_SIZE(a);
1614 typecode = a->ob_descr->typecode;
1615 if (len == 0) {
1616 PyOS_snprintf(buf, sizeof(buf), "array('%c')", typecode);
1617 return PyString_FromString(buf);
1618 }
1619
1620 if (typecode == 'c')
1621 v = array_tostring(a, NULL);
Michael W. Hudson1755ad92002-05-13 10:14:59 +00001622#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001623 else if (typecode == 'u')
1624 v = array_tounicode(a, NULL);
Michael W. Hudson1755ad92002-05-13 10:14:59 +00001625#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001626 else
1627 v = array_tolist(a, NULL);
1628 t = PyObject_Repr(v);
1629 Py_XDECREF(v);
Raymond Hettinger88ba1e32003-04-23 17:27:00 +00001630
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001631 PyOS_snprintf(buf, sizeof(buf), "array('%c', ", typecode);
1632 s = PyString_FromString(buf);
1633 PyString_ConcatAndDel(&s, t);
1634 PyString_ConcatAndDel(&s, PyString_FromString(")"));
1635 return s;
Guido van Rossum778983b1993-02-19 15:55:02 +00001636}
1637
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001638static PyObject*
1639array_subscr(arrayobject* self, PyObject* item)
1640{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001641 if (PyIndex_Check(item)) {
1642 Py_ssize_t i = PyNumber_AsSsize_t(item, PyExc_IndexError);
1643 if (i==-1 && PyErr_Occurred()) {
1644 return NULL;
1645 }
1646 if (i < 0)
1647 i += Py_SIZE(self);
1648 return array_item(self, i);
1649 }
1650 else if (PySlice_Check(item)) {
1651 Py_ssize_t start, stop, step, slicelength, cur, i;
1652 PyObject* result;
1653 arrayobject* ar;
1654 int itemsize = self->ob_descr->itemsize;
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001655
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001656 if (PySlice_GetIndicesEx((PySliceObject*)item, Py_SIZE(self),
1657 &start, &stop, &step, &slicelength) < 0) {
1658 return NULL;
1659 }
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001660
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001661 if (slicelength <= 0) {
1662 return newarrayobject(&Arraytype, 0, self->ob_descr);
1663 }
1664 else if (step == 1) {
1665 PyObject *result = newarrayobject(&Arraytype,
1666 slicelength, self->ob_descr);
1667 if (result == NULL)
1668 return NULL;
1669 memcpy(((arrayobject *)result)->ob_item,
1670 self->ob_item + start * itemsize,
1671 slicelength * itemsize);
1672 return result;
1673 }
1674 else {
1675 result = newarrayobject(&Arraytype, slicelength, self->ob_descr);
1676 if (!result) return NULL;
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001677
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001678 ar = (arrayobject*)result;
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001679
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001680 for (cur = start, i = 0; i < slicelength;
1681 cur += step, i++) {
1682 memcpy(ar->ob_item + i*itemsize,
1683 self->ob_item + cur*itemsize,
1684 itemsize);
1685 }
1686
1687 return result;
1688 }
1689 }
1690 else {
1691 PyErr_SetString(PyExc_TypeError,
1692 "array indices must be integers");
1693 return NULL;
1694 }
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001695}
1696
1697static int
1698array_ass_subscr(arrayobject* self, PyObject* item, PyObject* value)
1699{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001700 Py_ssize_t start, stop, step, slicelength, needed;
1701 arrayobject* other;
1702 int itemsize;
Thomas Wouters3ccec682007-08-28 15:28:19 +00001703
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001704 if (PyIndex_Check(item)) {
1705 Py_ssize_t i = PyNumber_AsSsize_t(item, PyExc_IndexError);
Mark Dickinson36ecd672010-01-29 17:11:39 +00001706
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001707 if (i == -1 && PyErr_Occurred())
1708 return -1;
1709 if (i < 0)
1710 i += Py_SIZE(self);
1711 if (i < 0 || i >= Py_SIZE(self)) {
1712 PyErr_SetString(PyExc_IndexError,
1713 "array assignment index out of range");
1714 return -1;
1715 }
1716 if (value == NULL) {
1717 /* Fall through to slice assignment */
1718 start = i;
1719 stop = i + 1;
1720 step = 1;
1721 slicelength = 1;
1722 }
1723 else
1724 return (*self->ob_descr->setitem)(self, i, value);
1725 }
1726 else if (PySlice_Check(item)) {
1727 if (PySlice_GetIndicesEx((PySliceObject *)item,
1728 Py_SIZE(self), &start, &stop,
1729 &step, &slicelength) < 0) {
1730 return -1;
1731 }
1732 }
1733 else {
1734 PyErr_SetString(PyExc_TypeError,
1735 "array indices must be integer");
1736 return -1;
1737 }
1738 if (value == NULL) {
1739 other = NULL;
1740 needed = 0;
1741 }
1742 else if (array_Check(value)) {
1743 other = (arrayobject *)value;
1744 needed = Py_SIZE(other);
1745 if (self == other) {
1746 /* Special case "self[i:j] = self" -- copy self first */
1747 int ret;
1748 value = array_slice(other, 0, needed);
1749 if (value == NULL)
1750 return -1;
1751 ret = array_ass_subscr(self, item, value);
1752 Py_DECREF(value);
1753 return ret;
1754 }
1755 if (other->ob_descr != self->ob_descr) {
1756 PyErr_BadArgument();
1757 return -1;
1758 }
1759 }
1760 else {
1761 PyErr_Format(PyExc_TypeError,
1762 "can only assign array (not \"%.200s\") to array slice",
1763 Py_TYPE(value)->tp_name);
1764 return -1;
1765 }
1766 itemsize = self->ob_descr->itemsize;
1767 /* for 'a[2:1] = ...', the insertion point is 'start', not 'stop' */
1768 if ((step > 0 && stop < start) ||
1769 (step < 0 && stop > start))
1770 stop = start;
1771 if (step == 1) {
1772 if (slicelength > needed) {
1773 memmove(self->ob_item + (start + needed) * itemsize,
1774 self->ob_item + stop * itemsize,
1775 (Py_SIZE(self) - stop) * itemsize);
1776 if (array_resize(self, Py_SIZE(self) +
1777 needed - slicelength) < 0)
1778 return -1;
1779 }
1780 else if (slicelength < needed) {
1781 if (array_resize(self, Py_SIZE(self) +
1782 needed - slicelength) < 0)
1783 return -1;
1784 memmove(self->ob_item + (start + needed) * itemsize,
1785 self->ob_item + stop * itemsize,
1786 (Py_SIZE(self) - start - needed) * itemsize);
1787 }
1788 if (needed > 0)
1789 memcpy(self->ob_item + start * itemsize,
1790 other->ob_item, needed * itemsize);
1791 return 0;
1792 }
1793 else if (needed == 0) {
1794 /* Delete slice */
1795 size_t cur;
1796 Py_ssize_t i;
Thomas Wouters3ccec682007-08-28 15:28:19 +00001797
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001798 if (step < 0) {
1799 stop = start + 1;
1800 start = stop + step * (slicelength - 1) - 1;
1801 step = -step;
1802 }
1803 for (cur = start, i = 0; i < slicelength;
1804 cur += step, i++) {
1805 Py_ssize_t lim = step - 1;
Thomas Wouters3ccec682007-08-28 15:28:19 +00001806
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001807 if (cur + step >= (size_t)Py_SIZE(self))
1808 lim = Py_SIZE(self) - cur - 1;
1809 memmove(self->ob_item + (cur - i) * itemsize,
1810 self->ob_item + (cur + 1) * itemsize,
1811 lim * itemsize);
1812 }
1813 cur = start + slicelength * step;
1814 if (cur < (size_t)Py_SIZE(self)) {
1815 memmove(self->ob_item + (cur-slicelength) * itemsize,
1816 self->ob_item + cur * itemsize,
1817 (Py_SIZE(self) - cur) * itemsize);
1818 }
1819 if (array_resize(self, Py_SIZE(self) - slicelength) < 0)
1820 return -1;
1821 return 0;
1822 }
1823 else {
1824 Py_ssize_t cur, i;
1825
1826 if (needed != slicelength) {
1827 PyErr_Format(PyExc_ValueError,
1828 "attempt to assign array of size %zd "
1829 "to extended slice of size %zd",
1830 needed, slicelength);
1831 return -1;
1832 }
1833 for (cur = start, i = 0; i < slicelength;
1834 cur += step, i++) {
1835 memcpy(self->ob_item + cur * itemsize,
1836 other->ob_item + i * itemsize,
1837 itemsize);
1838 }
1839 return 0;
1840 }
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001841}
1842
1843static PyMappingMethods array_as_mapping = {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001844 (lenfunc)array_length,
1845 (binaryfunc)array_subscr,
1846 (objobjargproc)array_ass_subscr
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001847};
1848
Raymond Hettinger01a807d2007-04-02 22:54:21 +00001849static const void *emptybuf = "";
1850
Martin v. Löwis18e16552006-02-15 17:27:45 +00001851static Py_ssize_t
1852array_buffer_getreadbuf(arrayobject *self, Py_ssize_t index, const void **ptr)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001853{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001854 if ( index != 0 ) {
1855 PyErr_SetString(PyExc_SystemError,
1856 "Accessing non-existent array segment");
1857 return -1;
1858 }
1859 *ptr = (void *)self->ob_item;
1860 if (*ptr == NULL)
1861 *ptr = emptybuf;
1862 return Py_SIZE(self)*self->ob_descr->itemsize;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001863}
1864
Martin v. Löwis18e16552006-02-15 17:27:45 +00001865static Py_ssize_t
1866array_buffer_getwritebuf(arrayobject *self, Py_ssize_t index, const void **ptr)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001867{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001868 if ( index != 0 ) {
1869 PyErr_SetString(PyExc_SystemError,
1870 "Accessing non-existent array segment");
1871 return -1;
1872 }
1873 *ptr = (void *)self->ob_item;
1874 if (*ptr == NULL)
1875 *ptr = emptybuf;
1876 return Py_SIZE(self)*self->ob_descr->itemsize;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001877}
1878
Martin v. Löwis18e16552006-02-15 17:27:45 +00001879static Py_ssize_t
1880array_buffer_getsegcount(arrayobject *self, Py_ssize_t *lenp)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001881{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001882 if ( lenp )
1883 *lenp = Py_SIZE(self)*self->ob_descr->itemsize;
1884 return 1;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001885}
1886
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001887static PySequenceMethods array_as_sequence = {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001888 (lenfunc)array_length, /*sq_length*/
1889 (binaryfunc)array_concat, /*sq_concat*/
1890 (ssizeargfunc)array_repeat, /*sq_repeat*/
1891 (ssizeargfunc)array_item, /*sq_item*/
1892 (ssizessizeargfunc)array_slice, /*sq_slice*/
1893 (ssizeobjargproc)array_ass_item, /*sq_ass_item*/
1894 (ssizessizeobjargproc)array_ass_slice, /*sq_ass_slice*/
1895 (objobjproc)array_contains, /*sq_contains*/
1896 (binaryfunc)array_inplace_concat, /*sq_inplace_concat*/
1897 (ssizeargfunc)array_inplace_repeat /*sq_inplace_repeat*/
Guido van Rossum778983b1993-02-19 15:55:02 +00001898};
1899
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001900static PyBufferProcs array_as_buffer = {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001901 (readbufferproc)array_buffer_getreadbuf,
1902 (writebufferproc)array_buffer_getwritebuf,
1903 (segcountproc)array_buffer_getsegcount,
1904 NULL,
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001905};
1906
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001907static PyObject *
Martin v. Löwis99866332002-03-01 10:27:01 +00001908array_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
Guido van Rossum778983b1993-02-19 15:55:02 +00001909{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001910 char c;
1911 PyObject *initial = NULL, *it = NULL;
1912 struct arraydescr *descr;
Martin v. Löwis99866332002-03-01 10:27:01 +00001913
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001914 if (type == &Arraytype && !_PyArg_NoKeywords("array.array()", kwds))
1915 return NULL;
Martin v. Löwis99866332002-03-01 10:27:01 +00001916
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001917 if (!PyArg_ParseTuple(args, "c|O:array", &c, &initial))
1918 return NULL;
Raymond Hettinger84fc9aa2003-04-24 10:41:55 +00001919
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001920 if (!(initial == NULL || PyList_Check(initial)
1921 || PyString_Check(initial) || PyTuple_Check(initial)
1922 || (c == 'u' && PyUnicode_Check(initial)))) {
1923 it = PyObject_GetIter(initial);
1924 if (it == NULL)
1925 return NULL;
1926 /* We set initial to NULL so that the subsequent code
1927 will create an empty array of the appropriate type
1928 and afterwards we can use array_iter_extend to populate
1929 the array.
1930 */
1931 initial = NULL;
1932 }
1933 for (descr = descriptors; descr->typecode != '\0'; descr++) {
1934 if (descr->typecode == c) {
1935 PyObject *a;
1936 Py_ssize_t len;
Martin v. Löwis99866332002-03-01 10:27:01 +00001937
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001938 if (initial == NULL || !(PyList_Check(initial)
1939 || PyTuple_Check(initial)))
1940 len = 0;
1941 else
1942 len = PySequence_Size(initial);
Martin v. Löwis99866332002-03-01 10:27:01 +00001943
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001944 a = newarrayobject(type, len, descr);
1945 if (a == NULL)
1946 return NULL;
1947
1948 if (len > 0) {
1949 Py_ssize_t i;
1950 for (i = 0; i < len; i++) {
1951 PyObject *v =
1952 PySequence_GetItem(initial, i);
1953 if (v == NULL) {
1954 Py_DECREF(a);
1955 return NULL;
1956 }
1957 if (setarrayitem(a, i, v) != 0) {
1958 Py_DECREF(v);
1959 Py_DECREF(a);
1960 return NULL;
1961 }
1962 Py_DECREF(v);
1963 }
1964 } else if (initial != NULL && PyString_Check(initial)) {
1965 PyObject *t_initial, *v;
1966 t_initial = PyTuple_Pack(1, initial);
1967 if (t_initial == NULL) {
1968 Py_DECREF(a);
1969 return NULL;
1970 }
1971 v = array_fromstring((arrayobject *)a,
1972 t_initial);
1973 Py_DECREF(t_initial);
1974 if (v == NULL) {
1975 Py_DECREF(a);
1976 return NULL;
1977 }
1978 Py_DECREF(v);
Martin v. Löwis99866332002-03-01 10:27:01 +00001979#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001980 } else if (initial != NULL && PyUnicode_Check(initial)) {
1981 Py_ssize_t n = PyUnicode_GET_DATA_SIZE(initial);
1982 if (n > 0) {
1983 arrayobject *self = (arrayobject *)a;
1984 char *item = self->ob_item;
1985 item = (char *)PyMem_Realloc(item, n);
1986 if (item == NULL) {
1987 PyErr_NoMemory();
1988 Py_DECREF(a);
1989 return NULL;
1990 }
1991 self->ob_item = item;
1992 Py_SIZE(self) = n / sizeof(Py_UNICODE);
1993 memcpy(item, PyUnicode_AS_DATA(initial), n);
1994 self->allocated = Py_SIZE(self);
1995 }
Martin v. Löwis99866332002-03-01 10:27:01 +00001996#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001997 }
1998 if (it != NULL) {
1999 if (array_iter_extend((arrayobject *)a, it) == -1) {
2000 Py_DECREF(it);
2001 Py_DECREF(a);
2002 return NULL;
2003 }
2004 Py_DECREF(it);
2005 }
2006 return a;
2007 }
2008 }
2009 PyErr_SetString(PyExc_ValueError,
2010 "bad typecode (must be c, b, B, u, h, H, i, I, l, L, f or d)");
2011 return NULL;
Guido van Rossum778983b1993-02-19 15:55:02 +00002012}
2013
Guido van Rossum778983b1993-02-19 15:55:02 +00002014
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002015PyDoc_STRVAR(module_doc,
Martin v. Löwis99866332002-03-01 10:27:01 +00002016"This module defines an object type which can efficiently represent\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002017an array of basic values: characters, integers, floating point\n\
2018numbers. Arrays are sequence types and behave very much like lists,\n\
2019except that the type of objects stored in them is constrained. The\n\
2020type is specified at object creation time by using a type code, which\n\
2021is a single character. The following type codes are defined:\n\
2022\n\
2023 Type code C Type Minimum size in bytes \n\
2024 'c' character 1 \n\
2025 'b' signed integer 1 \n\
2026 'B' unsigned integer 1 \n\
Martin v. Löwis99866332002-03-01 10:27:01 +00002027 'u' Unicode character 2 \n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002028 'h' signed integer 2 \n\
2029 'H' unsigned integer 2 \n\
2030 'i' signed integer 2 \n\
2031 'I' unsigned integer 2 \n\
2032 'l' signed integer 4 \n\
2033 'L' unsigned integer 4 \n\
2034 'f' floating point 4 \n\
2035 'd' floating point 8 \n\
2036\n\
Martin v. Löwis99866332002-03-01 10:27:01 +00002037The constructor is:\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002038\n\
2039array(typecode [, initializer]) -- create a new array\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002040");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002041
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002042PyDoc_STRVAR(arraytype_doc,
Martin v. Löwis99866332002-03-01 10:27:01 +00002043"array(typecode [, initializer]) -> array\n\
2044\n\
2045Return a new array whose items are restricted by typecode, and\n\
Raymond Hettinger6ab78cd2004-08-29 07:50:43 +00002046initialized from the optional initializer value, which must be a list,\n\
2047string. or iterable over elements of the appropriate type.\n\
Martin v. Löwis99866332002-03-01 10:27:01 +00002048\n\
2049Arrays represent basic values and behave very much like lists, except\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002050the type of objects stored in them is constrained.\n\
2051\n\
2052Methods:\n\
2053\n\
2054append() -- append a new item to the end of the array\n\
2055buffer_info() -- return information giving the current memory info\n\
2056byteswap() -- byteswap all the items of the array\n\
Mark Dickinson3e4caeb2009-02-21 20:27:01 +00002057count() -- return number of occurrences of an object\n\
Raymond Hettinger49f9bd12004-03-14 05:43:59 +00002058extend() -- extend array by appending multiple elements from an iterable\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002059fromfile() -- read items from a file object\n\
2060fromlist() -- append items from the list\n\
2061fromstring() -- append items from the string\n\
Mark Dickinson3e4caeb2009-02-21 20:27:01 +00002062index() -- return index of first occurrence of an object\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002063insert() -- insert a new item into the array at a provided position\n\
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00002064pop() -- remove and return item (default last)\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002065read() -- DEPRECATED, use fromfile()\n\
Mark Dickinson3e4caeb2009-02-21 20:27:01 +00002066remove() -- remove first occurrence of an object\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002067reverse() -- reverse the order of the items in the array\n\
2068tofile() -- write all items to a file object\n\
2069tolist() -- return the array converted to an ordinary list\n\
2070tostring() -- return the array converted to a string\n\
2071write() -- DEPRECATED, use tofile()\n\
2072\n\
Martin v. Löwis99866332002-03-01 10:27:01 +00002073Attributes:\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002074\n\
2075typecode -- the typecode character used to create the array\n\
2076itemsize -- the length in bytes of one array item\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002077");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002078
Raymond Hettinger625812f2003-01-07 01:58:52 +00002079static PyObject *array_iter(arrayobject *ao);
2080
Tim Peters0c322792002-07-17 16:49:03 +00002081static PyTypeObject Arraytype = {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002082 PyVarObject_HEAD_INIT(NULL, 0)
2083 "array.array",
2084 sizeof(arrayobject),
2085 0,
2086 (destructor)array_dealloc, /* tp_dealloc */
2087 0, /* tp_print */
2088 0, /* tp_getattr */
2089 0, /* tp_setattr */
2090 0, /* tp_compare */
2091 (reprfunc)array_repr, /* tp_repr */
2092 0, /* tp_as_number*/
2093 &array_as_sequence, /* tp_as_sequence*/
2094 &array_as_mapping, /* tp_as_mapping*/
2095 0, /* tp_hash */
2096 0, /* tp_call */
2097 0, /* tp_str */
2098 PyObject_GenericGetAttr, /* tp_getattro */
2099 0, /* tp_setattro */
2100 &array_as_buffer, /* tp_as_buffer*/
2101 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_WEAKREFS, /* tp_flags */
2102 arraytype_doc, /* tp_doc */
2103 0, /* tp_traverse */
2104 0, /* tp_clear */
2105 array_richcompare, /* tp_richcompare */
2106 offsetof(arrayobject, weakreflist), /* tp_weaklistoffset */
2107 (getiterfunc)array_iter, /* tp_iter */
2108 0, /* tp_iternext */
2109 array_methods, /* tp_methods */
2110 0, /* tp_members */
2111 array_getsets, /* tp_getset */
2112 0, /* tp_base */
2113 0, /* tp_dict */
2114 0, /* tp_descr_get */
2115 0, /* tp_descr_set */
2116 0, /* tp_dictoffset */
2117 0, /* tp_init */
2118 PyType_GenericAlloc, /* tp_alloc */
2119 array_new, /* tp_new */
2120 PyObject_Del, /* tp_free */
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002121};
2122
Raymond Hettinger625812f2003-01-07 01:58:52 +00002123
2124/*********************** Array Iterator **************************/
2125
2126typedef struct {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002127 PyObject_HEAD
2128 Py_ssize_t index;
2129 arrayobject *ao;
2130 PyObject * (*getitem)(struct arrayobject *, Py_ssize_t);
Raymond Hettinger625812f2003-01-07 01:58:52 +00002131} arrayiterobject;
2132
2133static PyTypeObject PyArrayIter_Type;
2134
2135#define PyArrayIter_Check(op) PyObject_TypeCheck(op, &PyArrayIter_Type)
2136
2137static PyObject *
2138array_iter(arrayobject *ao)
2139{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002140 arrayiterobject *it;
Raymond Hettinger625812f2003-01-07 01:58:52 +00002141
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002142 if (!array_Check(ao)) {
2143 PyErr_BadInternalCall();
2144 return NULL;
2145 }
Raymond Hettinger625812f2003-01-07 01:58:52 +00002146
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002147 it = PyObject_GC_New(arrayiterobject, &PyArrayIter_Type);
2148 if (it == NULL)
2149 return NULL;
Raymond Hettinger625812f2003-01-07 01:58:52 +00002150
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002151 Py_INCREF(ao);
2152 it->ao = ao;
2153 it->index = 0;
2154 it->getitem = ao->ob_descr->getitem;
2155 PyObject_GC_Track(it);
2156 return (PyObject *)it;
Raymond Hettinger625812f2003-01-07 01:58:52 +00002157}
2158
2159static PyObject *
Raymond Hettinger625812f2003-01-07 01:58:52 +00002160arrayiter_next(arrayiterobject *it)
2161{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002162 assert(PyArrayIter_Check(it));
2163 if (it->index < Py_SIZE(it->ao))
2164 return (*it->getitem)(it->ao, it->index++);
2165 return NULL;
Raymond Hettinger625812f2003-01-07 01:58:52 +00002166}
2167
2168static void
2169arrayiter_dealloc(arrayiterobject *it)
2170{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002171 PyObject_GC_UnTrack(it);
2172 Py_XDECREF(it->ao);
2173 PyObject_GC_Del(it);
Raymond Hettinger625812f2003-01-07 01:58:52 +00002174}
2175
2176static int
2177arrayiter_traverse(arrayiterobject *it, visitproc visit, void *arg)
2178{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002179 Py_VISIT(it->ao);
2180 return 0;
Raymond Hettinger625812f2003-01-07 01:58:52 +00002181}
2182
2183static PyTypeObject PyArrayIter_Type = {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002184 PyVarObject_HEAD_INIT(NULL, 0)
2185 "arrayiterator", /* tp_name */
2186 sizeof(arrayiterobject), /* tp_basicsize */
2187 0, /* tp_itemsize */
2188 /* methods */
2189 (destructor)arrayiter_dealloc, /* tp_dealloc */
2190 0, /* tp_print */
2191 0, /* tp_getattr */
2192 0, /* tp_setattr */
2193 0, /* tp_compare */
2194 0, /* tp_repr */
2195 0, /* tp_as_number */
2196 0, /* tp_as_sequence */
2197 0, /* tp_as_mapping */
2198 0, /* tp_hash */
2199 0, /* tp_call */
2200 0, /* tp_str */
2201 PyObject_GenericGetAttr, /* tp_getattro */
2202 0, /* tp_setattro */
2203 0, /* tp_as_buffer */
2204 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
2205 0, /* tp_doc */
2206 (traverseproc)arrayiter_traverse, /* tp_traverse */
2207 0, /* tp_clear */
2208 0, /* tp_richcompare */
2209 0, /* tp_weaklistoffset */
2210 PyObject_SelfIter, /* tp_iter */
2211 (iternextfunc)arrayiter_next, /* tp_iternext */
2212 0, /* tp_methods */
Raymond Hettinger625812f2003-01-07 01:58:52 +00002213};
2214
2215
2216/*********************** Install Module **************************/
2217
Martin v. Löwis99866332002-03-01 10:27:01 +00002218/* No functions in array module. */
2219static PyMethodDef a_methods[] = {
2220 {NULL, NULL, 0, NULL} /* Sentinel */
2221};
2222
2223
Mark Hammondfe51c6d2002-08-02 02:27:13 +00002224PyMODINIT_FUNC
Thomas Woutersf3f33dc2000-07-21 06:00:07 +00002225initarray(void)
Guido van Rossum778983b1993-02-19 15:55:02 +00002226{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002227 PyObject *m;
Fred Drake0d40ba42000-02-04 20:33:49 +00002228
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002229 Arraytype.ob_type = &PyType_Type;
2230 PyArrayIter_Type.ob_type = &PyType_Type;
2231 m = Py_InitModule3("array", a_methods, module_doc);
2232 if (m == NULL)
2233 return;
Fred Drakef4e34842002-04-01 03:45:06 +00002234
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002235 Py_INCREF((PyObject *)&Arraytype);
2236 PyModule_AddObject(m, "ArrayType", (PyObject *)&Arraytype);
2237 Py_INCREF((PyObject *)&Arraytype);
2238 PyModule_AddObject(m, "array", (PyObject *)&Arraytype);
2239 /* No need to check the error here, the caller will do that */
Guido van Rossum778983b1993-02-19 15:55:02 +00002240}