blob: e55c2d0c9c068c45132ea6905767004068b8649b [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 */
Thomas Wouters0e3f5912006-08-11 14:57:12 +000013#ifdef HAVE_SYS_TYPES_H
Guido van Rossumb6775db1994-08-01 11:34:53 +000014#include <sys/types.h> /* For size_t */
Thomas Wouters0e3f5912006-08-11 14:57:12 +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 {
25 int typecode;
26 int itemsize;
Martin v. Löwis18e16552006-02-15 17:27:45 +000027 PyObject * (*getitem)(struct arrayobject *, Py_ssize_t);
28 int (*setitem)(struct arrayobject *, Py_ssize_t, PyObject *);
Travis E. Oliphantb803c512007-08-20 07:16:33 +000029 char *formats;
Guido van Rossum778983b1993-02-19 15:55:02 +000030};
31
32typedef struct arrayobject {
Georg Brandl1b672672006-02-17 08:56:33 +000033 PyObject_VAR_HEAD
Guido van Rossum778983b1993-02-19 15:55:02 +000034 char *ob_item;
Martin v. Löwis18e16552006-02-15 17:27:45 +000035 Py_ssize_t allocated;
Guido van Rossum778983b1993-02-19 15:55:02 +000036 struct arraydescr *ob_descr;
Raymond Hettingercb87bc82004-05-31 00:35:52 +000037 PyObject *weakreflist; /* List of weak references */
Travis E. Oliphantb99f7622007-08-18 11:21:56 +000038 int ob_exports; /* Number of exported buffers */
Guido van Rossum778983b1993-02-19 15:55:02 +000039} arrayobject;
40
Jeremy Hylton938ace62002-07-17 16:30:39 +000041static PyTypeObject Arraytype;
Guido van Rossum778983b1993-02-19 15:55:02 +000042
Martin v. Löwis99866332002-03-01 10:27:01 +000043#define array_Check(op) PyObject_TypeCheck(op, &Arraytype)
Christian Heimes90aa7642007-12-19 02:45:37 +000044#define array_CheckExact(op) (Py_TYPE(op) == &Arraytype)
Guido van Rossum778983b1993-02-19 15:55:02 +000045
Raymond Hettinger6e2ee862004-03-14 04:37:50 +000046static int
Martin v. Löwis18e16552006-02-15 17:27:45 +000047array_resize(arrayobject *self, Py_ssize_t newsize)
Raymond Hettinger6e2ee862004-03-14 04:37:50 +000048{
49 char *items;
50 size_t _new_size;
51
Antoine Pitrou3ad3a0d2008-12-18 17:08:32 +000052 if (self->ob_exports > 0 && newsize != Py_SIZE(self)) {
53 PyErr_SetString(PyExc_BufferError,
54 "cannot resize an array that is exporting buffers");
55 return -1;
56 }
57
Raymond Hettinger6e2ee862004-03-14 04:37:50 +000058 /* Bypass realloc() when a previous overallocation is large enough
59 to accommodate the newsize. If the newsize is 16 smaller than the
Antoine Pitrou3ad3a0d2008-12-18 17:08:32 +000060 current size, then proceed with the realloc() to shrink the array.
Raymond Hettinger6e2ee862004-03-14 04:37:50 +000061 */
62
63 if (self->allocated >= newsize &&
Christian Heimes90aa7642007-12-19 02:45:37 +000064 Py_SIZE(self) < newsize + 16 &&
Raymond Hettinger6e2ee862004-03-14 04:37:50 +000065 self->ob_item != NULL) {
Christian Heimes90aa7642007-12-19 02:45:37 +000066 Py_SIZE(self) = newsize;
Raymond Hettinger6e2ee862004-03-14 04:37:50 +000067 return 0;
68 }
69
Antoine Pitrou3ad3a0d2008-12-18 17:08:32 +000070 if (newsize == 0) {
71 PyMem_FREE(self->ob_item);
72 self->ob_item = NULL;
73 Py_SIZE(self) = 0;
74 self->allocated = 0;
75 return 0;
76 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +000077
Raymond Hettinger6e2ee862004-03-14 04:37:50 +000078 /* This over-allocates proportional to the array size, making room
79 * for additional growth. The over-allocation is mild, but is
80 * enough to give linear-time amortized behavior over a long
81 * sequence of appends() in the presence of a poorly-performing
82 * system realloc().
83 * The growth pattern is: 0, 4, 8, 16, 25, 34, 46, 56, 67, 79, ...
84 * Note, the pattern starts out the same as for lists but then
85 * grows at a smaller rate so that larger arrays only overallocate
86 * by about 1/16th -- this is done because arrays are presumed to be more
87 * memory critical.
88 */
89
Christian Heimes90aa7642007-12-19 02:45:37 +000090 _new_size = (newsize >> 4) + (Py_SIZE(self) < 8 ? 3 : 7) + newsize;
Raymond Hettinger6e2ee862004-03-14 04:37:50 +000091 items = self->ob_item;
92 /* XXX The following multiplication and division does not optimize away
93 like it does for lists since the size is not known at compile time */
94 if (_new_size <= ((~(size_t)0) / self->ob_descr->itemsize))
95 PyMem_RESIZE(items, char, (_new_size * self->ob_descr->itemsize));
96 else
97 items = NULL;
98 if (items == NULL) {
99 PyErr_NoMemory();
100 return -1;
101 }
102 self->ob_item = items;
Christian Heimes90aa7642007-12-19 02:45:37 +0000103 Py_SIZE(self) = newsize;
Raymond Hettinger6e2ee862004-03-14 04:37:50 +0000104 self->allocated = _new_size;
105 return 0;
106}
107
Tim Petersbb307342000-09-10 05:22:54 +0000108/****************************************************************************
109Get and Set functions for each type.
110A Get function takes an arrayobject* and an integer index, returning the
111array value at that index wrapped in an appropriate PyObject*.
112A Set function takes an arrayobject, integer index, and PyObject*; sets
113the array value at that index to the raw C data extracted from the PyObject*,
114and returns 0 if successful, else nonzero on failure (PyObject* not of an
115appropriate type or value).
116Note that the basic Get and Set functions do NOT check that the index is
117in bounds; that's the responsibility of the caller.
118****************************************************************************/
Guido van Rossum778983b1993-02-19 15:55:02 +0000119
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000120static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000121b_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum778983b1993-02-19 15:55:02 +0000122{
123 long x = ((char *)ap->ob_item)[i];
124 if (x >= 128)
125 x -= 256;
Christian Heimes217cfd12007-12-02 14:31:20 +0000126 return PyLong_FromLong(x);
Guido van Rossum778983b1993-02-19 15:55:02 +0000127}
128
129static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000130b_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000131{
Fred Drake541dc3b2000-06-28 17:49:30 +0000132 short x;
133 /* PyArg_Parse's 'b' formatter is for an unsigned char, therefore
134 must use the next size up that is signed ('h') and manually do
135 the overflow checking */
136 if (!PyArg_Parse(v, "h;array item must be integer", &x))
Guido van Rossum778983b1993-02-19 15:55:02 +0000137 return -1;
Guido van Rossum9f754e02000-07-01 00:38:19 +0000138 else if (x < -128) {
Fred Drake541dc3b2000-06-28 17:49:30 +0000139 PyErr_SetString(PyExc_OverflowError,
140 "signed char is less than minimum");
141 return -1;
142 }
Guido van Rossum9f754e02000-07-01 00:38:19 +0000143 else if (x > 127) {
Fred Drake541dc3b2000-06-28 17:49:30 +0000144 PyErr_SetString(PyExc_OverflowError,
145 "signed char is greater than maximum");
146 return -1;
147 }
Guido van Rossum778983b1993-02-19 15:55:02 +0000148 if (i >= 0)
Fred Drake541dc3b2000-06-28 17:49:30 +0000149 ((char *)ap->ob_item)[i] = (char)x;
Guido van Rossum778983b1993-02-19 15:55:02 +0000150 return 0;
151}
152
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000153static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000154BB_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum549ab711997-01-03 19:09:47 +0000155{
156 long x = ((unsigned char *)ap->ob_item)[i];
Christian Heimes217cfd12007-12-02 14:31:20 +0000157 return PyLong_FromLong(x);
Guido van Rossum549ab711997-01-03 19:09:47 +0000158}
159
Fred Drake541dc3b2000-06-28 17:49:30 +0000160static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000161BB_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Fred Drake541dc3b2000-06-28 17:49:30 +0000162{
163 unsigned char x;
164 /* 'B' == unsigned char, maps to PyArg_Parse's 'b' formatter */
165 if (!PyArg_Parse(v, "b;array item must be integer", &x))
166 return -1;
167 if (i >= 0)
Martin v. Löwis99866332002-03-01 10:27:01 +0000168 ((char *)ap->ob_item)[i] = x;
Fred Drake541dc3b2000-06-28 17:49:30 +0000169 return 0;
170}
Guido van Rossum549ab711997-01-03 19:09:47 +0000171
Martin v. Löwis99866332002-03-01 10:27:01 +0000172static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000173u_getitem(arrayobject *ap, Py_ssize_t i)
Martin v. Löwis99866332002-03-01 10:27:01 +0000174{
175 return PyUnicode_FromUnicode(&((Py_UNICODE *) ap->ob_item)[i], 1);
176}
177
178static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000179u_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Martin v. Löwis99866332002-03-01 10:27:01 +0000180{
181 Py_UNICODE *p;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000182 Py_ssize_t len;
Martin v. Löwis99866332002-03-01 10:27:01 +0000183
184 if (!PyArg_Parse(v, "u#;array item must be unicode character", &p, &len))
185 return -1;
186 if (len != 1) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000187 PyErr_SetString(PyExc_TypeError,
188 "array item must be unicode character");
Martin v. Löwis99866332002-03-01 10:27:01 +0000189 return -1;
190 }
191 if (i >= 0)
192 ((Py_UNICODE *)ap->ob_item)[i] = p[0];
193 return 0;
194}
Martin v. Löwis99866332002-03-01 10:27:01 +0000195
Travis E. Oliphantd5c0add2007-10-12 22:05:15 +0000196
Guido van Rossum549ab711997-01-03 19:09:47 +0000197static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000198h_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum778983b1993-02-19 15:55:02 +0000199{
Christian Heimes217cfd12007-12-02 14:31:20 +0000200 return PyLong_FromLong((long) ((short *)ap->ob_item)[i]);
Guido van Rossum778983b1993-02-19 15:55:02 +0000201}
202
Travis E. Oliphantd5c0add2007-10-12 22:05:15 +0000203
Guido van Rossum778983b1993-02-19 15:55:02 +0000204static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000205h_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000206{
207 short x;
Fred Drake541dc3b2000-06-28 17:49:30 +0000208 /* 'h' == signed short, maps to PyArg_Parse's 'h' formatter */
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000209 if (!PyArg_Parse(v, "h;array item must be integer", &x))
Guido van Rossum778983b1993-02-19 15:55:02 +0000210 return -1;
211 if (i >= 0)
212 ((short *)ap->ob_item)[i] = x;
213 return 0;
214}
215
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000216static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000217HH_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum549ab711997-01-03 19:09:47 +0000218{
Christian Heimes217cfd12007-12-02 14:31:20 +0000219 return PyLong_FromLong((long) ((unsigned short *)ap->ob_item)[i]);
Guido van Rossum549ab711997-01-03 19:09:47 +0000220}
221
Fred Drake541dc3b2000-06-28 17:49:30 +0000222static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000223HH_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Fred Drake541dc3b2000-06-28 17:49:30 +0000224{
225 int x;
226 /* PyArg_Parse's 'h' formatter is for a signed short, therefore
227 must use the next size up and manually do the overflow checking */
228 if (!PyArg_Parse(v, "i;array item must be integer", &x))
229 return -1;
230 else if (x < 0) {
231 PyErr_SetString(PyExc_OverflowError,
232 "unsigned short is less than minimum");
233 return -1;
234 }
235 else if (x > USHRT_MAX) {
236 PyErr_SetString(PyExc_OverflowError,
237 "unsigned short is greater than maximum");
238 return -1;
239 }
240 if (i >= 0)
241 ((short *)ap->ob_item)[i] = (short)x;
242 return 0;
243}
Guido van Rossum549ab711997-01-03 19:09:47 +0000244
245static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000246i_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossume77a7571993-11-03 15:01:26 +0000247{
Christian Heimes217cfd12007-12-02 14:31:20 +0000248 return PyLong_FromLong((long) ((int *)ap->ob_item)[i]);
Guido van Rossume77a7571993-11-03 15:01:26 +0000249}
250
251static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000252i_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Guido van Rossume77a7571993-11-03 15:01:26 +0000253{
254 int x;
Fred Drake541dc3b2000-06-28 17:49:30 +0000255 /* 'i' == signed int, maps to PyArg_Parse's 'i' formatter */
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000256 if (!PyArg_Parse(v, "i;array item must be integer", &x))
Guido van Rossume77a7571993-11-03 15:01:26 +0000257 return -1;
258 if (i >= 0)
259 ((int *)ap->ob_item)[i] = x;
260 return 0;
261}
262
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000263static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000264II_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum549ab711997-01-03 19:09:47 +0000265{
266 return PyLong_FromUnsignedLong(
267 (unsigned long) ((unsigned int *)ap->ob_item)[i]);
268}
269
270static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000271II_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Guido van Rossum549ab711997-01-03 19:09:47 +0000272{
273 unsigned long x;
274 if (PyLong_Check(v)) {
275 x = PyLong_AsUnsignedLong(v);
276 if (x == (unsigned long) -1 && PyErr_Occurred())
277 return -1;
278 }
279 else {
Fred Drake541dc3b2000-06-28 17:49:30 +0000280 long y;
281 if (!PyArg_Parse(v, "l;array item must be integer", &y))
Guido van Rossum549ab711997-01-03 19:09:47 +0000282 return -1;
Fred Drake541dc3b2000-06-28 17:49:30 +0000283 if (y < 0) {
284 PyErr_SetString(PyExc_OverflowError,
285 "unsigned int is less than minimum");
286 return -1;
287 }
288 x = (unsigned long)y;
Tim Petersbb307342000-09-10 05:22:54 +0000289
Guido van Rossum549ab711997-01-03 19:09:47 +0000290 }
Fred Drake541dc3b2000-06-28 17:49:30 +0000291 if (x > UINT_MAX) {
292 PyErr_SetString(PyExc_OverflowError,
293 "unsigned int is greater than maximum");
294 return -1;
295 }
296
Guido van Rossum549ab711997-01-03 19:09:47 +0000297 if (i >= 0)
Fred Drake541dc3b2000-06-28 17:49:30 +0000298 ((unsigned int *)ap->ob_item)[i] = (unsigned int)x;
Guido van Rossum549ab711997-01-03 19:09:47 +0000299 return 0;
300}
301
302static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000303l_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum778983b1993-02-19 15:55:02 +0000304{
Christian Heimes217cfd12007-12-02 14:31:20 +0000305 return PyLong_FromLong(((long *)ap->ob_item)[i]);
Guido van Rossum778983b1993-02-19 15:55:02 +0000306}
307
308static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000309l_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000310{
311 long x;
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000312 if (!PyArg_Parse(v, "l;array item must be integer", &x))
Guido van Rossum778983b1993-02-19 15:55:02 +0000313 return -1;
314 if (i >= 0)
315 ((long *)ap->ob_item)[i] = x;
316 return 0;
317}
318
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000319static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000320LL_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum549ab711997-01-03 19:09:47 +0000321{
322 return PyLong_FromUnsignedLong(((unsigned long *)ap->ob_item)[i]);
323}
324
325static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000326LL_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Guido van Rossum549ab711997-01-03 19:09:47 +0000327{
328 unsigned long x;
329 if (PyLong_Check(v)) {
330 x = PyLong_AsUnsignedLong(v);
331 if (x == (unsigned long) -1 && PyErr_Occurred())
332 return -1;
333 }
334 else {
Fred Drake541dc3b2000-06-28 17:49:30 +0000335 long y;
336 if (!PyArg_Parse(v, "l;array item must be integer", &y))
Guido van Rossum549ab711997-01-03 19:09:47 +0000337 return -1;
Fred Drake541dc3b2000-06-28 17:49:30 +0000338 if (y < 0) {
339 PyErr_SetString(PyExc_OverflowError,
340 "unsigned long is less than minimum");
341 return -1;
342 }
343 x = (unsigned long)y;
Tim Petersbb307342000-09-10 05:22:54 +0000344
Guido van Rossum549ab711997-01-03 19:09:47 +0000345 }
Fred Drake541dc3b2000-06-28 17:49:30 +0000346 if (x > ULONG_MAX) {
347 PyErr_SetString(PyExc_OverflowError,
348 "unsigned long is greater than maximum");
349 return -1;
350 }
Tim Petersbb307342000-09-10 05:22:54 +0000351
Guido van Rossum549ab711997-01-03 19:09:47 +0000352 if (i >= 0)
353 ((unsigned long *)ap->ob_item)[i] = x;
354 return 0;
355}
356
357static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000358f_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum778983b1993-02-19 15:55:02 +0000359{
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000360 return PyFloat_FromDouble((double) ((float *)ap->ob_item)[i]);
Guido van Rossum778983b1993-02-19 15:55:02 +0000361}
362
363static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000364f_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000365{
366 float x;
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000367 if (!PyArg_Parse(v, "f;array item must be float", &x))
Guido van Rossum778983b1993-02-19 15:55:02 +0000368 return -1;
369 if (i >= 0)
370 ((float *)ap->ob_item)[i] = x;
371 return 0;
372}
373
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000374static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000375d_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum778983b1993-02-19 15:55:02 +0000376{
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000377 return PyFloat_FromDouble(((double *)ap->ob_item)[i]);
Guido van Rossum778983b1993-02-19 15:55:02 +0000378}
379
380static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000381d_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000382{
383 double x;
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000384 if (!PyArg_Parse(v, "d;array item must be float", &x))
Guido van Rossum778983b1993-02-19 15:55:02 +0000385 return -1;
386 if (i >= 0)
387 ((double *)ap->ob_item)[i] = x;
388 return 0;
389}
390
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000391
Guido van Rossum778983b1993-02-19 15:55:02 +0000392/* Description of types */
Guido van Rossum234f9421993-06-17 12:35:49 +0000393static struct arraydescr descriptors[] = {
Travis E. Oliphantd5c0add2007-10-12 22:05:15 +0000394 {'b', 1, b_getitem, b_setitem, "b"},
395 {'B', 1, BB_getitem, BB_setitem, "B"},
Travis E. Oliphantddacf962007-10-13 21:03:27 +0000396 {'u', sizeof(Py_UNICODE), u_getitem, u_setitem, "u"},
Travis E. Oliphantb803c512007-08-20 07:16:33 +0000397 {'h', sizeof(short), h_getitem, h_setitem, "h"},
398 {'H', sizeof(short), HH_getitem, HH_setitem, "H"},
399 {'i', sizeof(int), i_getitem, i_setitem, "i"},
400 {'I', sizeof(int), II_getitem, II_setitem, "I"},
401 {'l', sizeof(long), l_getitem, l_setitem, "l"},
402 {'L', sizeof(long), LL_getitem, LL_setitem, "L"},
403 {'f', sizeof(float), f_getitem, f_setitem, "f"},
404 {'d', sizeof(double), d_getitem, d_setitem, "d"},
405 {'\0', 0, 0, 0, 0} /* Sentinel */
Guido van Rossum778983b1993-02-19 15:55:02 +0000406};
Tim Petersbb307342000-09-10 05:22:54 +0000407
408/****************************************************************************
409Implementations of array object methods.
410****************************************************************************/
Guido van Rossum778983b1993-02-19 15:55:02 +0000411
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000412static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000413newarrayobject(PyTypeObject *type, Py_ssize_t size, struct arraydescr *descr)
Guido van Rossum778983b1993-02-19 15:55:02 +0000414{
Guido van Rossum778983b1993-02-19 15:55:02 +0000415 arrayobject *op;
Guido van Rossumb6775db1994-08-01 11:34:53 +0000416 size_t nbytes;
Martin v. Löwis99866332002-03-01 10:27:01 +0000417
Guido van Rossum778983b1993-02-19 15:55:02 +0000418 if (size < 0) {
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000419 PyErr_BadInternalCall();
Guido van Rossum778983b1993-02-19 15:55:02 +0000420 return NULL;
421 }
Martin v. Löwis99866332002-03-01 10:27:01 +0000422
Guido van Rossum778983b1993-02-19 15:55:02 +0000423 nbytes = size * descr->itemsize;
424 /* Check for overflow */
Guido van Rossum7844e381997-04-11 20:44:04 +0000425 if (nbytes / descr->itemsize != (size_t)size) {
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000426 return PyErr_NoMemory();
Guido van Rossum778983b1993-02-19 15:55:02 +0000427 }
Martin v. Löwis99866332002-03-01 10:27:01 +0000428 op = (arrayobject *) type->tp_alloc(type, 0);
Guido van Rossum778983b1993-02-19 15:55:02 +0000429 if (op == NULL) {
Martin v. Löwis99866332002-03-01 10:27:01 +0000430 return NULL;
Guido van Rossum778983b1993-02-19 15:55:02 +0000431 }
Amaury Forgeot d'Arc35c86582008-06-17 21:11:29 +0000432 op->ob_descr = descr;
433 op->allocated = size;
434 op->weakreflist = NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +0000435 Py_SIZE(op) = size;
Guido van Rossum778983b1993-02-19 15:55:02 +0000436 if (size <= 0) {
437 op->ob_item = NULL;
438 }
439 else {
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000440 op->ob_item = PyMem_NEW(char, nbytes);
Guido van Rossum778983b1993-02-19 15:55:02 +0000441 if (op->ob_item == NULL) {
Amaury Forgeot d'Arc35c86582008-06-17 21:11:29 +0000442 Py_DECREF(op);
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000443 return PyErr_NoMemory();
Guido van Rossum778983b1993-02-19 15:55:02 +0000444 }
445 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000446 op->ob_exports = 0;
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000447 return (PyObject *) op;
Guido van Rossum778983b1993-02-19 15:55:02 +0000448}
449
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000450static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000451getarrayitem(PyObject *op, Py_ssize_t i)
Guido van Rossum778983b1993-02-19 15:55:02 +0000452{
453 register arrayobject *ap;
Martin v. Löwis99866332002-03-01 10:27:01 +0000454 assert(array_Check(op));
Guido van Rossum778983b1993-02-19 15:55:02 +0000455 ap = (arrayobject *)op;
Christian Heimes90aa7642007-12-19 02:45:37 +0000456 assert(i>=0 && i<Py_SIZE(ap));
Guido van Rossum778983b1993-02-19 15:55:02 +0000457 return (*ap->ob_descr->getitem)(ap, i);
458}
459
460static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000461ins1(arrayobject *self, Py_ssize_t where, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000462{
Guido van Rossum778983b1993-02-19 15:55:02 +0000463 char *items;
Christian Heimes90aa7642007-12-19 02:45:37 +0000464 Py_ssize_t n = Py_SIZE(self);
Guido van Rossum778983b1993-02-19 15:55:02 +0000465 if (v == NULL) {
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000466 PyErr_BadInternalCall();
Guido van Rossum778983b1993-02-19 15:55:02 +0000467 return -1;
468 }
469 if ((*self->ob_descr->setitem)(self, -1, v) < 0)
470 return -1;
Raymond Hettinger6e2ee862004-03-14 04:37:50 +0000471
472 if (array_resize(self, n+1) == -1)
Guido van Rossum778983b1993-02-19 15:55:02 +0000473 return -1;
Raymond Hettinger6e2ee862004-03-14 04:37:50 +0000474 items = self->ob_item;
Walter Dörwald9e46abe2003-05-18 03:15:10 +0000475 if (where < 0) {
Raymond Hettinger6e2ee862004-03-14 04:37:50 +0000476 where += n;
Walter Dörwald9e46abe2003-05-18 03:15:10 +0000477 if (where < 0)
478 where = 0;
479 }
Raymond Hettinger6e2ee862004-03-14 04:37:50 +0000480 if (where > n)
481 where = n;
482 /* appends don't need to call memmove() */
483 if (where != n)
484 memmove(items + (where+1)*self->ob_descr->itemsize,
485 items + where*self->ob_descr->itemsize,
486 (n-where)*self->ob_descr->itemsize);
Guido van Rossum778983b1993-02-19 15:55:02 +0000487 return (*self->ob_descr->setitem)(self, where, v);
488}
489
Guido van Rossum778983b1993-02-19 15:55:02 +0000490/* Methods */
491
492static void
Peter Schneider-Kamp9656abd2000-07-13 21:10:57 +0000493array_dealloc(arrayobject *op)
Guido van Rossum778983b1993-02-19 15:55:02 +0000494{
Raymond Hettingercb87bc82004-05-31 00:35:52 +0000495 if (op->weakreflist != NULL)
496 PyObject_ClearWeakRefs((PyObject *) op);
Guido van Rossum778983b1993-02-19 15:55:02 +0000497 if (op->ob_item != NULL)
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000498 PyMem_DEL(op->ob_item);
Christian Heimes90aa7642007-12-19 02:45:37 +0000499 Py_TYPE(op)->tp_free((PyObject *)op);
Guido van Rossum778983b1993-02-19 15:55:02 +0000500}
501
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000502static PyObject *
503array_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossum778983b1993-02-19 15:55:02 +0000504{
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000505 arrayobject *va, *wa;
506 PyObject *vi = NULL;
507 PyObject *wi = NULL;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000508 Py_ssize_t i, k;
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000509 PyObject *res;
510
Martin v. Löwis99866332002-03-01 10:27:01 +0000511 if (!array_Check(v) || !array_Check(w)) {
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000512 Py_INCREF(Py_NotImplemented);
513 return Py_NotImplemented;
Guido van Rossum778983b1993-02-19 15:55:02 +0000514 }
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000515
516 va = (arrayobject *)v;
517 wa = (arrayobject *)w;
518
Christian Heimes90aa7642007-12-19 02:45:37 +0000519 if (Py_SIZE(va) != Py_SIZE(wa) && (op == Py_EQ || op == Py_NE)) {
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000520 /* Shortcut: if the lengths differ, the arrays differ */
521 if (op == Py_EQ)
522 res = Py_False;
523 else
524 res = Py_True;
525 Py_INCREF(res);
526 return res;
527 }
528
529 /* Search for the first index where items are different */
530 k = 1;
Christian Heimes90aa7642007-12-19 02:45:37 +0000531 for (i = 0; i < Py_SIZE(va) && i < Py_SIZE(wa); i++) {
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000532 vi = getarrayitem(v, i);
533 wi = getarrayitem(w, i);
534 if (vi == NULL || wi == NULL) {
535 Py_XDECREF(vi);
536 Py_XDECREF(wi);
537 return NULL;
538 }
539 k = PyObject_RichCompareBool(vi, wi, Py_EQ);
540 if (k == 0)
541 break; /* Keeping vi and wi alive! */
542 Py_DECREF(vi);
543 Py_DECREF(wi);
544 if (k < 0)
545 return NULL;
546 }
547
548 if (k) {
549 /* No more items to compare -- compare sizes */
Christian Heimes90aa7642007-12-19 02:45:37 +0000550 Py_ssize_t vs = Py_SIZE(va);
551 Py_ssize_t ws = Py_SIZE(wa);
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000552 int cmp;
553 switch (op) {
554 case Py_LT: cmp = vs < ws; break;
Guido van Rossum2b597e42001-01-25 22:12:43 +0000555 case Py_LE: cmp = vs <= ws; break;
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000556 case Py_EQ: cmp = vs == ws; break;
557 case Py_NE: cmp = vs != ws; break;
558 case Py_GT: cmp = vs > ws; break;
559 case Py_GE: cmp = vs >= ws; break;
560 default: return NULL; /* cannot happen */
561 }
562 if (cmp)
563 res = Py_True;
564 else
565 res = Py_False;
566 Py_INCREF(res);
567 return res;
568 }
569
570 /* We have an item that differs. First, shortcuts for EQ/NE */
571 if (op == Py_EQ) {
572 Py_INCREF(Py_False);
573 res = Py_False;
574 }
575 else if (op == Py_NE) {
576 Py_INCREF(Py_True);
577 res = Py_True;
578 }
579 else {
580 /* Compare the final item again using the proper operator */
581 res = PyObject_RichCompare(vi, wi, op);
582 }
583 Py_DECREF(vi);
584 Py_DECREF(wi);
585 return res;
Guido van Rossum778983b1993-02-19 15:55:02 +0000586}
587
Martin v. Löwis18e16552006-02-15 17:27:45 +0000588static Py_ssize_t
Peter Schneider-Kamp9656abd2000-07-13 21:10:57 +0000589array_length(arrayobject *a)
Guido van Rossum778983b1993-02-19 15:55:02 +0000590{
Christian Heimes90aa7642007-12-19 02:45:37 +0000591 return Py_SIZE(a);
Guido van Rossum778983b1993-02-19 15:55:02 +0000592}
593
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000594static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000595array_item(arrayobject *a, Py_ssize_t i)
Guido van Rossum778983b1993-02-19 15:55:02 +0000596{
Christian Heimes90aa7642007-12-19 02:45:37 +0000597 if (i < 0 || i >= Py_SIZE(a)) {
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000598 PyErr_SetString(PyExc_IndexError, "array index out of range");
Guido van Rossum778983b1993-02-19 15:55:02 +0000599 return NULL;
600 }
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000601 return getarrayitem((PyObject *)a, i);
Guido van Rossum778983b1993-02-19 15:55:02 +0000602}
603
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000604static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000605array_slice(arrayobject *a, Py_ssize_t ilow, Py_ssize_t ihigh)
Guido van Rossum778983b1993-02-19 15:55:02 +0000606{
607 arrayobject *np;
Guido van Rossum778983b1993-02-19 15:55:02 +0000608 if (ilow < 0)
609 ilow = 0;
Christian Heimes90aa7642007-12-19 02:45:37 +0000610 else if (ilow > Py_SIZE(a))
611 ilow = Py_SIZE(a);
Guido van Rossum778983b1993-02-19 15:55:02 +0000612 if (ihigh < 0)
613 ihigh = 0;
614 if (ihigh < ilow)
615 ihigh = ilow;
Christian Heimes90aa7642007-12-19 02:45:37 +0000616 else if (ihigh > Py_SIZE(a))
617 ihigh = Py_SIZE(a);
Martin v. Löwis99866332002-03-01 10:27:01 +0000618 np = (arrayobject *) newarrayobject(&Arraytype, ihigh - ilow, a->ob_descr);
Guido van Rossum778983b1993-02-19 15:55:02 +0000619 if (np == NULL)
620 return NULL;
621 memcpy(np->ob_item, a->ob_item + ilow * a->ob_descr->itemsize,
622 (ihigh-ilow) * a->ob_descr->itemsize);
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000623 return (PyObject *)np;
Guido van Rossum778983b1993-02-19 15:55:02 +0000624}
625
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000626static PyObject *
Raymond Hettinger3aa82c02004-03-13 18:18:51 +0000627array_copy(arrayobject *a, PyObject *unused)
628{
Christian Heimes90aa7642007-12-19 02:45:37 +0000629 return array_slice(a, 0, Py_SIZE(a));
Raymond Hettinger3aa82c02004-03-13 18:18:51 +0000630}
631
632PyDoc_STRVAR(copy_doc,
633"copy(array)\n\
634\n\
635 Return a copy of the array.");
636
637static PyObject *
Peter Schneider-Kamp9656abd2000-07-13 21:10:57 +0000638array_concat(arrayobject *a, PyObject *bb)
Guido van Rossum778983b1993-02-19 15:55:02 +0000639{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000640 Py_ssize_t size;
Guido van Rossum778983b1993-02-19 15:55:02 +0000641 arrayobject *np;
Martin v. Löwis99866332002-03-01 10:27:01 +0000642 if (!array_Check(bb)) {
Fred Drake137507e2000-06-01 02:02:46 +0000643 PyErr_Format(PyExc_TypeError,
644 "can only append array (not \"%.200s\") to array",
Christian Heimes90aa7642007-12-19 02:45:37 +0000645 Py_TYPE(bb)->tp_name);
Guido van Rossum778983b1993-02-19 15:55:02 +0000646 return NULL;
647 }
648#define b ((arrayobject *)bb)
649 if (a->ob_descr != b->ob_descr) {
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000650 PyErr_BadArgument();
Guido van Rossum778983b1993-02-19 15:55:02 +0000651 return NULL;
652 }
Amaury Forgeot d'Arc9c74b142008-06-18 00:47:36 +0000653 if (Py_SIZE(a) > PY_SSIZE_T_MAX - Py_SIZE(b)) {
654 return PyErr_NoMemory();
655 }
Christian Heimes90aa7642007-12-19 02:45:37 +0000656 size = Py_SIZE(a) + Py_SIZE(b);
Martin v. Löwis99866332002-03-01 10:27:01 +0000657 np = (arrayobject *) newarrayobject(&Arraytype, size, a->ob_descr);
Guido van Rossum778983b1993-02-19 15:55:02 +0000658 if (np == NULL) {
659 return NULL;
660 }
Christian Heimes90aa7642007-12-19 02:45:37 +0000661 memcpy(np->ob_item, a->ob_item, Py_SIZE(a)*a->ob_descr->itemsize);
662 memcpy(np->ob_item + Py_SIZE(a)*a->ob_descr->itemsize,
663 b->ob_item, Py_SIZE(b)*b->ob_descr->itemsize);
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000664 return (PyObject *)np;
Guido van Rossum778983b1993-02-19 15:55:02 +0000665#undef b
666}
667
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000668static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000669array_repeat(arrayobject *a, Py_ssize_t n)
Guido van Rossum778983b1993-02-19 15:55:02 +0000670{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000671 Py_ssize_t i;
672 Py_ssize_t size;
Guido van Rossum778983b1993-02-19 15:55:02 +0000673 arrayobject *np;
674 char *p;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000675 Py_ssize_t nbytes;
Guido van Rossum778983b1993-02-19 15:55:02 +0000676 if (n < 0)
677 n = 0;
Amaury Forgeot d'Arc9c74b142008-06-18 00:47:36 +0000678 if ((Py_SIZE(a) != 0) && (n > PY_SSIZE_T_MAX / Py_SIZE(a))) {
679 return PyErr_NoMemory();
680 }
Christian Heimes90aa7642007-12-19 02:45:37 +0000681 size = Py_SIZE(a) * n;
Martin v. Löwis99866332002-03-01 10:27:01 +0000682 np = (arrayobject *) newarrayobject(&Arraytype, size, a->ob_descr);
Guido van Rossum778983b1993-02-19 15:55:02 +0000683 if (np == NULL)
684 return NULL;
685 p = np->ob_item;
Christian Heimes90aa7642007-12-19 02:45:37 +0000686 nbytes = Py_SIZE(a) * a->ob_descr->itemsize;
Guido van Rossum778983b1993-02-19 15:55:02 +0000687 for (i = 0; i < n; i++) {
688 memcpy(p, a->ob_item, nbytes);
689 p += nbytes;
690 }
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000691 return (PyObject *) np;
Guido van Rossum778983b1993-02-19 15:55:02 +0000692}
693
694static int
Martin v. Löwisad0a4622006-02-16 14:30:23 +0000695array_ass_slice(arrayobject *a, Py_ssize_t ilow, Py_ssize_t ihigh, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000696{
697 char *item;
Martin v. Löwisad0a4622006-02-16 14:30:23 +0000698 Py_ssize_t n; /* Size of replacement array */
699 Py_ssize_t d; /* Change in size */
Guido van Rossum778983b1993-02-19 15:55:02 +0000700#define b ((arrayobject *)v)
701 if (v == NULL)
702 n = 0;
Martin v. Löwis99866332002-03-01 10:27:01 +0000703 else if (array_Check(v)) {
Christian Heimes90aa7642007-12-19 02:45:37 +0000704 n = Py_SIZE(b);
Guido van Rossum778983b1993-02-19 15:55:02 +0000705 if (a == b) {
706 /* Special case "a[i:j] = a" -- copy b first */
707 int ret;
708 v = array_slice(b, 0, n);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000709 if (!v)
710 return -1;
Guido van Rossum778983b1993-02-19 15:55:02 +0000711 ret = array_ass_slice(a, ilow, ihigh, v);
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000712 Py_DECREF(v);
Guido van Rossum778983b1993-02-19 15:55:02 +0000713 return ret;
714 }
715 if (b->ob_descr != a->ob_descr) {
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000716 PyErr_BadArgument();
Guido van Rossum778983b1993-02-19 15:55:02 +0000717 return -1;
718 }
719 }
720 else {
Fred Drake137507e2000-06-01 02:02:46 +0000721 PyErr_Format(PyExc_TypeError,
722 "can only assign array (not \"%.200s\") to array slice",
Christian Heimes90aa7642007-12-19 02:45:37 +0000723 Py_TYPE(v)->tp_name);
Guido van Rossum778983b1993-02-19 15:55:02 +0000724 return -1;
725 }
726 if (ilow < 0)
727 ilow = 0;
Christian Heimes90aa7642007-12-19 02:45:37 +0000728 else if (ilow > Py_SIZE(a))
729 ilow = Py_SIZE(a);
Guido van Rossum778983b1993-02-19 15:55:02 +0000730 if (ihigh < 0)
731 ihigh = 0;
732 if (ihigh < ilow)
733 ihigh = ilow;
Christian Heimes90aa7642007-12-19 02:45:37 +0000734 else if (ihigh > Py_SIZE(a))
735 ihigh = Py_SIZE(a);
Guido van Rossum778983b1993-02-19 15:55:02 +0000736 item = a->ob_item;
737 d = n - (ihigh-ilow);
738 if (d < 0) { /* Delete -d items */
739 memmove(item + (ihigh+d)*a->ob_descr->itemsize,
740 item + ihigh*a->ob_descr->itemsize,
Christian Heimes90aa7642007-12-19 02:45:37 +0000741 (Py_SIZE(a)-ihigh)*a->ob_descr->itemsize);
Antoine Pitrou3ad3a0d2008-12-18 17:08:32 +0000742 if (array_resize(a, Py_SIZE(a) + d) == -1)
743 return -1;
Guido van Rossum778983b1993-02-19 15:55:02 +0000744 }
745 else if (d > 0) { /* Insert d items */
Antoine Pitrou3ad3a0d2008-12-18 17:08:32 +0000746 if (array_resize(a, Py_SIZE(a) + d))
Guido van Rossum778983b1993-02-19 15:55:02 +0000747 return -1;
Guido van Rossum778983b1993-02-19 15:55:02 +0000748 memmove(item + (ihigh+d)*a->ob_descr->itemsize,
749 item + ihigh*a->ob_descr->itemsize,
Christian Heimes90aa7642007-12-19 02:45:37 +0000750 (Py_SIZE(a)-ihigh)*a->ob_descr->itemsize);
Guido van Rossum778983b1993-02-19 15:55:02 +0000751 }
752 if (n > 0)
753 memcpy(item + ilow*a->ob_descr->itemsize, b->ob_item,
754 n*b->ob_descr->itemsize);
755 return 0;
756#undef b
757}
758
759static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000760array_ass_item(arrayobject *a, Py_ssize_t i, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000761{
Christian Heimes90aa7642007-12-19 02:45:37 +0000762 if (i < 0 || i >= Py_SIZE(a)) {
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000763 PyErr_SetString(PyExc_IndexError,
764 "array assignment index out of range");
Guido van Rossum778983b1993-02-19 15:55:02 +0000765 return -1;
766 }
767 if (v == NULL)
768 return array_ass_slice(a, i, i+1, v);
769 return (*a->ob_descr->setitem)(a, i, v);
770}
771
772static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000773setarrayitem(PyObject *a, Py_ssize_t i, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000774{
Martin v. Löwis99866332002-03-01 10:27:01 +0000775 assert(array_Check(a));
Guido van Rossum778983b1993-02-19 15:55:02 +0000776 return array_ass_item((arrayobject *)a, i, v);
777}
778
Martin v. Löwis99866332002-03-01 10:27:01 +0000779static int
Raymond Hettinger49f9bd12004-03-14 05:43:59 +0000780array_iter_extend(arrayobject *self, PyObject *bb)
781{
782 PyObject *it, *v;
783
784 it = PyObject_GetIter(bb);
785 if (it == NULL)
786 return -1;
787
788 while ((v = PyIter_Next(it)) != NULL) {
Christian Heimes90aa7642007-12-19 02:45:37 +0000789 if (ins1(self, (int) Py_SIZE(self), v) != 0) {
Raymond Hettinger49f9bd12004-03-14 05:43:59 +0000790 Py_DECREF(v);
791 Py_DECREF(it);
792 return -1;
793 }
794 Py_DECREF(v);
795 }
796 Py_DECREF(it);
797 if (PyErr_Occurred())
798 return -1;
799 return 0;
800}
801
802static int
Martin v. Löwis99866332002-03-01 10:27:01 +0000803array_do_extend(arrayobject *self, PyObject *bb)
804{
Antoine Pitrou3ad3a0d2008-12-18 17:08:32 +0000805 Py_ssize_t size, oldsize;
Martin v. Löwis99866332002-03-01 10:27:01 +0000806
Raymond Hettinger49f9bd12004-03-14 05:43:59 +0000807 if (!array_Check(bb))
808 return array_iter_extend(self, bb);
Martin v. Löwis99866332002-03-01 10:27:01 +0000809#define b ((arrayobject *)bb)
810 if (self->ob_descr != b->ob_descr) {
811 PyErr_SetString(PyExc_TypeError,
812 "can only extend with array of same kind");
813 return -1;
814 }
Amaury Forgeot d'Arc35c86582008-06-17 21:11:29 +0000815 if ((Py_SIZE(self) > PY_SSIZE_T_MAX - Py_SIZE(b)) ||
816 ((Py_SIZE(self) + Py_SIZE(b)) > PY_SSIZE_T_MAX / self->ob_descr->itemsize)) {
817 PyErr_NoMemory();
818 return -1;
819 }
Antoine Pitrou3ad3a0d2008-12-18 17:08:32 +0000820 oldsize = Py_SIZE(self);
821 size = oldsize + Py_SIZE(b);
822 if (array_resize(self, size) == -1)
Martin v. Löwis99866332002-03-01 10:27:01 +0000823 return -1;
Antoine Pitrou3ad3a0d2008-12-18 17:08:32 +0000824 memcpy(self->ob_item + oldsize * self->ob_descr->itemsize,
825 b->ob_item, Py_SIZE(b) * b->ob_descr->itemsize);
Martin v. Löwis99866332002-03-01 10:27:01 +0000826
827 return 0;
828#undef b
829}
830
831static PyObject *
832array_inplace_concat(arrayobject *self, PyObject *bb)
833{
Raymond Hettinger49f9bd12004-03-14 05:43:59 +0000834 if (!array_Check(bb)) {
835 PyErr_Format(PyExc_TypeError,
836 "can only extend array with array (not \"%.200s\")",
Christian Heimes90aa7642007-12-19 02:45:37 +0000837 Py_TYPE(bb)->tp_name);
Raymond Hettinger49f9bd12004-03-14 05:43:59 +0000838 return NULL;
839 }
Martin v. Löwis99866332002-03-01 10:27:01 +0000840 if (array_do_extend(self, bb) == -1)
841 return NULL;
842 Py_INCREF(self);
843 return (PyObject *)self;
844}
845
846static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000847array_inplace_repeat(arrayobject *self, Py_ssize_t n)
Martin v. Löwis99866332002-03-01 10:27:01 +0000848{
849 char *items, *p;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000850 Py_ssize_t size, i;
Martin v. Löwis99866332002-03-01 10:27:01 +0000851
Christian Heimes90aa7642007-12-19 02:45:37 +0000852 if (Py_SIZE(self) > 0) {
Martin v. Löwis99866332002-03-01 10:27:01 +0000853 if (n < 0)
854 n = 0;
855 items = self->ob_item;
Amaury Forgeot d'Arc9c74b142008-06-18 00:47:36 +0000856 if ((self->ob_descr->itemsize != 0) &&
857 (Py_SIZE(self) > PY_SSIZE_T_MAX / self->ob_descr->itemsize)) {
858 return PyErr_NoMemory();
859 }
Christian Heimes90aa7642007-12-19 02:45:37 +0000860 size = Py_SIZE(self) * self->ob_descr->itemsize;
Antoine Pitrou3ad3a0d2008-12-18 17:08:32 +0000861 if (n > 0 && size > PY_SSIZE_T_MAX / n) {
862 return PyErr_NoMemory();
Martin v. Löwis99866332002-03-01 10:27:01 +0000863 }
Antoine Pitrou3ad3a0d2008-12-18 17:08:32 +0000864 if (array_resize(self, n * Py_SIZE(self)) == -1)
865 return NULL;
866 items = p = self->ob_item;
867 for (i = 1; i < n; i++) {
868 p += size;
869 memcpy(p, items, size);
Martin v. Löwis99866332002-03-01 10:27:01 +0000870 }
871 }
872 Py_INCREF(self);
873 return (PyObject *)self;
874}
875
876
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000877static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000878ins(arrayobject *self, Py_ssize_t where, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000879{
880 if (ins1(self, where, v) != 0)
881 return NULL;
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000882 Py_INCREF(Py_None);
883 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +0000884}
885
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000886static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000887array_count(arrayobject *self, PyObject *v)
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000888{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000889 Py_ssize_t count = 0;
890 Py_ssize_t i;
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000891
Christian Heimes90aa7642007-12-19 02:45:37 +0000892 for (i = 0; i < Py_SIZE(self); i++) {
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000893 PyObject *selfi = getarrayitem((PyObject *)self, i);
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000894 int cmp = PyObject_RichCompareBool(selfi, v, Py_EQ);
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000895 Py_DECREF(selfi);
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000896 if (cmp > 0)
897 count++;
898 else if (cmp < 0)
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000899 return NULL;
900 }
Christian Heimes217cfd12007-12-02 14:31:20 +0000901 return PyLong_FromSsize_t(count);
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000902}
903
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000904PyDoc_STRVAR(count_doc,
Tim Peters077a11d2000-09-16 22:31:29 +0000905"count(x)\n\
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000906\n\
Mark Dickinson934896d2009-02-21 20:59:32 +0000907Return number of occurrences of x in the array.");
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000908
909static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000910array_index(arrayobject *self, PyObject *v)
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000911{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000912 Py_ssize_t i;
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000913
Christian Heimes90aa7642007-12-19 02:45:37 +0000914 for (i = 0; i < Py_SIZE(self); i++) {
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000915 PyObject *selfi = getarrayitem((PyObject *)self, i);
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000916 int cmp = PyObject_RichCompareBool(selfi, v, Py_EQ);
917 Py_DECREF(selfi);
918 if (cmp > 0) {
Christian Heimes217cfd12007-12-02 14:31:20 +0000919 return PyLong_FromLong((long)i);
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000920 }
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000921 else if (cmp < 0)
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000922 return NULL;
923 }
924 PyErr_SetString(PyExc_ValueError, "array.index(x): x not in list");
925 return NULL;
926}
927
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000928PyDoc_STRVAR(index_doc,
Tim Peters077a11d2000-09-16 22:31:29 +0000929"index(x)\n\
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000930\n\
Mark Dickinson934896d2009-02-21 20:59:32 +0000931Return index of first occurrence of x in the array.");
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000932
Raymond Hettinger625812f2003-01-07 01:58:52 +0000933static int
934array_contains(arrayobject *self, PyObject *v)
935{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000936 Py_ssize_t i;
937 int cmp;
Raymond Hettinger625812f2003-01-07 01:58:52 +0000938
Christian Heimes90aa7642007-12-19 02:45:37 +0000939 for (i = 0, cmp = 0 ; cmp == 0 && i < Py_SIZE(self); i++) {
Raymond Hettinger625812f2003-01-07 01:58:52 +0000940 PyObject *selfi = getarrayitem((PyObject *)self, i);
941 cmp = PyObject_RichCompareBool(selfi, v, Py_EQ);
942 Py_DECREF(selfi);
943 }
944 return cmp;
945}
946
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000947static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000948array_remove(arrayobject *self, PyObject *v)
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000949{
950 int i;
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000951
Christian Heimes90aa7642007-12-19 02:45:37 +0000952 for (i = 0; i < Py_SIZE(self); i++) {
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000953 PyObject *selfi = getarrayitem((PyObject *)self,i);
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000954 int cmp = PyObject_RichCompareBool(selfi, v, Py_EQ);
955 Py_DECREF(selfi);
956 if (cmp > 0) {
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000957 if (array_ass_slice(self, i, i+1,
958 (PyObject *)NULL) != 0)
959 return NULL;
960 Py_INCREF(Py_None);
961 return Py_None;
962 }
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000963 else if (cmp < 0)
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000964 return NULL;
965 }
966 PyErr_SetString(PyExc_ValueError, "array.remove(x): x not in list");
967 return NULL;
968}
969
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000970PyDoc_STRVAR(remove_doc,
Tim Peters077a11d2000-09-16 22:31:29 +0000971"remove(x)\n\
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000972\n\
Mark Dickinson934896d2009-02-21 20:59:32 +0000973Remove the first occurrence of x in the array.");
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000974
975static PyObject *
976array_pop(arrayobject *self, PyObject *args)
977{
Martin v. Löwisad0a4622006-02-16 14:30:23 +0000978 Py_ssize_t i = -1;
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000979 PyObject *v;
Martin v. Löwisad0a4622006-02-16 14:30:23 +0000980 if (!PyArg_ParseTuple(args, "|n:pop", &i))
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000981 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +0000982 if (Py_SIZE(self) == 0) {
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000983 /* Special-case most common failure cause */
984 PyErr_SetString(PyExc_IndexError, "pop from empty array");
985 return NULL;
986 }
987 if (i < 0)
Christian Heimes90aa7642007-12-19 02:45:37 +0000988 i += Py_SIZE(self);
989 if (i < 0 || i >= Py_SIZE(self)) {
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000990 PyErr_SetString(PyExc_IndexError, "pop index out of range");
991 return NULL;
992 }
993 v = getarrayitem((PyObject *)self,i);
994 if (array_ass_slice(self, i, i+1, (PyObject *)NULL) != 0) {
995 Py_DECREF(v);
996 return NULL;
997 }
998 return v;
999}
1000
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001001PyDoc_STRVAR(pop_doc,
Tim Peters077a11d2000-09-16 22:31:29 +00001002"pop([i])\n\
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001003\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001004Return the i-th element and delete it from the array. i defaults to -1.");
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001005
1006static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001007array_extend(arrayobject *self, PyObject *bb)
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001008{
Martin v. Löwis99866332002-03-01 10:27:01 +00001009 if (array_do_extend(self, bb) == -1)
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001010 return NULL;
Martin v. Löwis99866332002-03-01 10:27:01 +00001011 Py_INCREF(Py_None);
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001012 return Py_None;
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001013}
1014
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001015PyDoc_STRVAR(extend_doc,
Raymond Hettinger49f9bd12004-03-14 05:43:59 +00001016"extend(array or iterable)\n\
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001017\n\
Raymond Hettinger49f9bd12004-03-14 05:43:59 +00001018 Append items to the end of the array.");
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001019
1020static PyObject *
Peter Schneider-Kamp9656abd2000-07-13 21:10:57 +00001021array_insert(arrayobject *self, PyObject *args)
Guido van Rossum778983b1993-02-19 15:55:02 +00001022{
Thomas Woutersb9eb5512006-02-27 19:44:56 +00001023 Py_ssize_t i;
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001024 PyObject *v;
Thomas Woutersb9eb5512006-02-27 19:44:56 +00001025 if (!PyArg_ParseTuple(args, "nO:insert", &i, &v))
Guido van Rossum778983b1993-02-19 15:55:02 +00001026 return NULL;
1027 return ins(self, i, v);
1028}
1029
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001030PyDoc_STRVAR(insert_doc,
Tim Peters077a11d2000-09-16 22:31:29 +00001031"insert(i,x)\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001032\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001033Insert a new item x into the array before position i.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001034
1035
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001036static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001037array_buffer_info(arrayobject *self, PyObject *unused)
Guido van Rossumde4a4ca1997-08-12 14:55:56 +00001038{
Tim Peters077a11d2000-09-16 22:31:29 +00001039 PyObject* retval = NULL;
Tim Peters077a11d2000-09-16 22:31:29 +00001040 retval = PyTuple_New(2);
1041 if (!retval)
1042 return NULL;
Fred Drake541dc3b2000-06-28 17:49:30 +00001043
1044 PyTuple_SET_ITEM(retval, 0, PyLong_FromVoidPtr(self->ob_item));
Christian Heimes90aa7642007-12-19 02:45:37 +00001045 PyTuple_SET_ITEM(retval, 1, PyLong_FromLong((long)(Py_SIZE(self))));
Fred Drake541dc3b2000-06-28 17:49:30 +00001046
1047 return retval;
Guido van Rossumde4a4ca1997-08-12 14:55:56 +00001048}
1049
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001050PyDoc_STRVAR(buffer_info_doc,
Tim Peters077a11d2000-09-16 22:31:29 +00001051"buffer_info() -> (address, length)\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001052\n\
1053Return a tuple (address, length) giving the current memory address and\n\
Guido van Rossum702d08e2001-07-27 16:05:32 +00001054the length in items of the buffer used to hold array's contents\n\
1055The length should be multiplied by the itemsize attribute to calculate\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001056the buffer length in bytes.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001057
1058
Guido van Rossumde4a4ca1997-08-12 14:55:56 +00001059static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001060array_append(arrayobject *self, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +00001061{
Christian Heimes90aa7642007-12-19 02:45:37 +00001062 return ins(self, (int) Py_SIZE(self), v);
Guido van Rossum778983b1993-02-19 15:55:02 +00001063}
1064
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001065PyDoc_STRVAR(append_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001066"append(x)\n\
1067\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001068Append new value x to the end of the array.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001069
1070
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001071static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001072array_byteswap(arrayobject *self, PyObject *unused)
Guido van Rossum778983b1993-02-19 15:55:02 +00001073{
1074 char *p;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001075 Py_ssize_t i;
Fred Drakebf272981999-12-03 17:15:30 +00001076
Guido van Rossum778983b1993-02-19 15:55:02 +00001077 switch (self->ob_descr->itemsize) {
1078 case 1:
1079 break;
1080 case 2:
Christian Heimes90aa7642007-12-19 02:45:37 +00001081 for (p = self->ob_item, i = Py_SIZE(self); --i >= 0; p += 2) {
Guido van Rossum778983b1993-02-19 15:55:02 +00001082 char p0 = p[0];
1083 p[0] = p[1];
1084 p[1] = p0;
1085 }
1086 break;
1087 case 4:
Christian Heimes90aa7642007-12-19 02:45:37 +00001088 for (p = self->ob_item, i = Py_SIZE(self); --i >= 0; p += 4) {
Guido van Rossum778983b1993-02-19 15:55:02 +00001089 char p0 = p[0];
1090 char p1 = p[1];
1091 p[0] = p[3];
1092 p[1] = p[2];
1093 p[2] = p1;
1094 p[3] = p0;
1095 }
1096 break;
Guido van Rossume77a7571993-11-03 15:01:26 +00001097 case 8:
Christian Heimes90aa7642007-12-19 02:45:37 +00001098 for (p = self->ob_item, i = Py_SIZE(self); --i >= 0; p += 8) {
Guido van Rossume77a7571993-11-03 15:01:26 +00001099 char p0 = p[0];
1100 char p1 = p[1];
1101 char p2 = p[2];
1102 char p3 = p[3];
1103 p[0] = p[7];
1104 p[1] = p[6];
1105 p[2] = p[5];
1106 p[3] = p[4];
1107 p[4] = p3;
1108 p[5] = p2;
1109 p[6] = p1;
1110 p[7] = p0;
1111 }
1112 break;
Guido van Rossum778983b1993-02-19 15:55:02 +00001113 default:
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001114 PyErr_SetString(PyExc_RuntimeError,
Guido van Rossum778983b1993-02-19 15:55:02 +00001115 "don't know how to byteswap this array type");
1116 return NULL;
1117 }
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001118 Py_INCREF(Py_None);
1119 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +00001120}
1121
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001122PyDoc_STRVAR(byteswap_doc,
Fred Drakebf272981999-12-03 17:15:30 +00001123"byteswap()\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001124\n\
Fred Drakebf272981999-12-03 17:15:30 +00001125Byteswap 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 +000011264, or 8 bytes in size, RuntimeError is raised.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001127
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001128static PyObject *
Raymond Hettingerb0900e62004-12-16 16:23:40 +00001129array_reduce(arrayobject *array)
1130{
1131 PyObject *dict, *result;
1132
1133 dict = PyObject_GetAttrString((PyObject *)array, "__dict__");
1134 if (dict == NULL) {
1135 PyErr_Clear();
1136 dict = Py_None;
1137 Py_INCREF(dict);
1138 }
Christian Heimes90aa7642007-12-19 02:45:37 +00001139 if (Py_SIZE(array) > 0) {
Amaury Forgeot d'Arc9c74b142008-06-18 00:47:36 +00001140 if (array->ob_descr->itemsize
1141 > PY_SSIZE_T_MAX / Py_SIZE(array)) {
1142 return PyErr_NoMemory();
1143 }
Martin v. Löwis10a60b32007-07-18 02:28:27 +00001144 result = Py_BuildValue("O(cy#)O",
Christian Heimes90aa7642007-12-19 02:45:37 +00001145 Py_TYPE(array),
Guido van Rossumd8faa362007-04-27 19:54:29 +00001146 array->ob_descr->typecode,
1147 array->ob_item,
Christian Heimes90aa7642007-12-19 02:45:37 +00001148 Py_SIZE(array) * array->ob_descr->itemsize,
Guido van Rossumd8faa362007-04-27 19:54:29 +00001149 dict);
1150 } else {
1151 result = Py_BuildValue("O(c)O",
Christian Heimes90aa7642007-12-19 02:45:37 +00001152 Py_TYPE(array),
Guido van Rossumd8faa362007-04-27 19:54:29 +00001153 array->ob_descr->typecode,
1154 dict);
1155 }
Raymond Hettingerb0900e62004-12-16 16:23:40 +00001156 Py_DECREF(dict);
1157 return result;
1158}
1159
1160PyDoc_STRVAR(array_doc, "Return state information for pickling.");
1161
1162static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001163array_reverse(arrayobject *self, PyObject *unused)
Guido van Rossum778983b1993-02-19 15:55:02 +00001164{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001165 register Py_ssize_t itemsize = self->ob_descr->itemsize;
Guido van Rossume77a7571993-11-03 15:01:26 +00001166 register char *p, *q;
Tim Peters077a11d2000-09-16 22:31:29 +00001167 /* little buffer to hold items while swapping */
1168 char tmp[256]; /* 8 is probably enough -- but why skimp */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001169 assert((size_t)itemsize <= sizeof(tmp));
Guido van Rossume77a7571993-11-03 15:01:26 +00001170
Christian Heimes90aa7642007-12-19 02:45:37 +00001171 if (Py_SIZE(self) > 1) {
Guido van Rossume77a7571993-11-03 15:01:26 +00001172 for (p = self->ob_item,
Christian Heimes90aa7642007-12-19 02:45:37 +00001173 q = self->ob_item + (Py_SIZE(self) - 1)*itemsize;
Guido van Rossume77a7571993-11-03 15:01:26 +00001174 p < q;
1175 p += itemsize, q -= itemsize) {
Tim Peters077a11d2000-09-16 22:31:29 +00001176 /* memory areas guaranteed disjoint, so memcpy
1177 * is safe (& memmove may be slower).
1178 */
1179 memcpy(tmp, p, itemsize);
1180 memcpy(p, q, itemsize);
1181 memcpy(q, tmp, itemsize);
Guido van Rossum778983b1993-02-19 15:55:02 +00001182 }
1183 }
Tim Petersbb307342000-09-10 05:22:54 +00001184
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001185 Py_INCREF(Py_None);
1186 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +00001187}
Guido van Rossume77a7571993-11-03 15:01:26 +00001188
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001189PyDoc_STRVAR(reverse_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001190"reverse()\n\
1191\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001192Reverse the order of the items in the array.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001193
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001194
1195/* Forward */
1196static PyObject *array_fromstring(arrayobject *self, PyObject *args);
1197
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001198static PyObject *
Peter Schneider-Kamp9656abd2000-07-13 21:10:57 +00001199array_fromfile(arrayobject *self, PyObject *args)
Guido van Rossum778983b1993-02-19 15:55:02 +00001200{
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001201 PyObject *f, *b, *res;
1202 Py_ssize_t itemsize = self->ob_descr->itemsize;
1203 Py_ssize_t n, nbytes;
1204
Thomas Wouters7a2f83b2006-02-16 17:07:41 +00001205 if (!PyArg_ParseTuple(args, "On:fromfile", &f, &n))
Guido van Rossum778983b1993-02-19 15:55:02 +00001206 return NULL;
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001207
1208 nbytes = n * itemsize;
1209 if (nbytes < 0 || nbytes/itemsize != n) {
1210 PyErr_NoMemory();
Guido van Rossum778983b1993-02-19 15:55:02 +00001211 return NULL;
1212 }
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001213
1214 b = PyObject_CallMethod(f, "read", "n", nbytes);
1215 if (b == NULL)
1216 return NULL;
1217
Christian Heimes72b710a2008-05-26 13:28:38 +00001218 if (!PyBytes_Check(b)) {
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001219 PyErr_SetString(PyExc_TypeError,
1220 "read() didn't return bytes");
1221 Py_DECREF(b);
1222 return NULL;
Guido van Rossum778983b1993-02-19 15:55:02 +00001223 }
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001224
Christian Heimes72b710a2008-05-26 13:28:38 +00001225 if (PyBytes_GET_SIZE(b) != nbytes) {
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001226 PyErr_SetString(PyExc_EOFError,
1227 "read() didn't return enough bytes");
1228 Py_DECREF(b);
1229 return NULL;
1230 }
1231
1232 args = Py_BuildValue("(O)", b);
1233 Py_DECREF(b);
1234 if (args == NULL)
1235 return NULL;
1236
1237 res = array_fromstring(self, args);
1238 Py_DECREF(args);
1239
1240 return res;
Guido van Rossum778983b1993-02-19 15:55:02 +00001241}
1242
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001243PyDoc_STRVAR(fromfile_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001244"fromfile(f, n)\n\
1245\n\
1246Read n objects from the file object f and append them to the end of the\n\
Georg Brandlf25ef502008-02-01 11:30:18 +00001247array.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001248
1249
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001250static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001251array_tofile(arrayobject *self, PyObject *f)
Guido van Rossum778983b1993-02-19 15:55:02 +00001252{
Christian Heimes90aa7642007-12-19 02:45:37 +00001253 Py_ssize_t nbytes = Py_SIZE(self) * self->ob_descr->itemsize;
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001254 /* Write 64K blocks at a time */
1255 /* XXX Make the block size settable */
1256 int BLOCKSIZE = 64*1024;
1257 Py_ssize_t nblocks = (nbytes + BLOCKSIZE - 1) / BLOCKSIZE;
1258 Py_ssize_t i;
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001259
Christian Heimes90aa7642007-12-19 02:45:37 +00001260 if (Py_SIZE(self) == 0)
Guido van Rossumb5ddcfd2007-04-11 17:08:28 +00001261 goto done;
1262
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001263 for (i = 0; i < nblocks; i++) {
1264 char* ptr = self->ob_item + i*BLOCKSIZE;
1265 Py_ssize_t size = BLOCKSIZE;
1266 PyObject *bytes, *res;
1267 if (i*BLOCKSIZE + size > nbytes)
1268 size = nbytes - i*BLOCKSIZE;
Christian Heimes72b710a2008-05-26 13:28:38 +00001269 bytes = PyBytes_FromStringAndSize(ptr, size);
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001270 if (bytes == NULL)
Guido van Rossum778983b1993-02-19 15:55:02 +00001271 return NULL;
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001272 res = PyObject_CallMethod(f, "write", "O", bytes);
1273 Py_DECREF(bytes);
1274 if (res == NULL)
1275 return NULL;
Martin v. Löwisa291c8f2007-08-11 14:25:27 +00001276 Py_DECREF(res); /* drop write result */
Guido van Rossumb5ddcfd2007-04-11 17:08:28 +00001277 }
1278
1279 done:
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001280 Py_INCREF(Py_None);
1281 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +00001282}
1283
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001284PyDoc_STRVAR(tofile_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001285"tofile(f)\n\
1286\n\
Georg Brandlf25ef502008-02-01 11:30:18 +00001287Write all items (as machine values) to the file object f.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001288
1289
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001290static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001291array_fromlist(arrayobject *self, PyObject *list)
Guido van Rossum778983b1993-02-19 15:55:02 +00001292{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001293 Py_ssize_t n;
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001294
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001295 if (!PyList_Check(list)) {
1296 PyErr_SetString(PyExc_TypeError, "arg must be list");
Guido van Rossum778983b1993-02-19 15:55:02 +00001297 return NULL;
1298 }
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001299 n = PyList_Size(list);
Guido van Rossum778983b1993-02-19 15:55:02 +00001300 if (n > 0) {
Antoine Pitrou3ad3a0d2008-12-18 17:08:32 +00001301 Py_ssize_t i, old_size;
1302 old_size = Py_SIZE(self);
1303 if (array_resize(self, old_size + n) == -1)
Guido van Rossum778983b1993-02-19 15:55:02 +00001304 return NULL;
Guido van Rossum778983b1993-02-19 15:55:02 +00001305 for (i = 0; i < n; i++) {
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001306 PyObject *v = PyList_GetItem(list, i);
Guido van Rossum778983b1993-02-19 15:55:02 +00001307 if ((*self->ob_descr->setitem)(self,
Christian Heimes90aa7642007-12-19 02:45:37 +00001308 Py_SIZE(self) - n + i, v) != 0) {
Antoine Pitrou3ad3a0d2008-12-18 17:08:32 +00001309 array_resize(self, old_size);
Guido van Rossum778983b1993-02-19 15:55:02 +00001310 return NULL;
1311 }
1312 }
1313 }
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001314 Py_INCREF(Py_None);
1315 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +00001316}
1317
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001318PyDoc_STRVAR(fromlist_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001319"fromlist(list)\n\
1320\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001321Append items to array from list.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001322
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001323static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001324array_tolist(arrayobject *self, PyObject *unused)
Guido van Rossum778983b1993-02-19 15:55:02 +00001325{
Christian Heimes90aa7642007-12-19 02:45:37 +00001326 PyObject *list = PyList_New(Py_SIZE(self));
Martin v. Löwis18e16552006-02-15 17:27:45 +00001327 Py_ssize_t i;
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001328
Guido van Rossum778983b1993-02-19 15:55:02 +00001329 if (list == NULL)
1330 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +00001331 for (i = 0; i < Py_SIZE(self); i++) {
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001332 PyObject *v = getarrayitem((PyObject *)self, i);
Guido van Rossum778983b1993-02-19 15:55:02 +00001333 if (v == NULL) {
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001334 Py_DECREF(list);
Guido van Rossum778983b1993-02-19 15:55:02 +00001335 return NULL;
1336 }
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001337 PyList_SetItem(list, i, v);
Guido van Rossum778983b1993-02-19 15:55:02 +00001338 }
1339 return list;
1340}
1341
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001342PyDoc_STRVAR(tolist_doc,
Guido van Rossumfc6aba51998-10-14 02:52:31 +00001343"tolist() -> list\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001344\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001345Convert array to an ordinary list with the same items.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001346
1347
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001348static PyObject *
Peter Schneider-Kamp9656abd2000-07-13 21:10:57 +00001349array_fromstring(arrayobject *self, PyObject *args)
Guido van Rossum778983b1993-02-19 15:55:02 +00001350{
1351 char *str;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001352 Py_ssize_t n;
Guido van Rossum778983b1993-02-19 15:55:02 +00001353 int itemsize = self->ob_descr->itemsize;
Peter Schneider-Kampdc71cac2000-07-31 21:57:30 +00001354 if (!PyArg_ParseTuple(args, "s#:fromstring", &str, &n))
Guido van Rossum778983b1993-02-19 15:55:02 +00001355 return NULL;
1356 if (n % itemsize != 0) {
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001357 PyErr_SetString(PyExc_ValueError,
Guido van Rossum778983b1993-02-19 15:55:02 +00001358 "string length not a multiple of item size");
1359 return NULL;
1360 }
1361 n = n / itemsize;
1362 if (n > 0) {
Antoine Pitrou3ad3a0d2008-12-18 17:08:32 +00001363 Py_ssize_t old_size = Py_SIZE(self);
1364 if ((n > PY_SSIZE_T_MAX - old_size) ||
1365 ((old_size + n) > PY_SSIZE_T_MAX / itemsize)) {
Amaury Forgeot d'Arc9c74b142008-06-18 00:47:36 +00001366 return PyErr_NoMemory();
1367 }
Antoine Pitrou3ad3a0d2008-12-18 17:08:32 +00001368 if (array_resize(self, old_size + n) == -1)
Guido van Rossum778983b1993-02-19 15:55:02 +00001369 return NULL;
Antoine Pitrou3ad3a0d2008-12-18 17:08:32 +00001370 memcpy(self->ob_item + old_size * itemsize,
1371 str, n * itemsize);
Guido van Rossum778983b1993-02-19 15:55:02 +00001372 }
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001373 Py_INCREF(Py_None);
1374 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +00001375}
1376
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001377PyDoc_STRVAR(fromstring_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001378"fromstring(string)\n\
1379\n\
1380Appends items from the string, interpreting it as an array of machine\n\
Walter Dörwald93b30b52007-06-22 12:21:53 +00001381values, as if it had been read from a file using the fromfile() method).");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001382
1383
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001384static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001385array_tostring(arrayobject *self, PyObject *unused)
Guido van Rossum778983b1993-02-19 15:55:02 +00001386{
Amaury Forgeot d'Arc9c74b142008-06-18 00:47:36 +00001387 if (Py_SIZE(self) <= PY_SSIZE_T_MAX / self->ob_descr->itemsize) {
1388 return PyBytes_FromStringAndSize(self->ob_item,
1389 Py_SIZE(self) * self->ob_descr->itemsize);
1390 } else {
1391 return PyErr_NoMemory();
1392 }
Guido van Rossum778983b1993-02-19 15:55:02 +00001393}
1394
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001395PyDoc_STRVAR(tostring_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001396"tostring() -> string\n\
1397\n\
1398Convert the array to an array of machine values and return the string\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001399representation.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001400
Martin v. Löwis99866332002-03-01 10:27:01 +00001401
1402
Martin v. Löwis99866332002-03-01 10:27:01 +00001403static PyObject *
1404array_fromunicode(arrayobject *self, PyObject *args)
1405{
1406 Py_UNICODE *ustr;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001407 Py_ssize_t n;
Travis E. Oliphantd5c0add2007-10-12 22:05:15 +00001408 char typecode;
Martin v. Löwis99866332002-03-01 10:27:01 +00001409
1410 if (!PyArg_ParseTuple(args, "u#:fromunicode", &ustr, &n))
1411 return NULL;
Travis E. Oliphantd5c0add2007-10-12 22:05:15 +00001412 typecode = self->ob_descr->typecode;
1413 if ((typecode != 'u')) {
1414 PyErr_SetString(PyExc_ValueError,
Martin v. Löwis99866332002-03-01 10:27:01 +00001415 "fromunicode() may only be called on "
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001416 "unicode type arrays");
Martin v. Löwis99866332002-03-01 10:27:01 +00001417 return NULL;
1418 }
1419 if (n > 0) {
Antoine Pitrou3ad3a0d2008-12-18 17:08:32 +00001420 Py_ssize_t old_size = Py_SIZE(self);
1421 if (array_resize(self, old_size + n) == -1)
Martin v. Löwis99866332002-03-01 10:27:01 +00001422 return NULL;
Antoine Pitrou3ad3a0d2008-12-18 17:08:32 +00001423 memcpy(self->ob_item + old_size * sizeof(Py_UNICODE),
Martin v. Löwis99866332002-03-01 10:27:01 +00001424 ustr, n * sizeof(Py_UNICODE));
1425 }
1426
1427 Py_INCREF(Py_None);
1428 return Py_None;
1429}
1430
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001431PyDoc_STRVAR(fromunicode_doc,
Martin v. Löwis99866332002-03-01 10:27:01 +00001432"fromunicode(ustr)\n\
1433\n\
1434Extends this array with data from the unicode string ustr.\n\
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001435The array must be a unicode type array; otherwise a ValueError\n\
Martin v. Löwis99866332002-03-01 10:27:01 +00001436is raised. Use array.fromstring(ustr.decode(...)) to\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001437append Unicode data to an array of some other type.");
Martin v. Löwis99866332002-03-01 10:27:01 +00001438
1439
1440static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001441array_tounicode(arrayobject *self, PyObject *unused)
Martin v. Löwis99866332002-03-01 10:27:01 +00001442{
Travis E. Oliphantd5c0add2007-10-12 22:05:15 +00001443 char typecode;
1444 typecode = self->ob_descr->typecode;
1445 if ((typecode != 'u')) {
Martin v. Löwis99866332002-03-01 10:27:01 +00001446 PyErr_SetString(PyExc_ValueError,
Travis E. Oliphantd5c0add2007-10-12 22:05:15 +00001447 "tounicode() may only be called on unicode type arrays");
Martin v. Löwis99866332002-03-01 10:27:01 +00001448 return NULL;
1449 }
Christian Heimes90aa7642007-12-19 02:45:37 +00001450 return PyUnicode_FromUnicode((Py_UNICODE *) self->ob_item, Py_SIZE(self));
Martin v. Löwis99866332002-03-01 10:27:01 +00001451}
1452
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001453PyDoc_STRVAR(tounicode_doc,
Martin v. Löwis99866332002-03-01 10:27:01 +00001454"tounicode() -> unicode\n\
1455\n\
1456Convert the array to a unicode string. The array must be\n\
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001457a unicode type array; otherwise a ValueError is raised. Use\n\
Martin v. Löwis99866332002-03-01 10:27:01 +00001458array.tostring().decode() to obtain a unicode string from\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001459an array of some other type.");
Martin v. Löwis99866332002-03-01 10:27:01 +00001460
Martin v. Löwis99866332002-03-01 10:27:01 +00001461
1462
1463static PyObject *
1464array_get_typecode(arrayobject *a, void *closure)
1465{
1466 char tc = a->ob_descr->typecode;
Walter Dörwald93b30b52007-06-22 12:21:53 +00001467 return PyUnicode_FromStringAndSize(&tc, 1);
Martin v. Löwis99866332002-03-01 10:27:01 +00001468}
1469
1470static PyObject *
1471array_get_itemsize(arrayobject *a, void *closure)
1472{
Christian Heimes217cfd12007-12-02 14:31:20 +00001473 return PyLong_FromLong((long)a->ob_descr->itemsize);
Martin v. Löwis99866332002-03-01 10:27:01 +00001474}
1475
1476static PyGetSetDef array_getsets [] = {
1477 {"typecode", (getter) array_get_typecode, NULL,
1478 "the typecode character used to create the array"},
1479 {"itemsize", (getter) array_get_itemsize, NULL,
1480 "the size, in bytes, of one array item"},
1481 {NULL}
1482};
1483
Martin v. Löwis59683e82008-06-13 07:50:45 +00001484static PyMethodDef array_methods[] = {
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001485 {"append", (PyCFunction)array_append, METH_O,
Guido van Rossum9d19cb82001-01-18 01:02:55 +00001486 append_doc},
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001487 {"buffer_info", (PyCFunction)array_buffer_info, METH_NOARGS,
Guido van Rossum9d19cb82001-01-18 01:02:55 +00001488 buffer_info_doc},
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001489 {"byteswap", (PyCFunction)array_byteswap, METH_NOARGS,
Guido van Rossum9d19cb82001-01-18 01:02:55 +00001490 byteswap_doc},
Raymond Hettinger3aa82c02004-03-13 18:18:51 +00001491 {"__copy__", (PyCFunction)array_copy, METH_NOARGS,
1492 copy_doc},
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001493 {"count", (PyCFunction)array_count, METH_O,
Guido van Rossum9d19cb82001-01-18 01:02:55 +00001494 count_doc},
Thomas Wouters89f507f2006-12-13 04:49:30 +00001495 {"__deepcopy__",(PyCFunction)array_copy, METH_O,
Raymond Hettinger3aa82c02004-03-13 18:18:51 +00001496 copy_doc},
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001497 {"extend", (PyCFunction)array_extend, METH_O,
Guido van Rossum9d19cb82001-01-18 01:02:55 +00001498 extend_doc},
1499 {"fromfile", (PyCFunction)array_fromfile, METH_VARARGS,
1500 fromfile_doc},
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001501 {"fromlist", (PyCFunction)array_fromlist, METH_O,
Guido van Rossum9d19cb82001-01-18 01:02:55 +00001502 fromlist_doc},
1503 {"fromstring", (PyCFunction)array_fromstring, METH_VARARGS,
1504 fromstring_doc},
Martin v. Löwis99866332002-03-01 10:27:01 +00001505 {"fromunicode", (PyCFunction)array_fromunicode, METH_VARARGS,
1506 fromunicode_doc},
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001507 {"index", (PyCFunction)array_index, METH_O,
Guido van Rossum9d19cb82001-01-18 01:02:55 +00001508 index_doc},
1509 {"insert", (PyCFunction)array_insert, METH_VARARGS,
1510 insert_doc},
1511 {"pop", (PyCFunction)array_pop, METH_VARARGS,
1512 pop_doc},
Raymond Hettingerb0900e62004-12-16 16:23:40 +00001513 {"__reduce__", (PyCFunction)array_reduce, METH_NOARGS,
1514 array_doc},
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001515 {"remove", (PyCFunction)array_remove, METH_O,
Guido van Rossum9d19cb82001-01-18 01:02:55 +00001516 remove_doc},
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001517 {"reverse", (PyCFunction)array_reverse, METH_NOARGS,
Guido van Rossum9d19cb82001-01-18 01:02:55 +00001518 reverse_doc},
1519/* {"sort", (PyCFunction)array_sort, METH_VARARGS,
1520 sort_doc},*/
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001521 {"tofile", (PyCFunction)array_tofile, METH_O,
Guido van Rossum9d19cb82001-01-18 01:02:55 +00001522 tofile_doc},
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001523 {"tolist", (PyCFunction)array_tolist, METH_NOARGS,
Guido van Rossum9d19cb82001-01-18 01:02:55 +00001524 tolist_doc},
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001525 {"tostring", (PyCFunction)array_tostring, METH_NOARGS,
Guido van Rossum9d19cb82001-01-18 01:02:55 +00001526 tostring_doc},
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001527 {"tounicode", (PyCFunction)array_tounicode, METH_NOARGS,
Martin v. Löwis99866332002-03-01 10:27:01 +00001528 tounicode_doc},
Guido van Rossum778983b1993-02-19 15:55:02 +00001529 {NULL, NULL} /* sentinel */
1530};
1531
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001532static PyObject *
Peter Schneider-Kamp9656abd2000-07-13 21:10:57 +00001533array_repr(arrayobject *a)
Guido van Rossum778983b1993-02-19 15:55:02 +00001534{
Walter Dörwaldc2f6a582007-05-20 12:49:47 +00001535 char typecode;
Walter Dörwald7569dfe2007-05-19 21:49:49 +00001536 PyObject *s, *v = NULL;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001537 Py_ssize_t len;
Martin v. Löwis99866332002-03-01 10:27:01 +00001538
Christian Heimes90aa7642007-12-19 02:45:37 +00001539 len = Py_SIZE(a);
Martin v. Löwis99866332002-03-01 10:27:01 +00001540 typecode = a->ob_descr->typecode;
Guido van Rossum778983b1993-02-19 15:55:02 +00001541 if (len == 0) {
Walter Dörwald7569dfe2007-05-19 21:49:49 +00001542 return PyUnicode_FromFormat("array('%c')", typecode);
Guido van Rossum778983b1993-02-19 15:55:02 +00001543 }
Travis E. Oliphantd5c0add2007-10-12 22:05:15 +00001544 if ((typecode == 'u'))
Raymond Hettinger88ba1e32003-04-23 17:27:00 +00001545 v = array_tounicode(a, NULL);
Raymond Hettinger88ba1e32003-04-23 17:27:00 +00001546 else
1547 v = array_tolist(a, NULL);
Raymond Hettinger88ba1e32003-04-23 17:27:00 +00001548
Walter Dörwald7569dfe2007-05-19 21:49:49 +00001549 s = PyUnicode_FromFormat("array('%c', %R)", typecode, v);
1550 Py_DECREF(v);
Guido van Rossum778983b1993-02-19 15:55:02 +00001551 return s;
1552}
1553
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001554static PyObject*
1555array_subscr(arrayobject* self, PyObject* item)
1556{
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001557 if (PyIndex_Check(item)) {
1558 Py_ssize_t i = PyNumber_AsSsize_t(item, PyExc_IndexError);
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001559 if (i==-1 && PyErr_Occurred()) {
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001560 return NULL;
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001561 }
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001562 if (i < 0)
Christian Heimes90aa7642007-12-19 02:45:37 +00001563 i += Py_SIZE(self);
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001564 return array_item(self, i);
1565 }
1566 else if (PySlice_Check(item)) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001567 Py_ssize_t start, stop, step, slicelength, cur, i;
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001568 PyObject* result;
1569 arrayobject* ar;
1570 int itemsize = self->ob_descr->itemsize;
1571
Christian Heimes90aa7642007-12-19 02:45:37 +00001572 if (PySlice_GetIndicesEx((PySliceObject*)item, Py_SIZE(self),
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001573 &start, &stop, &step, &slicelength) < 0) {
1574 return NULL;
1575 }
1576
1577 if (slicelength <= 0) {
1578 return newarrayobject(&Arraytype, 0, self->ob_descr);
1579 }
Thomas Woutersed03b412007-08-28 21:37:11 +00001580 else if (step == 1) {
1581 PyObject *result = newarrayobject(&Arraytype,
1582 slicelength, self->ob_descr);
1583 if (result == NULL)
1584 return NULL;
1585 memcpy(((arrayobject *)result)->ob_item,
1586 self->ob_item + start * itemsize,
1587 slicelength * itemsize);
1588 return result;
1589 }
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001590 else {
1591 result = newarrayobject(&Arraytype, slicelength, self->ob_descr);
1592 if (!result) return NULL;
1593
1594 ar = (arrayobject*)result;
1595
1596 for (cur = start, i = 0; i < slicelength;
1597 cur += step, i++) {
1598 memcpy(ar->ob_item + i*itemsize,
1599 self->ob_item + cur*itemsize,
1600 itemsize);
1601 }
1602
1603 return result;
1604 }
1605 }
1606 else {
1607 PyErr_SetString(PyExc_TypeError,
Thomas Woutersed03b412007-08-28 21:37:11 +00001608 "array indices must be integers");
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001609 return NULL;
1610 }
1611}
1612
1613static int
1614array_ass_subscr(arrayobject* self, PyObject* item, PyObject* value)
1615{
Thomas Woutersed03b412007-08-28 21:37:11 +00001616 Py_ssize_t start, stop, step, slicelength, needed;
1617 arrayobject* other;
1618 int itemsize;
1619
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001620 if (PyIndex_Check(item)) {
1621 Py_ssize_t i = PyNumber_AsSsize_t(item, PyExc_IndexError);
Thomas Woutersed03b412007-08-28 21:37:11 +00001622
1623 if (i == -1 && PyErr_Occurred())
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001624 return -1;
1625 if (i < 0)
Christian Heimes90aa7642007-12-19 02:45:37 +00001626 i += Py_SIZE(self);
1627 if (i < 0 || i >= Py_SIZE(self)) {
Thomas Woutersed03b412007-08-28 21:37:11 +00001628 PyErr_SetString(PyExc_IndexError,
1629 "array assignment index out of range");
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001630 return -1;
1631 }
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001632 if (value == NULL) {
Thomas Woutersed03b412007-08-28 21:37:11 +00001633 /* Fall through to slice assignment */
1634 start = i;
1635 stop = i + 1;
1636 step = 1;
1637 slicelength = 1;
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001638 }
Thomas Woutersed03b412007-08-28 21:37:11 +00001639 else
1640 return (*self->ob_descr->setitem)(self, i, value);
1641 }
1642 else if (PySlice_Check(item)) {
1643 if (PySlice_GetIndicesEx((PySliceObject *)item,
Christian Heimes90aa7642007-12-19 02:45:37 +00001644 Py_SIZE(self), &start, &stop,
Thomas Woutersed03b412007-08-28 21:37:11 +00001645 &step, &slicelength) < 0) {
1646 return -1;
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001647 }
Thomas Woutersed03b412007-08-28 21:37:11 +00001648 }
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001649 else {
Thomas Woutersed03b412007-08-28 21:37:11 +00001650 PyErr_SetString(PyExc_TypeError,
1651 "array indices must be integer");
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001652 return -1;
1653 }
Thomas Woutersed03b412007-08-28 21:37:11 +00001654 if (value == NULL) {
1655 other = NULL;
1656 needed = 0;
1657 }
1658 else if (array_Check(value)) {
1659 other = (arrayobject *)value;
Christian Heimes90aa7642007-12-19 02:45:37 +00001660 needed = Py_SIZE(other);
Thomas Woutersed03b412007-08-28 21:37:11 +00001661 if (self == other) {
1662 /* Special case "self[i:j] = self" -- copy self first */
1663 int ret;
1664 value = array_slice(other, 0, needed);
1665 if (value == NULL)
1666 return -1;
1667 ret = array_ass_subscr(self, item, value);
1668 Py_DECREF(value);
1669 return ret;
1670 }
1671 if (other->ob_descr != self->ob_descr) {
1672 PyErr_BadArgument();
1673 return -1;
1674 }
1675 }
1676 else {
1677 PyErr_Format(PyExc_TypeError,
1678 "can only assign array (not \"%.200s\") to array slice",
Christian Heimes90aa7642007-12-19 02:45:37 +00001679 Py_TYPE(value)->tp_name);
Thomas Woutersed03b412007-08-28 21:37:11 +00001680 return -1;
1681 }
1682 itemsize = self->ob_descr->itemsize;
1683 /* for 'a[2:1] = ...', the insertion point is 'start', not 'stop' */
1684 if ((step > 0 && stop < start) ||
1685 (step < 0 && stop > start))
1686 stop = start;
1687 if (step == 1) {
1688 if (slicelength > needed) {
1689 memmove(self->ob_item + (start + needed) * itemsize,
1690 self->ob_item + stop * itemsize,
Christian Heimes90aa7642007-12-19 02:45:37 +00001691 (Py_SIZE(self) - stop) * itemsize);
1692 if (array_resize(self, Py_SIZE(self) +
Antoine Pitrou3ad3a0d2008-12-18 17:08:32 +00001693 needed - slicelength) < 0)
Thomas Woutersed03b412007-08-28 21:37:11 +00001694 return -1;
1695 }
1696 else if (slicelength < needed) {
Christian Heimes90aa7642007-12-19 02:45:37 +00001697 if (array_resize(self, Py_SIZE(self) +
Antoine Pitrou3ad3a0d2008-12-18 17:08:32 +00001698 needed - slicelength) < 0)
Thomas Woutersed03b412007-08-28 21:37:11 +00001699 return -1;
1700 memmove(self->ob_item + (start + needed) * itemsize,
1701 self->ob_item + stop * itemsize,
Christian Heimes90aa7642007-12-19 02:45:37 +00001702 (Py_SIZE(self) - start - needed) * itemsize);
Thomas Woutersed03b412007-08-28 21:37:11 +00001703 }
1704 if (needed > 0)
1705 memcpy(self->ob_item + start * itemsize,
1706 other->ob_item, needed * itemsize);
1707 return 0;
1708 }
1709 else if (needed == 0) {
1710 /* Delete slice */
1711 Py_ssize_t cur, i;
1712
1713 if (step < 0) {
1714 stop = start + 1;
1715 start = stop + step * (slicelength - 1) - 1;
1716 step = -step;
1717 }
1718 for (cur = start, i = 0; i < slicelength;
1719 cur += step, i++) {
1720 Py_ssize_t lim = step - 1;
1721
Christian Heimes90aa7642007-12-19 02:45:37 +00001722 if (cur + step >= Py_SIZE(self))
1723 lim = Py_SIZE(self) - cur - 1;
Thomas Woutersed03b412007-08-28 21:37:11 +00001724 memmove(self->ob_item + (cur - i) * itemsize,
1725 self->ob_item + (cur + 1) * itemsize,
1726 lim * itemsize);
1727 }
1728 cur = start + slicelength * step;
Christian Heimes90aa7642007-12-19 02:45:37 +00001729 if (cur < Py_SIZE(self)) {
Thomas Woutersed03b412007-08-28 21:37:11 +00001730 memmove(self->ob_item + (cur-slicelength) * itemsize,
1731 self->ob_item + cur * itemsize,
Christian Heimes90aa7642007-12-19 02:45:37 +00001732 (Py_SIZE(self) - cur) * itemsize);
Thomas Woutersed03b412007-08-28 21:37:11 +00001733 }
Christian Heimes90aa7642007-12-19 02:45:37 +00001734 if (array_resize(self, Py_SIZE(self) - slicelength) < 0)
Thomas Woutersed03b412007-08-28 21:37:11 +00001735 return -1;
1736 return 0;
1737 }
1738 else {
1739 Py_ssize_t cur, i;
1740
1741 if (needed != slicelength) {
1742 PyErr_Format(PyExc_ValueError,
1743 "attempt to assign array of size %zd "
1744 "to extended slice of size %zd",
1745 needed, slicelength);
1746 return -1;
1747 }
1748 for (cur = start, i = 0; i < slicelength;
1749 cur += step, i++) {
1750 memcpy(self->ob_item + cur * itemsize,
1751 other->ob_item + i * itemsize,
1752 itemsize);
1753 }
1754 return 0;
1755 }
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001756}
1757
1758static PyMappingMethods array_as_mapping = {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001759 (lenfunc)array_length,
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00001760 (binaryfunc)array_subscr,
1761 (objobjargproc)array_ass_subscr
1762};
1763
Guido van Rossumd8faa362007-04-27 19:54:29 +00001764static const void *emptybuf = "";
1765
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001766
1767static int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +00001768array_buffer_getbuf(arrayobject *self, Py_buffer *view, int flags)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001769{
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001770 if (view==NULL) goto finish;
1771
1772 view->buf = (void *)self->ob_item;
Martin v. Löwis423be952008-08-13 15:53:07 +00001773 view->obj = (PyObject*)self;
1774 Py_INCREF(self);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001775 if (view->buf == NULL)
1776 view->buf = (void *)emptybuf;
Christian Heimes90aa7642007-12-19 02:45:37 +00001777 view->len = (Py_SIZE(self)) * self->ob_descr->itemsize;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001778 view->readonly = 0;
1779 view->ndim = 1;
1780 view->itemsize = self->ob_descr->itemsize;
1781 view->suboffsets = NULL;
1782 view->shape = NULL;
1783 if ((flags & PyBUF_ND)==PyBUF_ND) {
Christian Heimes90aa7642007-12-19 02:45:37 +00001784 view->shape = &((Py_SIZE(self)));
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001785 }
1786 view->strides = NULL;
1787 if ((flags & PyBUF_STRIDES)==PyBUF_STRIDES)
1788 view->strides = &(view->itemsize);
1789 view->format = NULL;
1790 view->internal = NULL;
1791 if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT) {
Travis E. Oliphantb803c512007-08-20 07:16:33 +00001792 view->format = self->ob_descr->formats;
Travis E. Oliphantddacf962007-10-13 21:03:27 +00001793#ifdef Py_UNICODE_WIDE
1794 if (self->ob_descr->typecode == 'u') {
Guido van Rossum7c4c6c52007-10-14 20:46:15 +00001795 view->format = "w";
Travis E. Oliphantddacf962007-10-13 21:03:27 +00001796 }
1797#endif
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001798 }
1799
1800 finish:
1801 self->ob_exports++;
1802 return 0;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001803}
1804
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001805static void
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +00001806array_buffer_relbuf(arrayobject *self, Py_buffer *view)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001807{
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001808 self->ob_exports--;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001809}
1810
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001811static PySequenceMethods array_as_sequence = {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001812 (lenfunc)array_length, /*sq_length*/
Roger E. Masse5817f8f1996-12-09 22:24:19 +00001813 (binaryfunc)array_concat, /*sq_concat*/
Martin v. Löwis18e16552006-02-15 17:27:45 +00001814 (ssizeargfunc)array_repeat, /*sq_repeat*/
1815 (ssizeargfunc)array_item, /*sq_item*/
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001816 0, /*sq_slice*/
Martin v. Löwis18e16552006-02-15 17:27:45 +00001817 (ssizeobjargproc)array_ass_item, /*sq_ass_item*/
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001818 0, /*sq_ass_slice*/
Raymond Hettinger625812f2003-01-07 01:58:52 +00001819 (objobjproc)array_contains, /*sq_contains*/
Martin v. Löwis99866332002-03-01 10:27:01 +00001820 (binaryfunc)array_inplace_concat, /*sq_inplace_concat*/
Martin v. Löwis18e16552006-02-15 17:27:45 +00001821 (ssizeargfunc)array_inplace_repeat /*sq_inplace_repeat*/
Guido van Rossum778983b1993-02-19 15:55:02 +00001822};
1823
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001824static PyBufferProcs array_as_buffer = {
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001825 (getbufferproc)array_buffer_getbuf,
1826 (releasebufferproc)array_buffer_relbuf
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001827};
1828
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001829static PyObject *
Martin v. Löwis99866332002-03-01 10:27:01 +00001830array_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
Guido van Rossum778983b1993-02-19 15:55:02 +00001831{
Guido van Rossum8934fc22007-06-30 23:44:36 +00001832 int c;
Raymond Hettinger6ab78cd2004-08-29 07:50:43 +00001833 PyObject *initial = NULL, *it = NULL;
Guido van Rossum778983b1993-02-19 15:55:02 +00001834 struct arraydescr *descr;
Georg Brandl02c42872005-08-26 06:42:30 +00001835
Thomas Woutersb2137042007-02-01 18:02:27 +00001836 if (type == &Arraytype && !_PyArg_NoKeywords("array.array()", kwds))
Georg Brandl02c42872005-08-26 06:42:30 +00001837 return NULL;
Martin v. Löwis99866332002-03-01 10:27:01 +00001838
Walter Dörwaldd0941302007-07-01 21:58:22 +00001839 if (!PyArg_ParseTuple(args, "C|O:array", &c, &initial))
Martin v. Löwis99866332002-03-01 10:27:01 +00001840 return NULL;
1841
1842 if (!(initial == NULL || PyList_Check(initial)
Christian Heimes9c4756e2008-05-26 13:22:05 +00001843 || PyByteArray_Check(initial)
Christian Heimes72b710a2008-05-26 13:28:38 +00001844 || PyBytes_Check(initial)
Neal Norwitz3fcbea52007-08-26 04:51:28 +00001845 || PyTuple_Check(initial)
Travis E. Oliphantd5c0add2007-10-12 22:05:15 +00001846 || ((c=='u') && PyUnicode_Check(initial)))) {
Raymond Hettinger6ab78cd2004-08-29 07:50:43 +00001847 it = PyObject_GetIter(initial);
1848 if (it == NULL)
1849 return NULL;
1850 /* We set initial to NULL so that the subsequent code
1851 will create an empty array of the appropriate type
1852 and afterwards we can use array_iter_extend to populate
1853 the array.
1854 */
1855 initial = NULL;
Martin v. Löwis99866332002-03-01 10:27:01 +00001856 }
Guido van Rossum778983b1993-02-19 15:55:02 +00001857 for (descr = descriptors; descr->typecode != '\0'; descr++) {
1858 if (descr->typecode == c) {
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001859 PyObject *a;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001860 Py_ssize_t len;
Raymond Hettinger84fc9aa2003-04-24 10:41:55 +00001861
1862 if (initial == NULL || !(PyList_Check(initial)
1863 || PyTuple_Check(initial)))
Guido van Rossum778983b1993-02-19 15:55:02 +00001864 len = 0;
1865 else
Raymond Hettinger84fc9aa2003-04-24 10:41:55 +00001866 len = PySequence_Size(initial);
Martin v. Löwis99866332002-03-01 10:27:01 +00001867
1868 a = newarrayobject(type, len, descr);
Guido van Rossum778983b1993-02-19 15:55:02 +00001869 if (a == NULL)
1870 return NULL;
Martin v. Löwis99866332002-03-01 10:27:01 +00001871
Guido van Rossum778983b1993-02-19 15:55:02 +00001872 if (len > 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001873 Py_ssize_t i;
Guido van Rossum778983b1993-02-19 15:55:02 +00001874 for (i = 0; i < len; i++) {
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001875 PyObject *v =
Raymond Hettinger84fc9aa2003-04-24 10:41:55 +00001876 PySequence_GetItem(initial, i);
Raymond Hettinger85004cc2003-08-05 11:23:59 +00001877 if (v == NULL) {
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001878 Py_DECREF(a);
Guido van Rossum778983b1993-02-19 15:55:02 +00001879 return NULL;
1880 }
Raymond Hettinger85004cc2003-08-05 11:23:59 +00001881 if (setarrayitem(a, i, v) != 0) {
1882 Py_DECREF(v);
1883 Py_DECREF(a);
1884 return NULL;
1885 }
1886 Py_DECREF(v);
Guido van Rossum778983b1993-02-19 15:55:02 +00001887 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001888 }
Christian Heimes9c4756e2008-05-26 13:22:05 +00001889 else if (initial != NULL && (PyByteArray_Check(initial) ||
Christian Heimes72b710a2008-05-26 13:28:38 +00001890 PyBytes_Check(initial))) {
Hye-Shik Chang4af5c8c2006-03-07 15:39:21 +00001891 PyObject *t_initial, *v;
1892 t_initial = PyTuple_Pack(1, initial);
1893 if (t_initial == NULL) {
1894 Py_DECREF(a);
1895 return NULL;
1896 }
1897 v = array_fromstring((arrayobject *)a,
Guido van Rossum9d19cb82001-01-18 01:02:55 +00001898 t_initial);
Martin v. Löwis99866332002-03-01 10:27:01 +00001899 Py_DECREF(t_initial);
Guido van Rossum778983b1993-02-19 15:55:02 +00001900 if (v == NULL) {
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001901 Py_DECREF(a);
Guido van Rossum778983b1993-02-19 15:55:02 +00001902 return NULL;
1903 }
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001904 Py_DECREF(v);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001905 }
1906 else if (initial != NULL && PyUnicode_Check(initial)) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001907 Py_ssize_t n = PyUnicode_GET_DATA_SIZE(initial);
Martin v. Löwis99866332002-03-01 10:27:01 +00001908 if (n > 0) {
1909 arrayobject *self = (arrayobject *)a;
1910 char *item = self->ob_item;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001911 item = (char *)PyMem_Realloc(item, n);
Martin v. Löwis99866332002-03-01 10:27:01 +00001912 if (item == NULL) {
1913 PyErr_NoMemory();
1914 Py_DECREF(a);
1915 return NULL;
1916 }
1917 self->ob_item = item;
Christian Heimes90aa7642007-12-19 02:45:37 +00001918 Py_SIZE(self) = n / sizeof(Py_UNICODE);
Martin v. Löwis99866332002-03-01 10:27:01 +00001919 memcpy(item, PyUnicode_AS_DATA(initial), n);
Christian Heimes90aa7642007-12-19 02:45:37 +00001920 self->allocated = Py_SIZE(self);
Martin v. Löwis99866332002-03-01 10:27:01 +00001921 }
Guido van Rossum778983b1993-02-19 15:55:02 +00001922 }
Raymond Hettinger6ab78cd2004-08-29 07:50:43 +00001923 if (it != NULL) {
1924 if (array_iter_extend((arrayobject *)a, it) == -1) {
1925 Py_DECREF(it);
1926 Py_DECREF(a);
1927 return NULL;
1928 }
1929 Py_DECREF(it);
1930 }
Guido van Rossum778983b1993-02-19 15:55:02 +00001931 return a;
1932 }
1933 }
Roger E. Masse5817f8f1996-12-09 22:24:19 +00001934 PyErr_SetString(PyExc_ValueError,
Guido van Rossum31f72d72007-06-18 18:44:28 +00001935 "bad typecode (must be b, B, u, h, H, i, I, l, L, f or d)");
Guido van Rossum778983b1993-02-19 15:55:02 +00001936 return NULL;
1937}
1938
Guido van Rossum778983b1993-02-19 15:55:02 +00001939
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001940PyDoc_STRVAR(module_doc,
Martin v. Löwis99866332002-03-01 10:27:01 +00001941"This module defines an object type which can efficiently represent\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001942an array of basic values: characters, integers, floating point\n\
1943numbers. Arrays are sequence types and behave very much like lists,\n\
1944except that the type of objects stored in them is constrained. The\n\
1945type is specified at object creation time by using a type code, which\n\
1946is a single character. The following type codes are defined:\n\
1947\n\
1948 Type code C Type Minimum size in bytes \n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001949 'b' signed integer 1 \n\
1950 'B' unsigned integer 1 \n\
Travis E. Oliphantd5c0add2007-10-12 22:05:15 +00001951 'u' Unicode character 2 (see note) \n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001952 'h' signed integer 2 \n\
1953 'H' unsigned integer 2 \n\
1954 'i' signed integer 2 \n\
1955 'I' unsigned integer 2 \n\
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001956 'w' unicode character 4 \n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001957 'l' signed integer 4 \n\
1958 'L' unsigned integer 4 \n\
1959 'f' floating point 4 \n\
1960 'd' floating point 8 \n\
1961\n\
Travis E. Oliphantd5c0add2007-10-12 22:05:15 +00001962NOTE: The 'u' typecode corresponds to Python's unicode character. On \n\
1963narrow builds this is 2-bytes on wide builds this is 4-bytes.\n\
1964\n\
Martin v. Löwis99866332002-03-01 10:27:01 +00001965The constructor is:\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001966\n\
1967array(typecode [, initializer]) -- create a new array\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001968");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001969
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001970PyDoc_STRVAR(arraytype_doc,
Martin v. Löwis99866332002-03-01 10:27:01 +00001971"array(typecode [, initializer]) -> array\n\
1972\n\
1973Return a new array whose items are restricted by typecode, and\n\
Raymond Hettinger6ab78cd2004-08-29 07:50:43 +00001974initialized from the optional initializer value, which must be a list,\n\
1975string. or iterable over elements of the appropriate type.\n\
Martin v. Löwis99866332002-03-01 10:27:01 +00001976\n\
1977Arrays represent basic values and behave very much like lists, except\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001978the type of objects stored in them is constrained.\n\
1979\n\
1980Methods:\n\
1981\n\
1982append() -- append a new item to the end of the array\n\
1983buffer_info() -- return information giving the current memory info\n\
1984byteswap() -- byteswap all the items of the array\n\
Mark Dickinson934896d2009-02-21 20:59:32 +00001985count() -- return number of occurrences of an object\n\
Raymond Hettinger49f9bd12004-03-14 05:43:59 +00001986extend() -- extend array by appending multiple elements from an iterable\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001987fromfile() -- read items from a file object\n\
1988fromlist() -- append items from the list\n\
1989fromstring() -- append items from the string\n\
Mark Dickinson934896d2009-02-21 20:59:32 +00001990index() -- return index of first occurrence of an object\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001991insert() -- insert a new item into the array at a provided position\n\
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001992pop() -- remove and return item (default last)\n\
Mark Dickinson934896d2009-02-21 20:59:32 +00001993remove() -- remove first occurrence of an object\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001994reverse() -- reverse the order of the items in the array\n\
1995tofile() -- write all items to a file object\n\
1996tolist() -- return the array converted to an ordinary list\n\
1997tostring() -- return the array converted to a string\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001998\n\
Martin v. Löwis99866332002-03-01 10:27:01 +00001999Attributes:\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002000\n\
2001typecode -- the typecode character used to create the array\n\
2002itemsize -- the length in bytes of one array item\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002003");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002004
Raymond Hettinger625812f2003-01-07 01:58:52 +00002005static PyObject *array_iter(arrayobject *ao);
2006
Tim Peters0c322792002-07-17 16:49:03 +00002007static PyTypeObject Arraytype = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002008 PyVarObject_HEAD_INIT(NULL, 0)
Guido van Rossum14648392001-12-08 18:02:58 +00002009 "array.array",
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002010 sizeof(arrayobject),
2011 0,
Guido van Rossum9d19cb82001-01-18 01:02:55 +00002012 (destructor)array_dealloc, /* tp_dealloc */
Martin v. Löwisaa158be2002-03-04 09:38:52 +00002013 0, /* tp_print */
Martin v. Löwis99866332002-03-01 10:27:01 +00002014 0, /* tp_getattr */
Guido van Rossum9d19cb82001-01-18 01:02:55 +00002015 0, /* tp_setattr */
Mark Dickinsone94c6792009-02-02 20:36:42 +00002016 0, /* tp_reserved */
Guido van Rossum9d19cb82001-01-18 01:02:55 +00002017 (reprfunc)array_repr, /* tp_repr */
Thomas Wouters477c8d52006-05-27 19:21:47 +00002018 0, /* tp_as_number*/
2019 &array_as_sequence, /* tp_as_sequence*/
2020 &array_as_mapping, /* tp_as_mapping*/
Guido van Rossum9d19cb82001-01-18 01:02:55 +00002021 0, /* tp_hash */
2022 0, /* tp_call */
2023 0, /* tp_str */
Jason Tishlerfb8595d2003-01-06 12:41:26 +00002024 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum9d19cb82001-01-18 01:02:55 +00002025 0, /* tp_setattro */
Tim Petersb870c752001-06-05 04:43:26 +00002026 &array_as_buffer, /* tp_as_buffer*/
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00002027 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Guido van Rossum9d19cb82001-01-18 01:02:55 +00002028 arraytype_doc, /* tp_doc */
2029 0, /* tp_traverse */
2030 0, /* tp_clear */
2031 array_richcompare, /* tp_richcompare */
Raymond Hettingercb87bc82004-05-31 00:35:52 +00002032 offsetof(arrayobject, weakreflist), /* tp_weaklistoffset */
Raymond Hettinger625812f2003-01-07 01:58:52 +00002033 (getiterfunc)array_iter, /* tp_iter */
Martin v. Löwis99866332002-03-01 10:27:01 +00002034 0, /* tp_iternext */
2035 array_methods, /* tp_methods */
2036 0, /* tp_members */
2037 array_getsets, /* tp_getset */
2038 0, /* tp_base */
2039 0, /* tp_dict */
2040 0, /* tp_descr_get */
2041 0, /* tp_descr_set */
2042 0, /* tp_dictoffset */
2043 0, /* tp_init */
Jason Tishlerfb8595d2003-01-06 12:41:26 +00002044 PyType_GenericAlloc, /* tp_alloc */
Martin v. Löwis99866332002-03-01 10:27:01 +00002045 array_new, /* tp_new */
Jason Tishlerfb8595d2003-01-06 12:41:26 +00002046 PyObject_Del, /* tp_free */
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002047};
2048
Raymond Hettinger625812f2003-01-07 01:58:52 +00002049
2050/*********************** Array Iterator **************************/
2051
2052typedef struct {
2053 PyObject_HEAD
Martin v. Löwis18e16552006-02-15 17:27:45 +00002054 Py_ssize_t index;
Raymond Hettinger625812f2003-01-07 01:58:52 +00002055 arrayobject *ao;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002056 PyObject * (*getitem)(struct arrayobject *, Py_ssize_t);
Raymond Hettinger625812f2003-01-07 01:58:52 +00002057} arrayiterobject;
2058
2059static PyTypeObject PyArrayIter_Type;
2060
2061#define PyArrayIter_Check(op) PyObject_TypeCheck(op, &PyArrayIter_Type)
2062
2063static PyObject *
2064array_iter(arrayobject *ao)
2065{
2066 arrayiterobject *it;
2067
2068 if (!array_Check(ao)) {
2069 PyErr_BadInternalCall();
2070 return NULL;
2071 }
2072
2073 it = PyObject_GC_New(arrayiterobject, &PyArrayIter_Type);
2074 if (it == NULL)
2075 return NULL;
2076
2077 Py_INCREF(ao);
2078 it->ao = ao;
2079 it->index = 0;
2080 it->getitem = ao->ob_descr->getitem;
2081 PyObject_GC_Track(it);
2082 return (PyObject *)it;
2083}
2084
2085static PyObject *
Raymond Hettinger625812f2003-01-07 01:58:52 +00002086arrayiter_next(arrayiterobject *it)
2087{
2088 assert(PyArrayIter_Check(it));
Christian Heimes90aa7642007-12-19 02:45:37 +00002089 if (it->index < Py_SIZE(it->ao))
Raymond Hettinger625812f2003-01-07 01:58:52 +00002090 return (*it->getitem)(it->ao, it->index++);
2091 return NULL;
2092}
2093
2094static void
2095arrayiter_dealloc(arrayiterobject *it)
2096{
2097 PyObject_GC_UnTrack(it);
2098 Py_XDECREF(it->ao);
2099 PyObject_GC_Del(it);
2100}
2101
2102static int
2103arrayiter_traverse(arrayiterobject *it, visitproc visit, void *arg)
2104{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002105 Py_VISIT(it->ao);
Raymond Hettinger625812f2003-01-07 01:58:52 +00002106 return 0;
2107}
2108
2109static PyTypeObject PyArrayIter_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002110 PyVarObject_HEAD_INIT(NULL, 0)
Raymond Hettinger625812f2003-01-07 01:58:52 +00002111 "arrayiterator", /* tp_name */
2112 sizeof(arrayiterobject), /* tp_basicsize */
2113 0, /* tp_itemsize */
2114 /* methods */
2115 (destructor)arrayiter_dealloc, /* tp_dealloc */
2116 0, /* tp_print */
2117 0, /* tp_getattr */
2118 0, /* tp_setattr */
Mark Dickinsone94c6792009-02-02 20:36:42 +00002119 0, /* tp_reserved */
Raymond Hettinger625812f2003-01-07 01:58:52 +00002120 0, /* tp_repr */
2121 0, /* tp_as_number */
2122 0, /* tp_as_sequence */
2123 0, /* tp_as_mapping */
2124 0, /* tp_hash */
2125 0, /* tp_call */
2126 0, /* tp_str */
2127 PyObject_GenericGetAttr, /* tp_getattro */
2128 0, /* tp_setattro */
2129 0, /* tp_as_buffer */
2130 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
2131 0, /* tp_doc */
2132 (traverseproc)arrayiter_traverse, /* tp_traverse */
2133 0, /* tp_clear */
2134 0, /* tp_richcompare */
2135 0, /* tp_weaklistoffset */
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +00002136 PyObject_SelfIter, /* tp_iter */
Raymond Hettinger625812f2003-01-07 01:58:52 +00002137 (iternextfunc)arrayiter_next, /* tp_iternext */
2138 0, /* tp_methods */
2139};
2140
2141
2142/*********************** Install Module **************************/
2143
Martin v. Löwis99866332002-03-01 10:27:01 +00002144/* No functions in array module. */
2145static PyMethodDef a_methods[] = {
2146 {NULL, NULL, 0, NULL} /* Sentinel */
2147};
2148
Martin v. Löwis1a214512008-06-11 05:26:20 +00002149static struct PyModuleDef arraymodule = {
2150 PyModuleDef_HEAD_INIT,
2151 "array",
2152 module_doc,
2153 -1,
2154 a_methods,
2155 NULL,
2156 NULL,
2157 NULL,
2158 NULL
2159};
2160
Martin v. Löwis99866332002-03-01 10:27:01 +00002161
Mark Hammondfe51c6d2002-08-02 02:27:13 +00002162PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00002163PyInit_array(void)
Guido van Rossum778983b1993-02-19 15:55:02 +00002164{
Fred Drakef4e34842002-04-01 03:45:06 +00002165 PyObject *m;
Travis E. Oliphantd5c0add2007-10-12 22:05:15 +00002166 PyObject *typecodes;
2167 Py_ssize_t size = 0;
2168 register Py_UNICODE *p;
2169 struct arraydescr *descr;
Fred Drake0d40ba42000-02-04 20:33:49 +00002170
Guido van Rossum50e9fb92006-08-17 05:42:55 +00002171 if (PyType_Ready(&Arraytype) < 0)
Martin v. Löwis1a214512008-06-11 05:26:20 +00002172 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +00002173 Py_TYPE(&PyArrayIter_Type) = &PyType_Type;
Martin v. Löwis1a214512008-06-11 05:26:20 +00002174 m = PyModule_Create(&arraymodule);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00002175 if (m == NULL)
Martin v. Löwis1a214512008-06-11 05:26:20 +00002176 return NULL;
Fred Drakef4e34842002-04-01 03:45:06 +00002177
2178 Py_INCREF((PyObject *)&Arraytype);
2179 PyModule_AddObject(m, "ArrayType", (PyObject *)&Arraytype);
2180 Py_INCREF((PyObject *)&Arraytype);
2181 PyModule_AddObject(m, "array", (PyObject *)&Arraytype);
Travis E. Oliphantd5c0add2007-10-12 22:05:15 +00002182
2183 for (descr=descriptors; descr->typecode != '\0'; descr++) {
2184 size++;
2185 }
2186
2187 typecodes = PyUnicode_FromStringAndSize(NULL, size);
2188 p = PyUnicode_AS_UNICODE(typecodes);
2189 for (descr = descriptors; descr->typecode != '\0'; descr++) {
2190 *p++ = (char)descr->typecode;
2191 }
2192
2193 PyModule_AddObject(m, "typecodes", (PyObject *)typecodes);
2194
Martin v. Löwis1a214512008-06-11 05:26:20 +00002195 if (PyErr_Occurred()) {
2196 Py_DECREF(m);
2197 m = NULL;
2198 }
2199 return m;
Guido van Rossum778983b1993-02-19 15:55:02 +00002200}