blob: b7a6a3b737e6d8671c25592dae9e7d781791683a [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
Antoine Pitrouf95a1b32010-05-09 15:52:27 +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 {
Victor Stinnerf8bb7d02011-09-30 00:03:59 +020025 char typecode;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000026 int itemsize;
27 PyObject * (*getitem)(struct arrayobject *, Py_ssize_t);
28 int (*setitem)(struct arrayobject *, Py_ssize_t, PyObject *);
29 char *formats;
30 int is_integer_type;
31 int is_signed;
Guido van Rossum778983b1993-02-19 15:55:02 +000032};
33
34typedef struct arrayobject {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000035 PyObject_VAR_HEAD
36 char *ob_item;
37 Py_ssize_t allocated;
38 struct arraydescr *ob_descr;
39 PyObject *weakreflist; /* List of weak references */
40 int ob_exports; /* Number of exported buffers */
Guido van Rossum778983b1993-02-19 15:55:02 +000041} arrayobject;
42
Jeremy Hylton938ace62002-07-17 16:30:39 +000043static PyTypeObject Arraytype;
Guido van Rossum778983b1993-02-19 15:55:02 +000044
Martin v. Löwis99866332002-03-01 10:27:01 +000045#define array_Check(op) PyObject_TypeCheck(op, &Arraytype)
Christian Heimes90aa7642007-12-19 02:45:37 +000046#define array_CheckExact(op) (Py_TYPE(op) == &Arraytype)
Guido van Rossum778983b1993-02-19 15:55:02 +000047
Raymond Hettinger6e2ee862004-03-14 04:37:50 +000048static int
Martin v. Löwis18e16552006-02-15 17:27:45 +000049array_resize(arrayobject *self, Py_ssize_t newsize)
Raymond Hettinger6e2ee862004-03-14 04:37:50 +000050{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000051 char *items;
52 size_t _new_size;
Raymond Hettinger6e2ee862004-03-14 04:37:50 +000053
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000054 if (self->ob_exports > 0 && newsize != Py_SIZE(self)) {
55 PyErr_SetString(PyExc_BufferError,
56 "cannot resize an array that is exporting buffers");
57 return -1;
58 }
Antoine Pitrou3ad3a0d2008-12-18 17:08:32 +000059
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000060 /* Bypass realloc() when a previous overallocation is large enough
61 to accommodate the newsize. If the newsize is 16 smaller than the
62 current size, then proceed with the realloc() to shrink the array.
63 */
Raymond Hettinger6e2ee862004-03-14 04:37:50 +000064
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000065 if (self->allocated >= newsize &&
66 Py_SIZE(self) < newsize + 16 &&
67 self->ob_item != NULL) {
68 Py_SIZE(self) = newsize;
69 return 0;
70 }
Raymond Hettinger6e2ee862004-03-14 04:37:50 +000071
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000072 if (newsize == 0) {
73 PyMem_FREE(self->ob_item);
74 self->ob_item = NULL;
75 Py_SIZE(self) = 0;
76 self->allocated = 0;
77 return 0;
78 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +000079
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000080 /* This over-allocates proportional to the array size, making room
81 * for additional growth. The over-allocation is mild, but is
82 * enough to give linear-time amortized behavior over a long
83 * sequence of appends() in the presence of a poorly-performing
84 * system realloc().
85 * The growth pattern is: 0, 4, 8, 16, 25, 34, 46, 56, 67, 79, ...
86 * Note, the pattern starts out the same as for lists but then
87 * grows at a smaller rate so that larger arrays only overallocate
88 * by about 1/16th -- this is done because arrays are presumed to be more
89 * memory critical.
90 */
Raymond Hettinger6e2ee862004-03-14 04:37:50 +000091
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000092 _new_size = (newsize >> 4) + (Py_SIZE(self) < 8 ? 3 : 7) + newsize;
93 items = self->ob_item;
94 /* XXX The following multiplication and division does not optimize away
95 like it does for lists since the size is not known at compile time */
96 if (_new_size <= ((~(size_t)0) / self->ob_descr->itemsize))
97 PyMem_RESIZE(items, char, (_new_size * self->ob_descr->itemsize));
98 else
99 items = NULL;
100 if (items == NULL) {
101 PyErr_NoMemory();
102 return -1;
103 }
104 self->ob_item = items;
105 Py_SIZE(self) = newsize;
106 self->allocated = _new_size;
107 return 0;
Raymond Hettinger6e2ee862004-03-14 04:37:50 +0000108}
109
Tim Petersbb307342000-09-10 05:22:54 +0000110/****************************************************************************
111Get and Set functions for each type.
112A Get function takes an arrayobject* and an integer index, returning the
113array value at that index wrapped in an appropriate PyObject*.
114A Set function takes an arrayobject, integer index, and PyObject*; sets
115the array value at that index to the raw C data extracted from the PyObject*,
116and returns 0 if successful, else nonzero on failure (PyObject* not of an
117appropriate type or value).
118Note that the basic Get and Set functions do NOT check that the index is
119in bounds; that's the responsibility of the caller.
120****************************************************************************/
Guido van Rossum778983b1993-02-19 15:55:02 +0000121
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000122static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000123b_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum778983b1993-02-19 15:55:02 +0000124{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000125 long x = ((char *)ap->ob_item)[i];
126 if (x >= 128)
127 x -= 256;
128 return PyLong_FromLong(x);
Guido van Rossum778983b1993-02-19 15:55:02 +0000129}
130
131static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000132b_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000133{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000134 short x;
135 /* PyArg_Parse's 'b' formatter is for an unsigned char, therefore
136 must use the next size up that is signed ('h') and manually do
137 the overflow checking */
138 if (!PyArg_Parse(v, "h;array item must be integer", &x))
139 return -1;
140 else if (x < -128) {
141 PyErr_SetString(PyExc_OverflowError,
142 "signed char is less than minimum");
143 return -1;
144 }
145 else if (x > 127) {
146 PyErr_SetString(PyExc_OverflowError,
147 "signed char is greater than maximum");
148 return -1;
149 }
150 if (i >= 0)
151 ((char *)ap->ob_item)[i] = (char)x;
152 return 0;
Guido van Rossum778983b1993-02-19 15:55:02 +0000153}
154
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000155static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000156BB_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum549ab711997-01-03 19:09:47 +0000157{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000158 long x = ((unsigned char *)ap->ob_item)[i];
159 return PyLong_FromLong(x);
Guido van Rossum549ab711997-01-03 19:09:47 +0000160}
161
Fred Drake541dc3b2000-06-28 17:49:30 +0000162static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000163BB_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Fred Drake541dc3b2000-06-28 17:49:30 +0000164{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000165 unsigned char x;
166 /* 'B' == unsigned char, maps to PyArg_Parse's 'b' formatter */
167 if (!PyArg_Parse(v, "b;array item must be integer", &x))
168 return -1;
169 if (i >= 0)
170 ((char *)ap->ob_item)[i] = x;
171 return 0;
Fred Drake541dc3b2000-06-28 17:49:30 +0000172}
Guido van Rossum549ab711997-01-03 19:09:47 +0000173
Martin v. Löwis99866332002-03-01 10:27:01 +0000174static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000175u_getitem(arrayobject *ap, Py_ssize_t i)
Martin v. Löwis99866332002-03-01 10:27:01 +0000176{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000177 return PyUnicode_FromUnicode(&((Py_UNICODE *) ap->ob_item)[i], 1);
Martin v. Löwis99866332002-03-01 10:27:01 +0000178}
179
180static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000181u_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Martin v. Löwis99866332002-03-01 10:27:01 +0000182{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000183 Py_UNICODE *p;
184 Py_ssize_t len;
Martin v. Löwis99866332002-03-01 10:27:01 +0000185
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000186 if (!PyArg_Parse(v, "u#;array item must be unicode character", &p, &len))
187 return -1;
188 if (len != 1) {
189 PyErr_SetString(PyExc_TypeError,
190 "array item must be unicode character");
191 return -1;
192 }
193 if (i >= 0)
194 ((Py_UNICODE *)ap->ob_item)[i] = p[0];
195 return 0;
Martin v. Löwis99866332002-03-01 10:27:01 +0000196}
Martin v. Löwis99866332002-03-01 10:27:01 +0000197
Travis E. Oliphantd5c0add2007-10-12 22:05:15 +0000198
Guido van Rossum549ab711997-01-03 19:09:47 +0000199static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000200h_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum778983b1993-02-19 15:55:02 +0000201{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000202 return PyLong_FromLong((long) ((short *)ap->ob_item)[i]);
Guido van Rossum778983b1993-02-19 15:55:02 +0000203}
204
Travis E. Oliphantd5c0add2007-10-12 22:05:15 +0000205
Guido van Rossum778983b1993-02-19 15:55:02 +0000206static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000207h_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000208{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000209 short x;
210 /* 'h' == signed short, maps to PyArg_Parse's 'h' formatter */
211 if (!PyArg_Parse(v, "h;array item must be integer", &x))
212 return -1;
213 if (i >= 0)
214 ((short *)ap->ob_item)[i] = x;
215 return 0;
Guido van Rossum778983b1993-02-19 15:55:02 +0000216}
217
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000218static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000219HH_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum549ab711997-01-03 19:09:47 +0000220{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000221 return PyLong_FromLong((long) ((unsigned short *)ap->ob_item)[i]);
Guido van Rossum549ab711997-01-03 19:09:47 +0000222}
223
Fred Drake541dc3b2000-06-28 17:49:30 +0000224static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000225HH_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Fred Drake541dc3b2000-06-28 17:49:30 +0000226{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000227 int x;
228 /* PyArg_Parse's 'h' formatter is for a signed short, therefore
229 must use the next size up and manually do the overflow checking */
230 if (!PyArg_Parse(v, "i;array item must be integer", &x))
231 return -1;
232 else if (x < 0) {
233 PyErr_SetString(PyExc_OverflowError,
234 "unsigned short is less than minimum");
235 return -1;
236 }
237 else if (x > USHRT_MAX) {
238 PyErr_SetString(PyExc_OverflowError,
239 "unsigned short is greater than maximum");
240 return -1;
241 }
242 if (i >= 0)
243 ((short *)ap->ob_item)[i] = (short)x;
244 return 0;
Fred Drake541dc3b2000-06-28 17:49:30 +0000245}
Guido van Rossum549ab711997-01-03 19:09:47 +0000246
247static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000248i_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossume77a7571993-11-03 15:01:26 +0000249{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000250 return PyLong_FromLong((long) ((int *)ap->ob_item)[i]);
Guido van Rossume77a7571993-11-03 15:01:26 +0000251}
252
253static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000254i_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Guido van Rossume77a7571993-11-03 15:01:26 +0000255{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000256 int x;
257 /* 'i' == signed int, maps to PyArg_Parse's 'i' formatter */
258 if (!PyArg_Parse(v, "i;array item must be integer", &x))
259 return -1;
260 if (i >= 0)
261 ((int *)ap->ob_item)[i] = x;
262 return 0;
Guido van Rossume77a7571993-11-03 15:01:26 +0000263}
264
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000265static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000266II_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum549ab711997-01-03 19:09:47 +0000267{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000268 return PyLong_FromUnsignedLong(
269 (unsigned long) ((unsigned int *)ap->ob_item)[i]);
Guido van Rossum549ab711997-01-03 19:09:47 +0000270}
271
272static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000273II_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Guido van Rossum549ab711997-01-03 19:09:47 +0000274{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000275 unsigned long x;
276 if (PyLong_Check(v)) {
277 x = PyLong_AsUnsignedLong(v);
278 if (x == (unsigned long) -1 && PyErr_Occurred())
279 return -1;
280 }
281 else {
282 long y;
283 if (!PyArg_Parse(v, "l;array item must be integer", &y))
284 return -1;
285 if (y < 0) {
286 PyErr_SetString(PyExc_OverflowError,
287 "unsigned int is less than minimum");
288 return -1;
289 }
290 x = (unsigned long)y;
Tim Petersbb307342000-09-10 05:22:54 +0000291
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000292 }
293 if (x > UINT_MAX) {
294 PyErr_SetString(PyExc_OverflowError,
295 "unsigned int is greater than maximum");
296 return -1;
297 }
Fred Drake541dc3b2000-06-28 17:49:30 +0000298
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000299 if (i >= 0)
300 ((unsigned int *)ap->ob_item)[i] = (unsigned int)x;
301 return 0;
Guido van Rossum549ab711997-01-03 19:09:47 +0000302}
303
304static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000305l_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum778983b1993-02-19 15:55:02 +0000306{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000307 return PyLong_FromLong(((long *)ap->ob_item)[i]);
Guido van Rossum778983b1993-02-19 15:55:02 +0000308}
309
310static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000311l_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000312{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000313 long x;
314 if (!PyArg_Parse(v, "l;array item must be integer", &x))
315 return -1;
316 if (i >= 0)
317 ((long *)ap->ob_item)[i] = x;
318 return 0;
Guido van Rossum778983b1993-02-19 15:55:02 +0000319}
320
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000321static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000322LL_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum549ab711997-01-03 19:09:47 +0000323{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000324 return PyLong_FromUnsignedLong(((unsigned long *)ap->ob_item)[i]);
Guido van Rossum549ab711997-01-03 19:09:47 +0000325}
326
327static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000328LL_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Guido van Rossum549ab711997-01-03 19:09:47 +0000329{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000330 unsigned long x;
331 if (PyLong_Check(v)) {
332 x = PyLong_AsUnsignedLong(v);
333 if (x == (unsigned long) -1 && PyErr_Occurred())
334 return -1;
335 }
336 else {
337 long y;
338 if (!PyArg_Parse(v, "l;array item must be integer", &y))
339 return -1;
340 if (y < 0) {
341 PyErr_SetString(PyExc_OverflowError,
342 "unsigned long is less than minimum");
343 return -1;
344 }
345 x = (unsigned long)y;
Tim Petersbb307342000-09-10 05:22:54 +0000346
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000347 }
348 if (x > ULONG_MAX) {
349 PyErr_SetString(PyExc_OverflowError,
350 "unsigned long is greater than maximum");
351 return -1;
352 }
Tim Petersbb307342000-09-10 05:22:54 +0000353
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000354 if (i >= 0)
355 ((unsigned long *)ap->ob_item)[i] = x;
356 return 0;
Guido van Rossum549ab711997-01-03 19:09:47 +0000357}
358
Meador Inge1c9f0c92011-09-20 19:55:51 -0500359#ifdef HAVE_LONG_LONG
360
361static PyObject *
362q_getitem(arrayobject *ap, Py_ssize_t i)
363{
364 return PyLong_FromLongLong(((PY_LONG_LONG *)ap->ob_item)[i]);
365}
366
367static int
368q_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
369{
370 PY_LONG_LONG x;
371 if (!PyArg_Parse(v, "L;array item must be integer", &x))
372 return -1;
373 if (i >= 0)
374 ((PY_LONG_LONG *)ap->ob_item)[i] = x;
375 return 0;
376}
377
378static PyObject *
379QQ_getitem(arrayobject *ap, Py_ssize_t i)
380{
381 return PyLong_FromUnsignedLongLong(
382 ((unsigned PY_LONG_LONG *)ap->ob_item)[i]);
383}
384
385static int
386QQ_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
387{
388 unsigned PY_LONG_LONG x;
389 if (PyLong_Check(v)) {
390 x = PyLong_AsUnsignedLongLong(v);
391 if (x == (unsigned PY_LONG_LONG) -1 && PyErr_Occurred())
392 return -1;
393 }
394 else {
395 PY_LONG_LONG y;
396 if (!PyArg_Parse(v, "L;array item must be integer", &y))
397 return -1;
398 if (y < 0) {
399 PyErr_SetString(PyExc_OverflowError,
400 "unsigned long long is less than minimum");
401 return -1;
402 }
403 x = (unsigned PY_LONG_LONG)y;
404 }
405
406 if (i >= 0)
407 ((unsigned PY_LONG_LONG *)ap->ob_item)[i] = x;
408 return 0;
409}
410#endif
411
Guido van Rossum549ab711997-01-03 19:09:47 +0000412static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000413f_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum778983b1993-02-19 15:55:02 +0000414{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000415 return PyFloat_FromDouble((double) ((float *)ap->ob_item)[i]);
Guido van Rossum778983b1993-02-19 15:55:02 +0000416}
417
418static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000419f_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000420{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000421 float x;
422 if (!PyArg_Parse(v, "f;array item must be float", &x))
423 return -1;
424 if (i >= 0)
425 ((float *)ap->ob_item)[i] = x;
426 return 0;
Guido van Rossum778983b1993-02-19 15:55:02 +0000427}
428
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000429static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000430d_getitem(arrayobject *ap, Py_ssize_t i)
Guido van Rossum778983b1993-02-19 15:55:02 +0000431{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000432 return PyFloat_FromDouble(((double *)ap->ob_item)[i]);
Guido van Rossum778983b1993-02-19 15:55:02 +0000433}
434
435static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000436d_setitem(arrayobject *ap, Py_ssize_t i, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000437{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000438 double x;
439 if (!PyArg_Parse(v, "d;array item must be float", &x))
440 return -1;
441 if (i >= 0)
442 ((double *)ap->ob_item)[i] = x;
443 return 0;
Guido van Rossum778983b1993-02-19 15:55:02 +0000444}
445
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000446
Alexandre Vassalottiad077152009-07-15 17:49:23 +0000447/* Description of types.
448 *
449 * Don't forget to update typecode_to_mformat_code() if you add a new
450 * typecode.
451 */
Guido van Rossum234f9421993-06-17 12:35:49 +0000452static struct arraydescr descriptors[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000453 {'b', 1, b_getitem, b_setitem, "b", 1, 1},
454 {'B', 1, BB_getitem, BB_setitem, "B", 1, 0},
455 {'u', sizeof(Py_UNICODE), u_getitem, u_setitem, "u", 0, 0},
456 {'h', sizeof(short), h_getitem, h_setitem, "h", 1, 1},
457 {'H', sizeof(short), HH_getitem, HH_setitem, "H", 1, 0},
458 {'i', sizeof(int), i_getitem, i_setitem, "i", 1, 1},
459 {'I', sizeof(int), II_getitem, II_setitem, "I", 1, 0},
460 {'l', sizeof(long), l_getitem, l_setitem, "l", 1, 1},
461 {'L', sizeof(long), LL_getitem, LL_setitem, "L", 1, 0},
Meador Inge1c9f0c92011-09-20 19:55:51 -0500462#ifdef HAVE_LONG_LONG
463 {'q', sizeof(PY_LONG_LONG), q_getitem, q_setitem, "q", 1, 1},
464 {'Q', sizeof(PY_LONG_LONG), QQ_getitem, QQ_setitem, "Q", 1, 0},
465#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000466 {'f', sizeof(float), f_getitem, f_setitem, "f", 0, 0},
467 {'d', sizeof(double), d_getitem, d_setitem, "d", 0, 0},
468 {'\0', 0, 0, 0, 0, 0, 0} /* Sentinel */
Guido van Rossum778983b1993-02-19 15:55:02 +0000469};
Tim Petersbb307342000-09-10 05:22:54 +0000470
471/****************************************************************************
472Implementations of array object methods.
473****************************************************************************/
Guido van Rossum778983b1993-02-19 15:55:02 +0000474
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000475static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000476newarrayobject(PyTypeObject *type, Py_ssize_t size, struct arraydescr *descr)
Guido van Rossum778983b1993-02-19 15:55:02 +0000477{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000478 arrayobject *op;
479 size_t nbytes;
Martin v. Löwis99866332002-03-01 10:27:01 +0000480
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000481 if (size < 0) {
482 PyErr_BadInternalCall();
483 return NULL;
484 }
Martin v. Löwis99866332002-03-01 10:27:01 +0000485
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000486 nbytes = size * descr->itemsize;
487 /* Check for overflow */
488 if (nbytes / descr->itemsize != (size_t)size) {
489 return PyErr_NoMemory();
490 }
491 op = (arrayobject *) type->tp_alloc(type, 0);
492 if (op == NULL) {
493 return NULL;
494 }
495 op->ob_descr = descr;
496 op->allocated = size;
497 op->weakreflist = NULL;
498 Py_SIZE(op) = size;
499 if (size <= 0) {
500 op->ob_item = NULL;
501 }
502 else {
503 op->ob_item = PyMem_NEW(char, nbytes);
504 if (op->ob_item == NULL) {
505 Py_DECREF(op);
506 return PyErr_NoMemory();
507 }
508 }
509 op->ob_exports = 0;
510 return (PyObject *) op;
Guido van Rossum778983b1993-02-19 15:55:02 +0000511}
512
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000513static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000514getarrayitem(PyObject *op, Py_ssize_t i)
Guido van Rossum778983b1993-02-19 15:55:02 +0000515{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000516 register arrayobject *ap;
517 assert(array_Check(op));
518 ap = (arrayobject *)op;
519 assert(i>=0 && i<Py_SIZE(ap));
520 return (*ap->ob_descr->getitem)(ap, i);
Guido van Rossum778983b1993-02-19 15:55:02 +0000521}
522
523static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000524ins1(arrayobject *self, Py_ssize_t where, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000525{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000526 char *items;
527 Py_ssize_t n = Py_SIZE(self);
528 if (v == NULL) {
529 PyErr_BadInternalCall();
530 return -1;
531 }
532 if ((*self->ob_descr->setitem)(self, -1, v) < 0)
533 return -1;
Raymond Hettinger6e2ee862004-03-14 04:37:50 +0000534
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000535 if (array_resize(self, n+1) == -1)
536 return -1;
537 items = self->ob_item;
538 if (where < 0) {
539 where += n;
540 if (where < 0)
541 where = 0;
542 }
543 if (where > n)
544 where = n;
545 /* appends don't need to call memmove() */
546 if (where != n)
547 memmove(items + (where+1)*self->ob_descr->itemsize,
548 items + where*self->ob_descr->itemsize,
549 (n-where)*self->ob_descr->itemsize);
550 return (*self->ob_descr->setitem)(self, where, v);
Guido van Rossum778983b1993-02-19 15:55:02 +0000551}
552
Guido van Rossum778983b1993-02-19 15:55:02 +0000553/* Methods */
554
555static void
Peter Schneider-Kamp9656abd2000-07-13 21:10:57 +0000556array_dealloc(arrayobject *op)
Guido van Rossum778983b1993-02-19 15:55:02 +0000557{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000558 if (op->weakreflist != NULL)
559 PyObject_ClearWeakRefs((PyObject *) op);
560 if (op->ob_item != NULL)
561 PyMem_DEL(op->ob_item);
562 Py_TYPE(op)->tp_free((PyObject *)op);
Guido van Rossum778983b1993-02-19 15:55:02 +0000563}
564
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000565static PyObject *
566array_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossum778983b1993-02-19 15:55:02 +0000567{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000568 arrayobject *va, *wa;
569 PyObject *vi = NULL;
570 PyObject *wi = NULL;
571 Py_ssize_t i, k;
572 PyObject *res;
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000573
Brian Curtindfc80e32011-08-10 20:28:54 -0500574 if (!array_Check(v) || !array_Check(w))
575 Py_RETURN_NOTIMPLEMENTED;
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000576
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000577 va = (arrayobject *)v;
578 wa = (arrayobject *)w;
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000579
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000580 if (Py_SIZE(va) != Py_SIZE(wa) && (op == Py_EQ || op == Py_NE)) {
581 /* Shortcut: if the lengths differ, the arrays differ */
582 if (op == Py_EQ)
583 res = Py_False;
584 else
585 res = Py_True;
586 Py_INCREF(res);
587 return res;
588 }
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000589
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000590 /* Search for the first index where items are different */
591 k = 1;
592 for (i = 0; i < Py_SIZE(va) && i < Py_SIZE(wa); i++) {
593 vi = getarrayitem(v, i);
594 wi = getarrayitem(w, i);
595 if (vi == NULL || wi == NULL) {
596 Py_XDECREF(vi);
597 Py_XDECREF(wi);
598 return NULL;
599 }
600 k = PyObject_RichCompareBool(vi, wi, Py_EQ);
601 if (k == 0)
602 break; /* Keeping vi and wi alive! */
603 Py_DECREF(vi);
604 Py_DECREF(wi);
605 if (k < 0)
606 return NULL;
607 }
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000608
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000609 if (k) {
610 /* No more items to compare -- compare sizes */
611 Py_ssize_t vs = Py_SIZE(va);
612 Py_ssize_t ws = Py_SIZE(wa);
613 int cmp;
614 switch (op) {
615 case Py_LT: cmp = vs < ws; break;
616 case Py_LE: cmp = vs <= ws; break;
617 case Py_EQ: cmp = vs == ws; break;
618 case Py_NE: cmp = vs != ws; break;
619 case Py_GT: cmp = vs > ws; break;
620 case Py_GE: cmp = vs >= ws; break;
621 default: return NULL; /* cannot happen */
622 }
623 if (cmp)
624 res = Py_True;
625 else
626 res = Py_False;
627 Py_INCREF(res);
628 return res;
629 }
Guido van Rossum9d19cb82001-01-18 01:02:55 +0000630
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000631 /* We have an item that differs. First, shortcuts for EQ/NE */
632 if (op == Py_EQ) {
633 Py_INCREF(Py_False);
634 res = Py_False;
635 }
636 else if (op == Py_NE) {
637 Py_INCREF(Py_True);
638 res = Py_True;
639 }
640 else {
641 /* Compare the final item again using the proper operator */
642 res = PyObject_RichCompare(vi, wi, op);
643 }
644 Py_DECREF(vi);
645 Py_DECREF(wi);
646 return res;
Guido van Rossum778983b1993-02-19 15:55:02 +0000647}
648
Martin v. Löwis18e16552006-02-15 17:27:45 +0000649static Py_ssize_t
Peter Schneider-Kamp9656abd2000-07-13 21:10:57 +0000650array_length(arrayobject *a)
Guido van Rossum778983b1993-02-19 15:55:02 +0000651{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000652 return Py_SIZE(a);
Guido van Rossum778983b1993-02-19 15:55:02 +0000653}
654
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000655static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000656array_item(arrayobject *a, Py_ssize_t i)
Guido van Rossum778983b1993-02-19 15:55:02 +0000657{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000658 if (i < 0 || i >= Py_SIZE(a)) {
659 PyErr_SetString(PyExc_IndexError, "array index out of range");
660 return NULL;
661 }
662 return getarrayitem((PyObject *)a, i);
Guido van Rossum778983b1993-02-19 15:55:02 +0000663}
664
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000665static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000666array_slice(arrayobject *a, Py_ssize_t ilow, Py_ssize_t ihigh)
Guido van Rossum778983b1993-02-19 15:55:02 +0000667{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000668 arrayobject *np;
669 if (ilow < 0)
670 ilow = 0;
671 else if (ilow > Py_SIZE(a))
672 ilow = Py_SIZE(a);
673 if (ihigh < 0)
674 ihigh = 0;
675 if (ihigh < ilow)
676 ihigh = ilow;
677 else if (ihigh > Py_SIZE(a))
678 ihigh = Py_SIZE(a);
679 np = (arrayobject *) newarrayobject(&Arraytype, ihigh - ilow, a->ob_descr);
680 if (np == NULL)
681 return NULL;
682 memcpy(np->ob_item, a->ob_item + ilow * a->ob_descr->itemsize,
683 (ihigh-ilow) * a->ob_descr->itemsize);
684 return (PyObject *)np;
Guido van Rossum778983b1993-02-19 15:55:02 +0000685}
686
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000687static PyObject *
Raymond Hettinger3aa82c02004-03-13 18:18:51 +0000688array_copy(arrayobject *a, PyObject *unused)
689{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000690 return array_slice(a, 0, Py_SIZE(a));
Raymond Hettinger3aa82c02004-03-13 18:18:51 +0000691}
692
693PyDoc_STRVAR(copy_doc,
694"copy(array)\n\
695\n\
696 Return a copy of the array.");
697
698static PyObject *
Peter Schneider-Kamp9656abd2000-07-13 21:10:57 +0000699array_concat(arrayobject *a, PyObject *bb)
Guido van Rossum778983b1993-02-19 15:55:02 +0000700{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000701 Py_ssize_t size;
702 arrayobject *np;
703 if (!array_Check(bb)) {
704 PyErr_Format(PyExc_TypeError,
705 "can only append array (not \"%.200s\") to array",
706 Py_TYPE(bb)->tp_name);
707 return NULL;
708 }
Guido van Rossum778983b1993-02-19 15:55:02 +0000709#define b ((arrayobject *)bb)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000710 if (a->ob_descr != b->ob_descr) {
711 PyErr_BadArgument();
712 return NULL;
713 }
714 if (Py_SIZE(a) > PY_SSIZE_T_MAX - Py_SIZE(b)) {
715 return PyErr_NoMemory();
716 }
717 size = Py_SIZE(a) + Py_SIZE(b);
718 np = (arrayobject *) newarrayobject(&Arraytype, size, a->ob_descr);
719 if (np == NULL) {
720 return NULL;
721 }
722 memcpy(np->ob_item, a->ob_item, Py_SIZE(a)*a->ob_descr->itemsize);
723 memcpy(np->ob_item + Py_SIZE(a)*a->ob_descr->itemsize,
724 b->ob_item, Py_SIZE(b)*b->ob_descr->itemsize);
725 return (PyObject *)np;
Guido van Rossum778983b1993-02-19 15:55:02 +0000726#undef b
727}
728
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000729static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000730array_repeat(arrayobject *a, Py_ssize_t n)
Guido van Rossum778983b1993-02-19 15:55:02 +0000731{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000732 Py_ssize_t size;
733 arrayobject *np;
Georg Brandlc29cc6a2010-12-04 11:02:04 +0000734 Py_ssize_t oldbytes, newbytes;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000735 if (n < 0)
736 n = 0;
737 if ((Py_SIZE(a) != 0) && (n > PY_SSIZE_T_MAX / Py_SIZE(a))) {
738 return PyErr_NoMemory();
739 }
740 size = Py_SIZE(a) * n;
741 np = (arrayobject *) newarrayobject(&Arraytype, size, a->ob_descr);
742 if (np == NULL)
743 return NULL;
Georg Brandlc29cc6a2010-12-04 11:02:04 +0000744 if (n == 0)
745 return (PyObject *)np;
746 oldbytes = Py_SIZE(a) * a->ob_descr->itemsize;
747 newbytes = oldbytes * n;
748 /* this follows the code in unicode_repeat */
749 if (oldbytes == 1) {
750 memset(np->ob_item, a->ob_item[0], newbytes);
751 } else {
752 Py_ssize_t done = oldbytes;
753 Py_MEMCPY(np->ob_item, a->ob_item, oldbytes);
754 while (done < newbytes) {
755 Py_ssize_t ncopy = (done <= newbytes-done) ? done : newbytes-done;
756 Py_MEMCPY(np->ob_item+done, np->ob_item, ncopy);
757 done += ncopy;
758 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000759 }
Georg Brandlc29cc6a2010-12-04 11:02:04 +0000760 return (PyObject *)np;
Guido van Rossum778983b1993-02-19 15:55:02 +0000761}
762
763static int
Martin v. Löwisad0a4622006-02-16 14:30:23 +0000764array_ass_slice(arrayobject *a, Py_ssize_t ilow, Py_ssize_t ihigh, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000765{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000766 char *item;
767 Py_ssize_t n; /* Size of replacement array */
768 Py_ssize_t d; /* Change in size */
Guido van Rossum778983b1993-02-19 15:55:02 +0000769#define b ((arrayobject *)v)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000770 if (v == NULL)
771 n = 0;
772 else if (array_Check(v)) {
773 n = Py_SIZE(b);
774 if (a == b) {
775 /* Special case "a[i:j] = a" -- copy b first */
776 int ret;
777 v = array_slice(b, 0, n);
778 if (!v)
779 return -1;
780 ret = array_ass_slice(a, ilow, ihigh, v);
781 Py_DECREF(v);
782 return ret;
783 }
784 if (b->ob_descr != a->ob_descr) {
785 PyErr_BadArgument();
786 return -1;
787 }
788 }
789 else {
790 PyErr_Format(PyExc_TypeError,
791 "can only assign array (not \"%.200s\") to array slice",
792 Py_TYPE(v)->tp_name);
793 return -1;
794 }
795 if (ilow < 0)
796 ilow = 0;
797 else if (ilow > Py_SIZE(a))
798 ilow = Py_SIZE(a);
799 if (ihigh < 0)
800 ihigh = 0;
801 if (ihigh < ilow)
802 ihigh = ilow;
803 else if (ihigh > Py_SIZE(a))
804 ihigh = Py_SIZE(a);
805 item = a->ob_item;
806 d = n - (ihigh-ilow);
807 /* Issue #4509: If the array has exported buffers and the slice
808 assignment would change the size of the array, fail early to make
809 sure we don't modify it. */
810 if (d != 0 && a->ob_exports > 0) {
811 PyErr_SetString(PyExc_BufferError,
812 "cannot resize an array that is exporting buffers");
813 return -1;
814 }
815 if (d < 0) { /* Delete -d items */
816 memmove(item + (ihigh+d)*a->ob_descr->itemsize,
817 item + ihigh*a->ob_descr->itemsize,
818 (Py_SIZE(a)-ihigh)*a->ob_descr->itemsize);
819 if (array_resize(a, Py_SIZE(a) + d) == -1)
820 return -1;
821 }
822 else if (d > 0) { /* Insert d items */
823 if (array_resize(a, Py_SIZE(a) + d))
824 return -1;
825 memmove(item + (ihigh+d)*a->ob_descr->itemsize,
826 item + ihigh*a->ob_descr->itemsize,
827 (Py_SIZE(a)-ihigh)*a->ob_descr->itemsize);
828 }
829 if (n > 0)
830 memcpy(item + ilow*a->ob_descr->itemsize, b->ob_item,
831 n*b->ob_descr->itemsize);
832 return 0;
Guido van Rossum778983b1993-02-19 15:55:02 +0000833#undef b
834}
835
836static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000837array_ass_item(arrayobject *a, Py_ssize_t i, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000838{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000839 if (i < 0 || i >= Py_SIZE(a)) {
840 PyErr_SetString(PyExc_IndexError,
841 "array assignment index out of range");
842 return -1;
843 }
844 if (v == NULL)
845 return array_ass_slice(a, i, i+1, v);
846 return (*a->ob_descr->setitem)(a, i, v);
Guido van Rossum778983b1993-02-19 15:55:02 +0000847}
848
849static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000850setarrayitem(PyObject *a, Py_ssize_t i, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000851{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000852 assert(array_Check(a));
853 return array_ass_item((arrayobject *)a, i, v);
Guido van Rossum778983b1993-02-19 15:55:02 +0000854}
855
Martin v. Löwis99866332002-03-01 10:27:01 +0000856static int
Raymond Hettinger49f9bd12004-03-14 05:43:59 +0000857array_iter_extend(arrayobject *self, PyObject *bb)
858{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000859 PyObject *it, *v;
Raymond Hettinger49f9bd12004-03-14 05:43:59 +0000860
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000861 it = PyObject_GetIter(bb);
862 if (it == NULL)
863 return -1;
Raymond Hettinger49f9bd12004-03-14 05:43:59 +0000864
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000865 while ((v = PyIter_Next(it)) != NULL) {
Mark Dickinson346f0af2010-08-06 09:36:57 +0000866 if (ins1(self, Py_SIZE(self), v) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000867 Py_DECREF(v);
868 Py_DECREF(it);
869 return -1;
870 }
871 Py_DECREF(v);
872 }
873 Py_DECREF(it);
874 if (PyErr_Occurred())
875 return -1;
876 return 0;
Raymond Hettinger49f9bd12004-03-14 05:43:59 +0000877}
878
879static int
Martin v. Löwis99866332002-03-01 10:27:01 +0000880array_do_extend(arrayobject *self, PyObject *bb)
881{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000882 Py_ssize_t size, oldsize, bbsize;
Martin v. Löwis99866332002-03-01 10:27:01 +0000883
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000884 if (!array_Check(bb))
885 return array_iter_extend(self, bb);
886#define b ((arrayobject *)bb)
887 if (self->ob_descr != b->ob_descr) {
888 PyErr_SetString(PyExc_TypeError,
889 "can only extend with array of same kind");
890 return -1;
891 }
892 if ((Py_SIZE(self) > PY_SSIZE_T_MAX - Py_SIZE(b)) ||
893 ((Py_SIZE(self) + Py_SIZE(b)) > PY_SSIZE_T_MAX / self->ob_descr->itemsize)) {
894 PyErr_NoMemory();
895 return -1;
896 }
897 oldsize = Py_SIZE(self);
898 /* Get the size of bb before resizing the array since bb could be self. */
899 bbsize = Py_SIZE(bb);
900 size = oldsize + Py_SIZE(b);
901 if (array_resize(self, size) == -1)
902 return -1;
903 memcpy(self->ob_item + oldsize * self->ob_descr->itemsize,
904 b->ob_item, bbsize * b->ob_descr->itemsize);
905
906 return 0;
Martin v. Löwis99866332002-03-01 10:27:01 +0000907#undef b
908}
909
910static PyObject *
911array_inplace_concat(arrayobject *self, PyObject *bb)
912{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000913 if (!array_Check(bb)) {
914 PyErr_Format(PyExc_TypeError,
915 "can only extend array with array (not \"%.200s\")",
916 Py_TYPE(bb)->tp_name);
917 return NULL;
918 }
919 if (array_do_extend(self, bb) == -1)
920 return NULL;
921 Py_INCREF(self);
922 return (PyObject *)self;
Martin v. Löwis99866332002-03-01 10:27:01 +0000923}
924
925static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000926array_inplace_repeat(arrayobject *self, Py_ssize_t n)
Martin v. Löwis99866332002-03-01 10:27:01 +0000927{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000928 char *items, *p;
929 Py_ssize_t size, i;
Martin v. Löwis99866332002-03-01 10:27:01 +0000930
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000931 if (Py_SIZE(self) > 0) {
932 if (n < 0)
933 n = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000934 if ((self->ob_descr->itemsize != 0) &&
935 (Py_SIZE(self) > PY_SSIZE_T_MAX / self->ob_descr->itemsize)) {
936 return PyErr_NoMemory();
937 }
938 size = Py_SIZE(self) * self->ob_descr->itemsize;
939 if (n > 0 && size > PY_SSIZE_T_MAX / n) {
940 return PyErr_NoMemory();
941 }
942 if (array_resize(self, n * Py_SIZE(self)) == -1)
943 return NULL;
944 items = p = self->ob_item;
945 for (i = 1; i < n; i++) {
946 p += size;
947 memcpy(p, items, size);
948 }
949 }
950 Py_INCREF(self);
951 return (PyObject *)self;
Martin v. Löwis99866332002-03-01 10:27:01 +0000952}
953
954
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000955static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000956ins(arrayobject *self, Py_ssize_t where, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +0000957{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000958 if (ins1(self, where, v) != 0)
959 return NULL;
960 Py_INCREF(Py_None);
961 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +0000962}
963
Roger E. Masse2919eaa1996-12-09 20:10:36 +0000964static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000965array_count(arrayobject *self, PyObject *v)
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000966{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000967 Py_ssize_t count = 0;
968 Py_ssize_t i;
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000969
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000970 for (i = 0; i < Py_SIZE(self); i++) {
971 PyObject *selfi = getarrayitem((PyObject *)self, i);
972 int cmp = PyObject_RichCompareBool(selfi, v, Py_EQ);
973 Py_DECREF(selfi);
974 if (cmp > 0)
975 count++;
976 else if (cmp < 0)
977 return NULL;
978 }
979 return PyLong_FromSsize_t(count);
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000980}
981
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000982PyDoc_STRVAR(count_doc,
Tim Peters077a11d2000-09-16 22:31:29 +0000983"count(x)\n\
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000984\n\
Mark Dickinson934896d2009-02-21 20:59:32 +0000985Return number of occurrences of x in the array.");
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000986
987static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000988array_index(arrayobject *self, PyObject *v)
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000989{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000990 Py_ssize_t i;
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +0000991
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000992 for (i = 0; i < Py_SIZE(self); i++) {
993 PyObject *selfi = getarrayitem((PyObject *)self, i);
994 int cmp = PyObject_RichCompareBool(selfi, v, Py_EQ);
995 Py_DECREF(selfi);
996 if (cmp > 0) {
997 return PyLong_FromLong((long)i);
998 }
999 else if (cmp < 0)
1000 return NULL;
1001 }
1002 PyErr_SetString(PyExc_ValueError, "array.index(x): x not in list");
1003 return NULL;
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001004}
1005
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001006PyDoc_STRVAR(index_doc,
Tim Peters077a11d2000-09-16 22:31:29 +00001007"index(x)\n\
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001008\n\
Mark Dickinson934896d2009-02-21 20:59:32 +00001009Return index of first occurrence of x in the array.");
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001010
Raymond Hettinger625812f2003-01-07 01:58:52 +00001011static int
1012array_contains(arrayobject *self, PyObject *v)
1013{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001014 Py_ssize_t i;
1015 int cmp;
Raymond Hettinger625812f2003-01-07 01:58:52 +00001016
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001017 for (i = 0, cmp = 0 ; cmp == 0 && i < Py_SIZE(self); i++) {
1018 PyObject *selfi = getarrayitem((PyObject *)self, i);
1019 cmp = PyObject_RichCompareBool(selfi, v, Py_EQ);
1020 Py_DECREF(selfi);
1021 }
1022 return cmp;
Raymond Hettinger625812f2003-01-07 01:58:52 +00001023}
1024
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001025static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001026array_remove(arrayobject *self, PyObject *v)
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001027{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001028 int i;
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001029
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001030 for (i = 0; i < Py_SIZE(self); i++) {
1031 PyObject *selfi = getarrayitem((PyObject *)self,i);
1032 int cmp = PyObject_RichCompareBool(selfi, v, Py_EQ);
1033 Py_DECREF(selfi);
1034 if (cmp > 0) {
1035 if (array_ass_slice(self, i, i+1,
1036 (PyObject *)NULL) != 0)
1037 return NULL;
1038 Py_INCREF(Py_None);
1039 return Py_None;
1040 }
1041 else if (cmp < 0)
1042 return NULL;
1043 }
1044 PyErr_SetString(PyExc_ValueError, "array.remove(x): x not in list");
1045 return NULL;
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001046}
1047
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001048PyDoc_STRVAR(remove_doc,
Tim Peters077a11d2000-09-16 22:31:29 +00001049"remove(x)\n\
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001050\n\
Mark Dickinson934896d2009-02-21 20:59:32 +00001051Remove the first occurrence of x in the array.");
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001052
1053static PyObject *
1054array_pop(arrayobject *self, PyObject *args)
1055{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001056 Py_ssize_t i = -1;
1057 PyObject *v;
1058 if (!PyArg_ParseTuple(args, "|n:pop", &i))
1059 return NULL;
1060 if (Py_SIZE(self) == 0) {
1061 /* Special-case most common failure cause */
1062 PyErr_SetString(PyExc_IndexError, "pop from empty array");
1063 return NULL;
1064 }
1065 if (i < 0)
1066 i += Py_SIZE(self);
1067 if (i < 0 || i >= Py_SIZE(self)) {
1068 PyErr_SetString(PyExc_IndexError, "pop index out of range");
1069 return NULL;
1070 }
1071 v = getarrayitem((PyObject *)self,i);
1072 if (array_ass_slice(self, i, i+1, (PyObject *)NULL) != 0) {
1073 Py_DECREF(v);
1074 return NULL;
1075 }
1076 return v;
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001077}
1078
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001079PyDoc_STRVAR(pop_doc,
Tim Peters077a11d2000-09-16 22:31:29 +00001080"pop([i])\n\
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001081\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001082Return the i-th element and delete it from the array. i defaults to -1.");
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001083
1084static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001085array_extend(arrayobject *self, PyObject *bb)
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001086{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001087 if (array_do_extend(self, bb) == -1)
1088 return NULL;
1089 Py_INCREF(Py_None);
1090 return Py_None;
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001091}
1092
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001093PyDoc_STRVAR(extend_doc,
Raymond Hettinger49f9bd12004-03-14 05:43:59 +00001094"extend(array or iterable)\n\
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001095\n\
Raymond Hettinger49f9bd12004-03-14 05:43:59 +00001096 Append items to the end of the array.");
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00001097
1098static PyObject *
Peter Schneider-Kamp9656abd2000-07-13 21:10:57 +00001099array_insert(arrayobject *self, PyObject *args)
Guido van Rossum778983b1993-02-19 15:55:02 +00001100{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001101 Py_ssize_t i;
1102 PyObject *v;
1103 if (!PyArg_ParseTuple(args, "nO:insert", &i, &v))
1104 return NULL;
1105 return ins(self, i, v);
Guido van Rossum778983b1993-02-19 15:55:02 +00001106}
1107
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001108PyDoc_STRVAR(insert_doc,
Tim Peters077a11d2000-09-16 22:31:29 +00001109"insert(i,x)\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001110\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001111Insert a new item x into the array before position i.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001112
1113
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001114static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001115array_buffer_info(arrayobject *self, PyObject *unused)
Guido van Rossumde4a4ca1997-08-12 14:55:56 +00001116{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001117 PyObject* retval = NULL;
1118 retval = PyTuple_New(2);
1119 if (!retval)
1120 return NULL;
Fred Drake541dc3b2000-06-28 17:49:30 +00001121
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001122 PyTuple_SET_ITEM(retval, 0, PyLong_FromVoidPtr(self->ob_item));
1123 PyTuple_SET_ITEM(retval, 1, PyLong_FromLong((long)(Py_SIZE(self))));
Fred Drake541dc3b2000-06-28 17:49:30 +00001124
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001125 return retval;
Guido van Rossumde4a4ca1997-08-12 14:55:56 +00001126}
1127
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001128PyDoc_STRVAR(buffer_info_doc,
Tim Peters077a11d2000-09-16 22:31:29 +00001129"buffer_info() -> (address, length)\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001130\n\
1131Return a tuple (address, length) giving the current memory address and\n\
Guido van Rossum702d08e2001-07-27 16:05:32 +00001132the length in items of the buffer used to hold array's contents\n\
1133The length should be multiplied by the itemsize attribute to calculate\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001134the buffer length in bytes.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001135
1136
Guido van Rossumde4a4ca1997-08-12 14:55:56 +00001137static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001138array_append(arrayobject *self, PyObject *v)
Guido van Rossum778983b1993-02-19 15:55:02 +00001139{
Mark Dickinson346f0af2010-08-06 09:36:57 +00001140 return ins(self, Py_SIZE(self), v);
Guido van Rossum778983b1993-02-19 15:55:02 +00001141}
1142
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001143PyDoc_STRVAR(append_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001144"append(x)\n\
1145\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001146Append new value x to the end of the array.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001147
1148
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001149static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001150array_byteswap(arrayobject *self, PyObject *unused)
Guido van Rossum778983b1993-02-19 15:55:02 +00001151{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001152 char *p;
1153 Py_ssize_t i;
Fred Drakebf272981999-12-03 17:15:30 +00001154
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001155 switch (self->ob_descr->itemsize) {
1156 case 1:
1157 break;
1158 case 2:
1159 for (p = self->ob_item, i = Py_SIZE(self); --i >= 0; p += 2) {
1160 char p0 = p[0];
1161 p[0] = p[1];
1162 p[1] = p0;
1163 }
1164 break;
1165 case 4:
1166 for (p = self->ob_item, i = Py_SIZE(self); --i >= 0; p += 4) {
1167 char p0 = p[0];
1168 char p1 = p[1];
1169 p[0] = p[3];
1170 p[1] = p[2];
1171 p[2] = p1;
1172 p[3] = p0;
1173 }
1174 break;
1175 case 8:
1176 for (p = self->ob_item, i = Py_SIZE(self); --i >= 0; p += 8) {
1177 char p0 = p[0];
1178 char p1 = p[1];
1179 char p2 = p[2];
1180 char p3 = p[3];
1181 p[0] = p[7];
1182 p[1] = p[6];
1183 p[2] = p[5];
1184 p[3] = p[4];
1185 p[4] = p3;
1186 p[5] = p2;
1187 p[6] = p1;
1188 p[7] = p0;
1189 }
1190 break;
1191 default:
1192 PyErr_SetString(PyExc_RuntimeError,
1193 "don't know how to byteswap this array type");
1194 return NULL;
1195 }
1196 Py_INCREF(Py_None);
1197 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +00001198}
1199
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001200PyDoc_STRVAR(byteswap_doc,
Fred Drakebf272981999-12-03 17:15:30 +00001201"byteswap()\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001202\n\
Fred Drakebf272981999-12-03 17:15:30 +00001203Byteswap 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 +000012044, or 8 bytes in size, RuntimeError is raised.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001205
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001206static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001207array_reverse(arrayobject *self, PyObject *unused)
Guido van Rossum778983b1993-02-19 15:55:02 +00001208{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001209 register Py_ssize_t itemsize = self->ob_descr->itemsize;
1210 register char *p, *q;
1211 /* little buffer to hold items while swapping */
1212 char tmp[256]; /* 8 is probably enough -- but why skimp */
1213 assert((size_t)itemsize <= sizeof(tmp));
Guido van Rossume77a7571993-11-03 15:01:26 +00001214
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001215 if (Py_SIZE(self) > 1) {
1216 for (p = self->ob_item,
1217 q = self->ob_item + (Py_SIZE(self) - 1)*itemsize;
1218 p < q;
1219 p += itemsize, q -= itemsize) {
1220 /* memory areas guaranteed disjoint, so memcpy
1221 * is safe (& memmove may be slower).
1222 */
1223 memcpy(tmp, p, itemsize);
1224 memcpy(p, q, itemsize);
1225 memcpy(q, tmp, itemsize);
1226 }
1227 }
Tim Petersbb307342000-09-10 05:22:54 +00001228
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001229 Py_INCREF(Py_None);
1230 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +00001231}
Guido van Rossume77a7571993-11-03 15:01:26 +00001232
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001233PyDoc_STRVAR(reverse_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001234"reverse()\n\
1235\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001236Reverse the order of the items in the array.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001237
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001238
1239/* Forward */
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001240static PyObject *array_frombytes(arrayobject *self, PyObject *args);
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001241
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001242static PyObject *
Peter Schneider-Kamp9656abd2000-07-13 21:10:57 +00001243array_fromfile(arrayobject *self, PyObject *args)
Guido van Rossum778983b1993-02-19 15:55:02 +00001244{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001245 PyObject *f, *b, *res;
1246 Py_ssize_t itemsize = self->ob_descr->itemsize;
1247 Py_ssize_t n, nbytes;
1248 int not_enough_bytes;
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001249
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001250 if (!PyArg_ParseTuple(args, "On:fromfile", &f, &n))
1251 return NULL;
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001252
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001253 nbytes = n * itemsize;
1254 if (nbytes < 0 || nbytes/itemsize != n) {
1255 PyErr_NoMemory();
1256 return NULL;
1257 }
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001258
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001259 b = PyObject_CallMethod(f, "read", "n", nbytes);
1260 if (b == NULL)
1261 return NULL;
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001262
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001263 if (!PyBytes_Check(b)) {
1264 PyErr_SetString(PyExc_TypeError,
1265 "read() didn't return bytes");
1266 Py_DECREF(b);
1267 return NULL;
1268 }
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001269
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001270 not_enough_bytes = (PyBytes_GET_SIZE(b) != nbytes);
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001271
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001272 args = Py_BuildValue("(O)", b);
1273 Py_DECREF(b);
1274 if (args == NULL)
1275 return NULL;
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001276
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001277 res = array_frombytes(self, args);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001278 Py_DECREF(args);
1279 if (res == NULL)
1280 return NULL;
Hirokazu Yamamoto54d0df62009-03-06 03:04:07 +00001281
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001282 if (not_enough_bytes) {
1283 PyErr_SetString(PyExc_EOFError,
1284 "read() didn't return enough bytes");
1285 Py_DECREF(res);
1286 return NULL;
1287 }
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001288
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001289 return res;
Guido van Rossum778983b1993-02-19 15:55:02 +00001290}
1291
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001292PyDoc_STRVAR(fromfile_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001293"fromfile(f, n)\n\
1294\n\
1295Read n objects from the file object f and append them to the end of the\n\
Georg Brandlf25ef502008-02-01 11:30:18 +00001296array.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001297
1298
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001299static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001300array_tofile(arrayobject *self, PyObject *f)
Guido van Rossum778983b1993-02-19 15:55:02 +00001301{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001302 Py_ssize_t nbytes = Py_SIZE(self) * self->ob_descr->itemsize;
1303 /* Write 64K blocks at a time */
1304 /* XXX Make the block size settable */
1305 int BLOCKSIZE = 64*1024;
1306 Py_ssize_t nblocks = (nbytes + BLOCKSIZE - 1) / BLOCKSIZE;
1307 Py_ssize_t i;
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001308
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001309 if (Py_SIZE(self) == 0)
1310 goto done;
Guido van Rossumb5ddcfd2007-04-11 17:08:28 +00001311
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001312 for (i = 0; i < nblocks; i++) {
1313 char* ptr = self->ob_item + i*BLOCKSIZE;
1314 Py_ssize_t size = BLOCKSIZE;
1315 PyObject *bytes, *res;
1316 if (i*BLOCKSIZE + size > nbytes)
1317 size = nbytes - i*BLOCKSIZE;
1318 bytes = PyBytes_FromStringAndSize(ptr, size);
1319 if (bytes == NULL)
1320 return NULL;
1321 res = PyObject_CallMethod(f, "write", "O", bytes);
1322 Py_DECREF(bytes);
1323 if (res == NULL)
1324 return NULL;
1325 Py_DECREF(res); /* drop write result */
1326 }
Guido van Rossumb5ddcfd2007-04-11 17:08:28 +00001327
1328 done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001329 Py_INCREF(Py_None);
1330 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +00001331}
1332
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001333PyDoc_STRVAR(tofile_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001334"tofile(f)\n\
1335\n\
Georg Brandlf25ef502008-02-01 11:30:18 +00001336Write all items (as machine values) to the file object f.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001337
1338
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001339static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001340array_fromlist(arrayobject *self, PyObject *list)
Guido van Rossum778983b1993-02-19 15:55:02 +00001341{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001342 Py_ssize_t n;
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001343
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001344 if (!PyList_Check(list)) {
1345 PyErr_SetString(PyExc_TypeError, "arg must be list");
1346 return NULL;
1347 }
1348 n = PyList_Size(list);
1349 if (n > 0) {
1350 Py_ssize_t i, old_size;
1351 old_size = Py_SIZE(self);
1352 if (array_resize(self, old_size + n) == -1)
1353 return NULL;
1354 for (i = 0; i < n; i++) {
1355 PyObject *v = PyList_GetItem(list, i);
1356 if ((*self->ob_descr->setitem)(self,
1357 Py_SIZE(self) - n + i, v) != 0) {
1358 array_resize(self, old_size);
1359 return NULL;
1360 }
1361 }
1362 }
1363 Py_INCREF(Py_None);
1364 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +00001365}
1366
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001367PyDoc_STRVAR(fromlist_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001368"fromlist(list)\n\
1369\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001370Append items to array from list.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001371
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001372static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001373array_tolist(arrayobject *self, PyObject *unused)
Guido van Rossum778983b1993-02-19 15:55:02 +00001374{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001375 PyObject *list = PyList_New(Py_SIZE(self));
1376 Py_ssize_t i;
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001377
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001378 if (list == NULL)
1379 return NULL;
1380 for (i = 0; i < Py_SIZE(self); i++) {
1381 PyObject *v = getarrayitem((PyObject *)self, i);
1382 if (v == NULL) {
1383 Py_DECREF(list);
1384 return NULL;
1385 }
1386 PyList_SetItem(list, i, v);
1387 }
1388 return list;
Guido van Rossum778983b1993-02-19 15:55:02 +00001389}
1390
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001391PyDoc_STRVAR(tolist_doc,
Guido van Rossumfc6aba51998-10-14 02:52:31 +00001392"tolist() -> list\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001393\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001394Convert array to an ordinary list with the same items.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001395
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001396static PyObject *
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001397frombytes(arrayobject *self, Py_buffer *buffer)
Guido van Rossum778983b1993-02-19 15:55:02 +00001398{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001399 int itemsize = self->ob_descr->itemsize;
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001400 Py_ssize_t n;
1401 if (buffer->itemsize != 1) {
1402 PyBuffer_Release(buffer);
1403 PyErr_SetString(PyExc_TypeError, "string/buffer of bytes required.");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001404 return NULL;
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001405 }
1406 n = buffer->len;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001407 if (n % itemsize != 0) {
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001408 PyBuffer_Release(buffer);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001409 PyErr_SetString(PyExc_ValueError,
1410 "string length not a multiple of item size");
1411 return NULL;
1412 }
1413 n = n / itemsize;
1414 if (n > 0) {
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001415 Py_ssize_t old_size = Py_SIZE(self);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001416 if ((n > PY_SSIZE_T_MAX - old_size) ||
1417 ((old_size + n) > PY_SSIZE_T_MAX / itemsize)) {
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001418 PyBuffer_Release(buffer);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001419 return PyErr_NoMemory();
1420 }
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001421 if (array_resize(self, old_size + n) == -1) {
1422 PyBuffer_Release(buffer);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001423 return NULL;
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001424 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001425 memcpy(self->ob_item + old_size * itemsize,
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001426 buffer->buf, n * itemsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001427 }
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001428 PyBuffer_Release(buffer);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001429 Py_INCREF(Py_None);
1430 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +00001431}
1432
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001433static PyObject *
1434array_fromstring(arrayobject *self, PyObject *args)
1435{
1436 Py_buffer buffer;
1437 if (PyErr_WarnEx(PyExc_DeprecationWarning,
1438 "fromstring() is deprecated. Use frombytes() instead.", 2) != 0)
1439 return NULL;
1440 if (!PyArg_ParseTuple(args, "s*:fromstring", &buffer))
1441 return NULL;
1442 else
1443 return frombytes(self, &buffer);
1444}
1445
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001446PyDoc_STRVAR(fromstring_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001447"fromstring(string)\n\
1448\n\
1449Appends items from the string, interpreting it as an array of machine\n\
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001450values, as if it had been read from a file using the fromfile() method).\n\
1451\n\
1452This method is deprecated. Use frombytes instead.");
1453
1454
1455static PyObject *
1456array_frombytes(arrayobject *self, PyObject *args)
1457{
1458 Py_buffer buffer;
1459 if (!PyArg_ParseTuple(args, "y*:frombytes", &buffer))
1460 return NULL;
1461 else
1462 return frombytes(self, &buffer);
1463}
1464
1465PyDoc_STRVAR(frombytes_doc,
1466"frombytes(bytestring)\n\
1467\n\
1468Appends items from the string, interpreting it as an array of machine\n\
Walter Dörwald93b30b52007-06-22 12:21:53 +00001469values, as if it had been read from a file using the fromfile() method).");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001470
1471
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001472static PyObject *
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001473array_tobytes(arrayobject *self, PyObject *unused)
Guido van Rossum778983b1993-02-19 15:55:02 +00001474{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001475 if (Py_SIZE(self) <= PY_SSIZE_T_MAX / self->ob_descr->itemsize) {
1476 return PyBytes_FromStringAndSize(self->ob_item,
1477 Py_SIZE(self) * self->ob_descr->itemsize);
1478 } else {
1479 return PyErr_NoMemory();
1480 }
Guido van Rossum778983b1993-02-19 15:55:02 +00001481}
1482
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001483PyDoc_STRVAR(tobytes_doc,
1484"tobytes() -> bytes\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001485\n\
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001486Convert the array to an array of machine values and return the bytes\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001487representation.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001488
Martin v. Löwis99866332002-03-01 10:27:01 +00001489
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001490static PyObject *
1491array_tostring(arrayobject *self, PyObject *unused)
1492{
Victor Stinner9f0b51e2010-11-09 09:38:30 +00001493 if (PyErr_WarnEx(PyExc_DeprecationWarning,
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001494 "tostring() is deprecated. Use tobytes() instead.", 2) != 0)
1495 return NULL;
1496 return array_tobytes(self, unused);
1497}
1498
1499PyDoc_STRVAR(tostring_doc,
1500"tostring() -> bytes\n\
1501\n\
1502Convert the array to an array of machine values and return the bytes\n\
1503representation.\n\
1504\n\
1505This method is deprecated. Use tobytes instead.");
1506
Martin v. Löwis99866332002-03-01 10:27:01 +00001507
Martin v. Löwis99866332002-03-01 10:27:01 +00001508static PyObject *
1509array_fromunicode(arrayobject *self, PyObject *args)
1510{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001511 Py_UNICODE *ustr;
1512 Py_ssize_t n;
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02001513 char typecode;
Martin v. Löwis99866332002-03-01 10:27:01 +00001514
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001515 if (!PyArg_ParseTuple(args, "u#:fromunicode", &ustr, &n))
1516 return NULL;
1517 typecode = self->ob_descr->typecode;
1518 if ((typecode != 'u')) {
1519 PyErr_SetString(PyExc_ValueError,
1520 "fromunicode() may only be called on "
1521 "unicode type arrays");
1522 return NULL;
1523 }
1524 if (n > 0) {
1525 Py_ssize_t old_size = Py_SIZE(self);
1526 if (array_resize(self, old_size + n) == -1)
1527 return NULL;
1528 memcpy(self->ob_item + old_size * sizeof(Py_UNICODE),
1529 ustr, n * sizeof(Py_UNICODE));
1530 }
Martin v. Löwis99866332002-03-01 10:27:01 +00001531
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001532 Py_INCREF(Py_None);
1533 return Py_None;
Martin v. Löwis99866332002-03-01 10:27:01 +00001534}
1535
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001536PyDoc_STRVAR(fromunicode_doc,
Martin v. Löwis99866332002-03-01 10:27:01 +00001537"fromunicode(ustr)\n\
1538\n\
1539Extends this array with data from the unicode string ustr.\n\
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001540The array must be a unicode type array; otherwise a ValueError\n\
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001541is raised. Use array.frombytes(ustr.decode(...)) to\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001542append Unicode data to an array of some other type.");
Martin v. Löwis99866332002-03-01 10:27:01 +00001543
1544
1545static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001546array_tounicode(arrayobject *self, PyObject *unused)
Martin v. Löwis99866332002-03-01 10:27:01 +00001547{
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02001548 char typecode;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001549 typecode = self->ob_descr->typecode;
1550 if ((typecode != 'u')) {
1551 PyErr_SetString(PyExc_ValueError,
1552 "tounicode() may only be called on unicode type arrays");
1553 return NULL;
1554 }
1555 return PyUnicode_FromUnicode((Py_UNICODE *) self->ob_item, Py_SIZE(self));
Martin v. Löwis99866332002-03-01 10:27:01 +00001556}
1557
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001558PyDoc_STRVAR(tounicode_doc,
Martin v. Löwis99866332002-03-01 10:27:01 +00001559"tounicode() -> unicode\n\
1560\n\
1561Convert the array to a unicode string. The array must be\n\
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001562a unicode type array; otherwise a ValueError is raised. Use\n\
Martin v. Löwis99866332002-03-01 10:27:01 +00001563array.tostring().decode() to obtain a unicode string from\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001564an array of some other type.");
Martin v. Löwis99866332002-03-01 10:27:01 +00001565
Martin v. Löwis99866332002-03-01 10:27:01 +00001566
1567
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001568/*********************** Pickling support ************************/
1569
1570enum machine_format_code {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001571 UNKNOWN_FORMAT = -1,
1572 /* UNKNOWN_FORMAT is used to indicate that the machine format for an
1573 * array type code cannot be interpreted. When this occurs, a list of
1574 * Python objects is used to represent the content of the array
1575 * instead of using the memory content of the array directly. In that
1576 * case, the array_reconstructor mechanism is bypassed completely, and
1577 * the standard array constructor is used instead.
1578 *
1579 * This is will most likely occur when the machine doesn't use IEEE
1580 * floating-point numbers.
1581 */
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001582
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001583 UNSIGNED_INT8 = 0,
1584 SIGNED_INT8 = 1,
1585 UNSIGNED_INT16_LE = 2,
1586 UNSIGNED_INT16_BE = 3,
1587 SIGNED_INT16_LE = 4,
1588 SIGNED_INT16_BE = 5,
1589 UNSIGNED_INT32_LE = 6,
1590 UNSIGNED_INT32_BE = 7,
1591 SIGNED_INT32_LE = 8,
1592 SIGNED_INT32_BE = 9,
1593 UNSIGNED_INT64_LE = 10,
1594 UNSIGNED_INT64_BE = 11,
1595 SIGNED_INT64_LE = 12,
1596 SIGNED_INT64_BE = 13,
1597 IEEE_754_FLOAT_LE = 14,
1598 IEEE_754_FLOAT_BE = 15,
1599 IEEE_754_DOUBLE_LE = 16,
1600 IEEE_754_DOUBLE_BE = 17,
1601 UTF16_LE = 18,
1602 UTF16_BE = 19,
1603 UTF32_LE = 20,
1604 UTF32_BE = 21
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001605};
1606#define MACHINE_FORMAT_CODE_MIN 0
1607#define MACHINE_FORMAT_CODE_MAX 21
1608
1609static const struct mformatdescr {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001610 size_t size;
1611 int is_signed;
1612 int is_big_endian;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001613} mformat_descriptors[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001614 {1, 0, 0}, /* 0: UNSIGNED_INT8 */
1615 {1, 1, 0}, /* 1: SIGNED_INT8 */
1616 {2, 0, 0}, /* 2: UNSIGNED_INT16_LE */
1617 {2, 0, 1}, /* 3: UNSIGNED_INT16_BE */
1618 {2, 1, 0}, /* 4: SIGNED_INT16_LE */
1619 {2, 1, 1}, /* 5: SIGNED_INT16_BE */
1620 {4, 0, 0}, /* 6: UNSIGNED_INT32_LE */
1621 {4, 0, 1}, /* 7: UNSIGNED_INT32_BE */
1622 {4, 1, 0}, /* 8: SIGNED_INT32_LE */
1623 {4, 1, 1}, /* 9: SIGNED_INT32_BE */
1624 {8, 0, 0}, /* 10: UNSIGNED_INT64_LE */
1625 {8, 0, 1}, /* 11: UNSIGNED_INT64_BE */
1626 {8, 1, 0}, /* 12: SIGNED_INT64_LE */
1627 {8, 1, 1}, /* 13: SIGNED_INT64_BE */
1628 {4, 0, 0}, /* 14: IEEE_754_FLOAT_LE */
1629 {4, 0, 1}, /* 15: IEEE_754_FLOAT_BE */
1630 {8, 0, 0}, /* 16: IEEE_754_DOUBLE_LE */
1631 {8, 0, 1}, /* 17: IEEE_754_DOUBLE_BE */
1632 {4, 0, 0}, /* 18: UTF16_LE */
1633 {4, 0, 1}, /* 19: UTF16_BE */
1634 {8, 0, 0}, /* 20: UTF32_LE */
1635 {8, 0, 1} /* 21: UTF32_BE */
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001636};
1637
1638
1639/*
1640 * Internal: This function is used to find the machine format of a given
1641 * array type code. This returns UNKNOWN_FORMAT when the machine format cannot
1642 * be found.
1643 */
1644static enum machine_format_code
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02001645typecode_to_mformat_code(char typecode)
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001646{
Alexandre Vassalotti7aaa7702009-07-17 03:51:27 +00001647#ifdef WORDS_BIGENDIAN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001648 const int is_big_endian = 1;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001649#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001650 const int is_big_endian = 0;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001651#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001652 size_t intsize;
1653 int is_signed;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001654
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001655 switch (typecode) {
1656 case 'b':
1657 return SIGNED_INT8;
1658 case 'B':
1659 return UNSIGNED_INT8;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001660
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001661 case 'u':
1662 if (sizeof(Py_UNICODE) == 2) {
1663 return UTF16_LE + is_big_endian;
1664 }
1665 if (sizeof(Py_UNICODE) == 4) {
1666 return UTF32_LE + is_big_endian;
1667 }
1668 return UNKNOWN_FORMAT;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001669
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001670 case 'f':
1671 if (sizeof(float) == 4) {
1672 const float y = 16711938.0;
1673 if (memcmp(&y, "\x4b\x7f\x01\x02", 4) == 0)
1674 return IEEE_754_FLOAT_BE;
1675 if (memcmp(&y, "\x02\x01\x7f\x4b", 4) == 0)
1676 return IEEE_754_FLOAT_LE;
1677 }
1678 return UNKNOWN_FORMAT;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001679
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001680 case 'd':
1681 if (sizeof(double) == 8) {
1682 const double x = 9006104071832581.0;
1683 if (memcmp(&x, "\x43\x3f\xff\x01\x02\x03\x04\x05", 8) == 0)
1684 return IEEE_754_DOUBLE_BE;
1685 if (memcmp(&x, "\x05\x04\x03\x02\x01\xff\x3f\x43", 8) == 0)
1686 return IEEE_754_DOUBLE_LE;
1687 }
1688 return UNKNOWN_FORMAT;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001689
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001690 /* Integers */
1691 case 'h':
1692 intsize = sizeof(short);
1693 is_signed = 1;
1694 break;
1695 case 'H':
1696 intsize = sizeof(short);
1697 is_signed = 0;
1698 break;
1699 case 'i':
1700 intsize = sizeof(int);
1701 is_signed = 1;
1702 break;
1703 case 'I':
1704 intsize = sizeof(int);
1705 is_signed = 0;
1706 break;
1707 case 'l':
1708 intsize = sizeof(long);
1709 is_signed = 1;
1710 break;
1711 case 'L':
1712 intsize = sizeof(long);
1713 is_signed = 0;
1714 break;
Meador Inge1c9f0c92011-09-20 19:55:51 -05001715#if HAVE_LONG_LONG
1716 case 'q':
1717 intsize = sizeof(PY_LONG_LONG);
1718 is_signed = 1;
1719 break;
1720 case 'Q':
1721 intsize = sizeof(PY_LONG_LONG);
1722 is_signed = 0;
1723 break;
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02001724#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001725 default:
1726 return UNKNOWN_FORMAT;
1727 }
1728 switch (intsize) {
1729 case 2:
1730 return UNSIGNED_INT16_LE + is_big_endian + (2 * is_signed);
1731 case 4:
1732 return UNSIGNED_INT32_LE + is_big_endian + (2 * is_signed);
1733 case 8:
1734 return UNSIGNED_INT64_LE + is_big_endian + (2 * is_signed);
1735 default:
1736 return UNKNOWN_FORMAT;
1737 }
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001738}
1739
1740/* Forward declaration. */
1741static PyObject *array_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
1742
1743/*
1744 * Internal: This function wraps the array constructor--i.e., array_new()--to
1745 * allow the creation of array objects from C code without having to deal
1746 * directly the tuple argument of array_new(). The typecode argument is a
1747 * Unicode character value, like 'i' or 'f' for example, representing an array
1748 * type code. The items argument is a bytes or a list object from which
1749 * contains the initial value of the array.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001750 *
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001751 * On success, this functions returns the array object created. Otherwise,
1752 * NULL is returned to indicate a failure.
1753 */
1754static PyObject *
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02001755make_array(PyTypeObject *arraytype, char typecode, PyObject *items)
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001756{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001757 PyObject *new_args;
1758 PyObject *array_obj;
1759 PyObject *typecode_obj;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001760
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001761 assert(arraytype != NULL);
1762 assert(items != NULL);
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001763
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02001764 typecode_obj = PyUnicode_FromOrdinal(typecode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001765 if (typecode_obj == NULL)
1766 return NULL;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001767
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001768 new_args = PyTuple_New(2);
1769 if (new_args == NULL)
1770 return NULL;
1771 Py_INCREF(items);
1772 PyTuple_SET_ITEM(new_args, 0, typecode_obj);
1773 PyTuple_SET_ITEM(new_args, 1, items);
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001774
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001775 array_obj = array_new(arraytype, new_args, NULL);
1776 Py_DECREF(new_args);
1777 if (array_obj == NULL)
1778 return NULL;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001779
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001780 return array_obj;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001781}
1782
1783/*
1784 * This functions is a special constructor used when unpickling an array. It
1785 * provides a portable way to rebuild an array from its memory representation.
1786 */
1787static PyObject *
1788array_reconstructor(PyObject *self, PyObject *args)
1789{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001790 PyTypeObject *arraytype;
1791 PyObject *items;
1792 PyObject *converted_items;
1793 PyObject *result;
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02001794 int typecode;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001795 enum machine_format_code mformat_code;
1796 struct arraydescr *descr;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001797
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001798 if (!PyArg_ParseTuple(args, "OCiO:array._array_reconstructor",
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02001799 &arraytype, &typecode, &mformat_code, &items))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001800 return NULL;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001801
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001802 if (!PyType_Check(arraytype)) {
1803 PyErr_Format(PyExc_TypeError,
1804 "first argument must a type object, not %.200s",
1805 Py_TYPE(arraytype)->tp_name);
1806 return NULL;
1807 }
1808 if (!PyType_IsSubtype(arraytype, &Arraytype)) {
1809 PyErr_Format(PyExc_TypeError,
1810 "%.200s is not a subtype of %.200s",
1811 arraytype->tp_name, Arraytype.tp_name);
1812 return NULL;
1813 }
1814 for (descr = descriptors; descr->typecode != '\0'; descr++) {
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02001815 if ((int)descr->typecode == typecode)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001816 break;
1817 }
1818 if (descr->typecode == '\0') {
1819 PyErr_SetString(PyExc_ValueError,
1820 "second argument must be a valid type code");
1821 return NULL;
1822 }
1823 if (mformat_code < MACHINE_FORMAT_CODE_MIN ||
1824 mformat_code > MACHINE_FORMAT_CODE_MAX) {
1825 PyErr_SetString(PyExc_ValueError,
1826 "third argument must be a valid machine format code.");
1827 return NULL;
1828 }
1829 if (!PyBytes_Check(items)) {
1830 PyErr_Format(PyExc_TypeError,
1831 "fourth argument should be bytes, not %.200s",
1832 Py_TYPE(items)->tp_name);
1833 return NULL;
1834 }
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001835
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001836 /* Fast path: No decoding has to be done. */
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02001837 if (mformat_code == typecode_to_mformat_code((char)typecode) ||
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001838 mformat_code == UNKNOWN_FORMAT) {
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02001839 return make_array(arraytype, (char)typecode, items);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001840 }
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001841
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001842 /* Slow path: Decode the byte string according to the given machine
1843 * format code. This occurs when the computer unpickling the array
1844 * object is architecturally different from the one that pickled the
1845 * array.
1846 */
1847 if (Py_SIZE(items) % mformat_descriptors[mformat_code].size != 0) {
1848 PyErr_SetString(PyExc_ValueError,
1849 "string length not a multiple of item size");
1850 return NULL;
1851 }
1852 switch (mformat_code) {
1853 case IEEE_754_FLOAT_LE:
1854 case IEEE_754_FLOAT_BE: {
1855 int i;
1856 int le = (mformat_code == IEEE_754_FLOAT_LE) ? 1 : 0;
1857 Py_ssize_t itemcount = Py_SIZE(items) / 4;
1858 const unsigned char *memstr =
1859 (unsigned char *)PyBytes_AS_STRING(items);
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001860
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001861 converted_items = PyList_New(itemcount);
1862 if (converted_items == NULL)
1863 return NULL;
1864 for (i = 0; i < itemcount; i++) {
1865 PyObject *pyfloat = PyFloat_FromDouble(
1866 _PyFloat_Unpack4(&memstr[i * 4], le));
1867 if (pyfloat == NULL) {
1868 Py_DECREF(converted_items);
1869 return NULL;
1870 }
1871 PyList_SET_ITEM(converted_items, i, pyfloat);
1872 }
1873 break;
1874 }
1875 case IEEE_754_DOUBLE_LE:
1876 case IEEE_754_DOUBLE_BE: {
1877 int i;
1878 int le = (mformat_code == IEEE_754_DOUBLE_LE) ? 1 : 0;
1879 Py_ssize_t itemcount = Py_SIZE(items) / 8;
1880 const unsigned char *memstr =
1881 (unsigned char *)PyBytes_AS_STRING(items);
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001882
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001883 converted_items = PyList_New(itemcount);
1884 if (converted_items == NULL)
1885 return NULL;
1886 for (i = 0; i < itemcount; i++) {
1887 PyObject *pyfloat = PyFloat_FromDouble(
1888 _PyFloat_Unpack8(&memstr[i * 8], le));
1889 if (pyfloat == NULL) {
1890 Py_DECREF(converted_items);
1891 return NULL;
1892 }
1893 PyList_SET_ITEM(converted_items, i, pyfloat);
1894 }
1895 break;
1896 }
1897 case UTF16_LE:
1898 case UTF16_BE: {
1899 int byteorder = (mformat_code == UTF16_LE) ? -1 : 1;
1900 converted_items = PyUnicode_DecodeUTF16(
1901 PyBytes_AS_STRING(items), Py_SIZE(items),
1902 "strict", &byteorder);
1903 if (converted_items == NULL)
1904 return NULL;
1905 break;
1906 }
1907 case UTF32_LE:
1908 case UTF32_BE: {
1909 int byteorder = (mformat_code == UTF32_LE) ? -1 : 1;
1910 converted_items = PyUnicode_DecodeUTF32(
1911 PyBytes_AS_STRING(items), Py_SIZE(items),
1912 "strict", &byteorder);
1913 if (converted_items == NULL)
1914 return NULL;
1915 break;
1916 }
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001917
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001918 case UNSIGNED_INT8:
1919 case SIGNED_INT8:
1920 case UNSIGNED_INT16_LE:
1921 case UNSIGNED_INT16_BE:
1922 case SIGNED_INT16_LE:
1923 case SIGNED_INT16_BE:
1924 case UNSIGNED_INT32_LE:
1925 case UNSIGNED_INT32_BE:
1926 case SIGNED_INT32_LE:
1927 case SIGNED_INT32_BE:
1928 case UNSIGNED_INT64_LE:
1929 case UNSIGNED_INT64_BE:
1930 case SIGNED_INT64_LE:
1931 case SIGNED_INT64_BE: {
1932 int i;
1933 const struct mformatdescr mf_descr =
1934 mformat_descriptors[mformat_code];
1935 Py_ssize_t itemcount = Py_SIZE(items) / mf_descr.size;
1936 const unsigned char *memstr =
1937 (unsigned char *)PyBytes_AS_STRING(items);
1938 struct arraydescr *descr;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001939
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001940 /* If possible, try to pack array's items using a data type
1941 * that fits better. This may result in an array with narrower
1942 * or wider elements.
1943 *
1944 * For example, if a 32-bit machine pickles a L-code array of
1945 * unsigned longs, then the array will be unpickled by 64-bit
1946 * machine as an I-code array of unsigned ints.
1947 *
1948 * XXX: Is it possible to write a unit test for this?
1949 */
1950 for (descr = descriptors; descr->typecode != '\0'; descr++) {
1951 if (descr->is_integer_type &&
1952 descr->itemsize == mf_descr.size &&
1953 descr->is_signed == mf_descr.is_signed)
1954 typecode = descr->typecode;
1955 }
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001956
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001957 converted_items = PyList_New(itemcount);
1958 if (converted_items == NULL)
1959 return NULL;
1960 for (i = 0; i < itemcount; i++) {
1961 PyObject *pylong;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001962
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001963 pylong = _PyLong_FromByteArray(
1964 &memstr[i * mf_descr.size],
1965 mf_descr.size,
1966 !mf_descr.is_big_endian,
1967 mf_descr.is_signed);
1968 if (pylong == NULL) {
1969 Py_DECREF(converted_items);
1970 return NULL;
1971 }
1972 PyList_SET_ITEM(converted_items, i, pylong);
1973 }
1974 break;
1975 }
1976 case UNKNOWN_FORMAT:
1977 /* Impossible, but needed to shut up GCC about the unhandled
1978 * enumeration value.
1979 */
1980 default:
1981 PyErr_BadArgument();
1982 return NULL;
1983 }
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001984
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02001985 result = make_array(arraytype, (char)typecode, converted_items);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001986 Py_DECREF(converted_items);
1987 return result;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001988}
1989
1990static PyObject *
1991array_reduce_ex(arrayobject *array, PyObject *value)
1992{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001993 PyObject *dict;
1994 PyObject *result;
1995 PyObject *array_str;
1996 int typecode = array->ob_descr->typecode;
1997 int mformat_code;
1998 static PyObject *array_reconstructor = NULL;
1999 long protocol;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00002000
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002001 if (array_reconstructor == NULL) {
2002 PyObject *array_module = PyImport_ImportModule("array");
2003 if (array_module == NULL)
2004 return NULL;
2005 array_reconstructor = PyObject_GetAttrString(
2006 array_module,
2007 "_array_reconstructor");
2008 Py_DECREF(array_module);
2009 if (array_reconstructor == NULL)
2010 return NULL;
2011 }
Alexandre Vassalottiad077152009-07-15 17:49:23 +00002012
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002013 if (!PyLong_Check(value)) {
2014 PyErr_SetString(PyExc_TypeError,
2015 "__reduce_ex__ argument should an integer");
2016 return NULL;
2017 }
2018 protocol = PyLong_AsLong(value);
2019 if (protocol == -1 && PyErr_Occurred())
2020 return NULL;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00002021
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002022 dict = PyObject_GetAttrString((PyObject *)array, "__dict__");
2023 if (dict == NULL) {
2024 if (!PyErr_ExceptionMatches(PyExc_AttributeError))
2025 return NULL;
2026 PyErr_Clear();
2027 dict = Py_None;
2028 Py_INCREF(dict);
2029 }
Alexandre Vassalottiad077152009-07-15 17:49:23 +00002030
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002031 mformat_code = typecode_to_mformat_code(typecode);
2032 if (mformat_code == UNKNOWN_FORMAT || protocol < 3) {
2033 /* Convert the array to a list if we got something weird
2034 * (e.g., non-IEEE floats), or we are pickling the array using
2035 * a Python 2.x compatible protocol.
2036 *
2037 * It is necessary to use a list representation for Python 2.x
2038 * compatible pickle protocol, since Python 2's str objects
2039 * are unpickled as unicode by Python 3. Thus it is impossible
2040 * to make arrays unpicklable by Python 3 by using their memory
2041 * representation, unless we resort to ugly hacks such as
2042 * coercing unicode objects to bytes in array_reconstructor.
2043 */
2044 PyObject *list;
2045 list = array_tolist(array, NULL);
2046 if (list == NULL) {
2047 Py_DECREF(dict);
2048 return NULL;
2049 }
2050 result = Py_BuildValue(
2051 "O(CO)O", Py_TYPE(array), typecode, list, dict);
2052 Py_DECREF(list);
2053 Py_DECREF(dict);
2054 return result;
2055 }
Alexandre Vassalottiad077152009-07-15 17:49:23 +00002056
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00002057 array_str = array_tobytes(array, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002058 if (array_str == NULL) {
2059 Py_DECREF(dict);
2060 return NULL;
2061 }
2062 result = Py_BuildValue(
2063 "O(OCiN)O", array_reconstructor, Py_TYPE(array), typecode,
2064 mformat_code, array_str, dict);
2065 Py_DECREF(dict);
2066 return result;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00002067}
2068
2069PyDoc_STRVAR(reduce_doc, "Return state information for pickling.");
2070
Martin v. Löwis99866332002-03-01 10:27:01 +00002071static PyObject *
2072array_get_typecode(arrayobject *a, void *closure)
2073{
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02002074 char typecode = a->ob_descr->typecode;
2075 return PyUnicode_FromOrdinal(typecode);
Martin v. Löwis99866332002-03-01 10:27:01 +00002076}
2077
2078static PyObject *
2079array_get_itemsize(arrayobject *a, void *closure)
2080{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002081 return PyLong_FromLong((long)a->ob_descr->itemsize);
Martin v. Löwis99866332002-03-01 10:27:01 +00002082}
2083
2084static PyGetSetDef array_getsets [] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002085 {"typecode", (getter) array_get_typecode, NULL,
2086 "the typecode character used to create the array"},
2087 {"itemsize", (getter) array_get_itemsize, NULL,
2088 "the size, in bytes, of one array item"},
2089 {NULL}
Martin v. Löwis99866332002-03-01 10:27:01 +00002090};
2091
Martin v. Löwis59683e82008-06-13 07:50:45 +00002092static PyMethodDef array_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002093 {"append", (PyCFunction)array_append, METH_O,
2094 append_doc},
2095 {"buffer_info", (PyCFunction)array_buffer_info, METH_NOARGS,
2096 buffer_info_doc},
2097 {"byteswap", (PyCFunction)array_byteswap, METH_NOARGS,
2098 byteswap_doc},
2099 {"__copy__", (PyCFunction)array_copy, METH_NOARGS,
2100 copy_doc},
2101 {"count", (PyCFunction)array_count, METH_O,
2102 count_doc},
2103 {"__deepcopy__",(PyCFunction)array_copy, METH_O,
2104 copy_doc},
2105 {"extend", (PyCFunction)array_extend, METH_O,
2106 extend_doc},
2107 {"fromfile", (PyCFunction)array_fromfile, METH_VARARGS,
2108 fromfile_doc},
2109 {"fromlist", (PyCFunction)array_fromlist, METH_O,
2110 fromlist_doc},
2111 {"fromstring", (PyCFunction)array_fromstring, METH_VARARGS,
2112 fromstring_doc},
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00002113 {"frombytes", (PyCFunction)array_frombytes, METH_VARARGS,
2114 frombytes_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002115 {"fromunicode", (PyCFunction)array_fromunicode, METH_VARARGS,
2116 fromunicode_doc},
2117 {"index", (PyCFunction)array_index, METH_O,
2118 index_doc},
2119 {"insert", (PyCFunction)array_insert, METH_VARARGS,
2120 insert_doc},
2121 {"pop", (PyCFunction)array_pop, METH_VARARGS,
2122 pop_doc},
2123 {"__reduce_ex__", (PyCFunction)array_reduce_ex, METH_O,
2124 reduce_doc},
2125 {"remove", (PyCFunction)array_remove, METH_O,
2126 remove_doc},
2127 {"reverse", (PyCFunction)array_reverse, METH_NOARGS,
2128 reverse_doc},
2129/* {"sort", (PyCFunction)array_sort, METH_VARARGS,
2130 sort_doc},*/
2131 {"tofile", (PyCFunction)array_tofile, METH_O,
2132 tofile_doc},
2133 {"tolist", (PyCFunction)array_tolist, METH_NOARGS,
2134 tolist_doc},
2135 {"tostring", (PyCFunction)array_tostring, METH_NOARGS,
2136 tostring_doc},
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00002137 {"tobytes", (PyCFunction)array_tobytes, METH_NOARGS,
2138 tobytes_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002139 {"tounicode", (PyCFunction)array_tounicode, METH_NOARGS,
2140 tounicode_doc},
2141 {NULL, NULL} /* sentinel */
Guido van Rossum778983b1993-02-19 15:55:02 +00002142};
2143
Roger E. Masse2919eaa1996-12-09 20:10:36 +00002144static PyObject *
Peter Schneider-Kamp9656abd2000-07-13 21:10:57 +00002145array_repr(arrayobject *a)
Guido van Rossum778983b1993-02-19 15:55:02 +00002146{
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02002147 char typecode;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002148 PyObject *s, *v = NULL;
2149 Py_ssize_t len;
Martin v. Löwis99866332002-03-01 10:27:01 +00002150
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002151 len = Py_SIZE(a);
2152 typecode = a->ob_descr->typecode;
2153 if (len == 0) {
Amaury Forgeot d'Arc24aa26b2010-11-25 08:13:35 +00002154 return PyUnicode_FromFormat("array('%c')", (int)typecode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002155 }
Brett Cannon4a5e5de2011-06-07 20:09:32 -07002156 if (typecode == 'u')
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002157 v = array_tounicode(a, NULL);
2158 else
2159 v = array_tolist(a, NULL);
Raymond Hettinger88ba1e32003-04-23 17:27:00 +00002160
Amaury Forgeot d'Arc24aa26b2010-11-25 08:13:35 +00002161 s = PyUnicode_FromFormat("array('%c', %R)", (int)typecode, v);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002162 Py_DECREF(v);
2163 return s;
Guido van Rossum778983b1993-02-19 15:55:02 +00002164}
2165
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00002166static PyObject*
2167array_subscr(arrayobject* self, PyObject* item)
2168{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002169 if (PyIndex_Check(item)) {
2170 Py_ssize_t i = PyNumber_AsSsize_t(item, PyExc_IndexError);
2171 if (i==-1 && PyErr_Occurred()) {
2172 return NULL;
2173 }
2174 if (i < 0)
2175 i += Py_SIZE(self);
2176 return array_item(self, i);
2177 }
2178 else if (PySlice_Check(item)) {
2179 Py_ssize_t start, stop, step, slicelength, cur, i;
2180 PyObject* result;
2181 arrayobject* ar;
2182 int itemsize = self->ob_descr->itemsize;
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00002183
Martin v. Löwis4d0d4712010-12-03 20:14:31 +00002184 if (PySlice_GetIndicesEx(item, Py_SIZE(self),
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002185 &start, &stop, &step, &slicelength) < 0) {
2186 return NULL;
2187 }
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00002188
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002189 if (slicelength <= 0) {
2190 return newarrayobject(&Arraytype, 0, self->ob_descr);
2191 }
2192 else if (step == 1) {
2193 PyObject *result = newarrayobject(&Arraytype,
2194 slicelength, self->ob_descr);
2195 if (result == NULL)
2196 return NULL;
2197 memcpy(((arrayobject *)result)->ob_item,
2198 self->ob_item + start * itemsize,
2199 slicelength * itemsize);
2200 return result;
2201 }
2202 else {
2203 result = newarrayobject(&Arraytype, slicelength, self->ob_descr);
2204 if (!result) return NULL;
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00002205
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002206 ar = (arrayobject*)result;
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00002207
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002208 for (cur = start, i = 0; i < slicelength;
2209 cur += step, i++) {
2210 memcpy(ar->ob_item + i*itemsize,
2211 self->ob_item + cur*itemsize,
2212 itemsize);
2213 }
2214
2215 return result;
2216 }
2217 }
2218 else {
2219 PyErr_SetString(PyExc_TypeError,
2220 "array indices must be integers");
2221 return NULL;
2222 }
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00002223}
2224
2225static int
2226array_ass_subscr(arrayobject* self, PyObject* item, PyObject* value)
2227{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002228 Py_ssize_t start, stop, step, slicelength, needed;
2229 arrayobject* other;
2230 int itemsize;
Thomas Woutersed03b412007-08-28 21:37:11 +00002231
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002232 if (PyIndex_Check(item)) {
2233 Py_ssize_t i = PyNumber_AsSsize_t(item, PyExc_IndexError);
Alexandre Vassalotti47137252009-07-05 19:57:00 +00002234
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002235 if (i == -1 && PyErr_Occurred())
2236 return -1;
2237 if (i < 0)
2238 i += Py_SIZE(self);
2239 if (i < 0 || i >= Py_SIZE(self)) {
2240 PyErr_SetString(PyExc_IndexError,
2241 "array assignment index out of range");
2242 return -1;
2243 }
2244 if (value == NULL) {
2245 /* Fall through to slice assignment */
2246 start = i;
2247 stop = i + 1;
2248 step = 1;
2249 slicelength = 1;
2250 }
2251 else
2252 return (*self->ob_descr->setitem)(self, i, value);
2253 }
2254 else if (PySlice_Check(item)) {
Martin v. Löwis4d0d4712010-12-03 20:14:31 +00002255 if (PySlice_GetIndicesEx(item,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002256 Py_SIZE(self), &start, &stop,
2257 &step, &slicelength) < 0) {
2258 return -1;
2259 }
2260 }
2261 else {
2262 PyErr_SetString(PyExc_TypeError,
2263 "array indices must be integer");
2264 return -1;
2265 }
2266 if (value == NULL) {
2267 other = NULL;
2268 needed = 0;
2269 }
2270 else if (array_Check(value)) {
2271 other = (arrayobject *)value;
2272 needed = Py_SIZE(other);
2273 if (self == other) {
2274 /* Special case "self[i:j] = self" -- copy self first */
2275 int ret;
2276 value = array_slice(other, 0, needed);
2277 if (value == NULL)
2278 return -1;
2279 ret = array_ass_subscr(self, item, value);
2280 Py_DECREF(value);
2281 return ret;
2282 }
2283 if (other->ob_descr != self->ob_descr) {
2284 PyErr_BadArgument();
2285 return -1;
2286 }
2287 }
2288 else {
2289 PyErr_Format(PyExc_TypeError,
2290 "can only assign array (not \"%.200s\") to array slice",
2291 Py_TYPE(value)->tp_name);
2292 return -1;
2293 }
2294 itemsize = self->ob_descr->itemsize;
2295 /* for 'a[2:1] = ...', the insertion point is 'start', not 'stop' */
2296 if ((step > 0 && stop < start) ||
2297 (step < 0 && stop > start))
2298 stop = start;
Alexandre Vassalotti47137252009-07-05 19:57:00 +00002299
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002300 /* Issue #4509: If the array has exported buffers and the slice
2301 assignment would change the size of the array, fail early to make
2302 sure we don't modify it. */
2303 if ((needed == 0 || slicelength != needed) && self->ob_exports > 0) {
2304 PyErr_SetString(PyExc_BufferError,
2305 "cannot resize an array that is exporting buffers");
2306 return -1;
2307 }
Mark Dickinsonbc099642010-01-29 17:27:24 +00002308
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002309 if (step == 1) {
2310 if (slicelength > needed) {
2311 memmove(self->ob_item + (start + needed) * itemsize,
2312 self->ob_item + stop * itemsize,
2313 (Py_SIZE(self) - stop) * itemsize);
2314 if (array_resize(self, Py_SIZE(self) +
2315 needed - slicelength) < 0)
2316 return -1;
2317 }
2318 else if (slicelength < needed) {
2319 if (array_resize(self, Py_SIZE(self) +
2320 needed - slicelength) < 0)
2321 return -1;
2322 memmove(self->ob_item + (start + needed) * itemsize,
2323 self->ob_item + stop * itemsize,
2324 (Py_SIZE(self) - start - needed) * itemsize);
2325 }
2326 if (needed > 0)
2327 memcpy(self->ob_item + start * itemsize,
2328 other->ob_item, needed * itemsize);
2329 return 0;
2330 }
2331 else if (needed == 0) {
2332 /* Delete slice */
2333 size_t cur;
2334 Py_ssize_t i;
Thomas Woutersed03b412007-08-28 21:37:11 +00002335
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002336 if (step < 0) {
2337 stop = start + 1;
2338 start = stop + step * (slicelength - 1) - 1;
2339 step = -step;
2340 }
2341 for (cur = start, i = 0; i < slicelength;
2342 cur += step, i++) {
2343 Py_ssize_t lim = step - 1;
Thomas Woutersed03b412007-08-28 21:37:11 +00002344
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002345 if (cur + step >= (size_t)Py_SIZE(self))
2346 lim = Py_SIZE(self) - cur - 1;
2347 memmove(self->ob_item + (cur - i) * itemsize,
2348 self->ob_item + (cur + 1) * itemsize,
2349 lim * itemsize);
2350 }
Mark Dickinsonc7d93b72011-09-25 15:34:32 +01002351 cur = start + (size_t)slicelength * step;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002352 if (cur < (size_t)Py_SIZE(self)) {
2353 memmove(self->ob_item + (cur-slicelength) * itemsize,
2354 self->ob_item + cur * itemsize,
2355 (Py_SIZE(self) - cur) * itemsize);
2356 }
2357 if (array_resize(self, Py_SIZE(self) - slicelength) < 0)
2358 return -1;
2359 return 0;
2360 }
2361 else {
2362 Py_ssize_t cur, i;
2363
2364 if (needed != slicelength) {
2365 PyErr_Format(PyExc_ValueError,
2366 "attempt to assign array of size %zd "
2367 "to extended slice of size %zd",
2368 needed, slicelength);
2369 return -1;
2370 }
2371 for (cur = start, i = 0; i < slicelength;
2372 cur += step, i++) {
2373 memcpy(self->ob_item + cur * itemsize,
2374 other->ob_item + i * itemsize,
2375 itemsize);
2376 }
2377 return 0;
2378 }
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00002379}
2380
2381static PyMappingMethods array_as_mapping = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002382 (lenfunc)array_length,
2383 (binaryfunc)array_subscr,
2384 (objobjargproc)array_ass_subscr
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00002385};
2386
Guido van Rossumd8faa362007-04-27 19:54:29 +00002387static const void *emptybuf = "";
2388
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00002389
2390static int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +00002391array_buffer_getbuf(arrayobject *self, Py_buffer *view, int flags)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00002392{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002393 if (view==NULL) goto finish;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00002394
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002395 view->buf = (void *)self->ob_item;
2396 view->obj = (PyObject*)self;
2397 Py_INCREF(self);
2398 if (view->buf == NULL)
2399 view->buf = (void *)emptybuf;
2400 view->len = (Py_SIZE(self)) * self->ob_descr->itemsize;
2401 view->readonly = 0;
2402 view->ndim = 1;
2403 view->itemsize = self->ob_descr->itemsize;
2404 view->suboffsets = NULL;
2405 view->shape = NULL;
2406 if ((flags & PyBUF_ND)==PyBUF_ND) {
2407 view->shape = &((Py_SIZE(self)));
2408 }
2409 view->strides = NULL;
2410 if ((flags & PyBUF_STRIDES)==PyBUF_STRIDES)
2411 view->strides = &(view->itemsize);
2412 view->format = NULL;
2413 view->internal = NULL;
2414 if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT) {
2415 view->format = self->ob_descr->formats;
Travis E. Oliphantddacf962007-10-13 21:03:27 +00002416#ifdef Py_UNICODE_WIDE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002417 if (self->ob_descr->typecode == 'u') {
2418 view->format = "w";
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00002419 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002420#endif
2421 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00002422
2423 finish:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002424 self->ob_exports++;
2425 return 0;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00002426}
2427
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00002428static void
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +00002429array_buffer_relbuf(arrayobject *self, Py_buffer *view)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00002430{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002431 self->ob_exports--;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00002432}
2433
Roger E. Masse2919eaa1996-12-09 20:10:36 +00002434static PySequenceMethods array_as_sequence = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002435 (lenfunc)array_length, /*sq_length*/
2436 (binaryfunc)array_concat, /*sq_concat*/
2437 (ssizeargfunc)array_repeat, /*sq_repeat*/
2438 (ssizeargfunc)array_item, /*sq_item*/
2439 0, /*sq_slice*/
2440 (ssizeobjargproc)array_ass_item, /*sq_ass_item*/
2441 0, /*sq_ass_slice*/
2442 (objobjproc)array_contains, /*sq_contains*/
2443 (binaryfunc)array_inplace_concat, /*sq_inplace_concat*/
2444 (ssizeargfunc)array_inplace_repeat /*sq_inplace_repeat*/
Guido van Rossum778983b1993-02-19 15:55:02 +00002445};
2446
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00002447static PyBufferProcs array_as_buffer = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002448 (getbufferproc)array_buffer_getbuf,
2449 (releasebufferproc)array_buffer_relbuf
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00002450};
2451
Roger E. Masse2919eaa1996-12-09 20:10:36 +00002452static PyObject *
Martin v. Löwis99866332002-03-01 10:27:01 +00002453array_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
Guido van Rossum778983b1993-02-19 15:55:02 +00002454{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002455 int c;
2456 PyObject *initial = NULL, *it = NULL;
2457 struct arraydescr *descr;
Martin v. Löwis99866332002-03-01 10:27:01 +00002458
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002459 if (type == &Arraytype && !_PyArg_NoKeywords("array.array()", kwds))
2460 return NULL;
Martin v. Löwis99866332002-03-01 10:27:01 +00002461
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002462 if (!PyArg_ParseTuple(args, "C|O:array", &c, &initial))
2463 return NULL;
Raymond Hettinger84fc9aa2003-04-24 10:41:55 +00002464
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002465 if (!(initial == NULL || PyList_Check(initial)
2466 || PyByteArray_Check(initial)
2467 || PyBytes_Check(initial)
2468 || PyTuple_Check(initial)
Alexander Belopolskyef4a03f2011-01-11 21:44:00 +00002469 || ((c=='u') && PyUnicode_Check(initial))
2470 || (array_Check(initial)
2471 && c == ((arrayobject*)initial)->ob_descr->typecode))) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002472 it = PyObject_GetIter(initial);
2473 if (it == NULL)
2474 return NULL;
2475 /* We set initial to NULL so that the subsequent code
2476 will create an empty array of the appropriate type
2477 and afterwards we can use array_iter_extend to populate
2478 the array.
2479 */
2480 initial = NULL;
2481 }
2482 for (descr = descriptors; descr->typecode != '\0'; descr++) {
2483 if (descr->typecode == c) {
2484 PyObject *a;
2485 Py_ssize_t len;
Martin v. Löwis99866332002-03-01 10:27:01 +00002486
Alexander Belopolskyef4a03f2011-01-11 21:44:00 +00002487 if (initial == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002488 len = 0;
Alexander Belopolskyef4a03f2011-01-11 21:44:00 +00002489 else if (PyList_Check(initial))
2490 len = PyList_GET_SIZE(initial);
2491 else if (PyTuple_Check(initial) || array_Check(initial))
2492 len = Py_SIZE(initial);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002493 else
Alexander Belopolskyef4a03f2011-01-11 21:44:00 +00002494 len = 0;
Martin v. Löwis99866332002-03-01 10:27:01 +00002495
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002496 a = newarrayobject(type, len, descr);
2497 if (a == NULL)
2498 return NULL;
2499
Alexander Belopolskyef4a03f2011-01-11 21:44:00 +00002500 if (len > 0 && !array_Check(initial)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002501 Py_ssize_t i;
2502 for (i = 0; i < len; i++) {
2503 PyObject *v =
2504 PySequence_GetItem(initial, i);
2505 if (v == NULL) {
2506 Py_DECREF(a);
2507 return NULL;
2508 }
2509 if (setarrayitem(a, i, v) != 0) {
2510 Py_DECREF(v);
2511 Py_DECREF(a);
2512 return NULL;
2513 }
2514 Py_DECREF(v);
2515 }
2516 }
2517 else if (initial != NULL && (PyByteArray_Check(initial) ||
2518 PyBytes_Check(initial))) {
2519 PyObject *t_initial, *v;
2520 t_initial = PyTuple_Pack(1, initial);
2521 if (t_initial == NULL) {
2522 Py_DECREF(a);
2523 return NULL;
2524 }
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00002525 v = array_frombytes((arrayobject *)a,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002526 t_initial);
2527 Py_DECREF(t_initial);
2528 if (v == NULL) {
2529 Py_DECREF(a);
2530 return NULL;
2531 }
2532 Py_DECREF(v);
2533 }
2534 else if (initial != NULL && PyUnicode_Check(initial)) {
2535 Py_ssize_t n = PyUnicode_GET_DATA_SIZE(initial);
2536 if (n > 0) {
2537 arrayobject *self = (arrayobject *)a;
2538 char *item = self->ob_item;
2539 item = (char *)PyMem_Realloc(item, n);
2540 if (item == NULL) {
2541 PyErr_NoMemory();
2542 Py_DECREF(a);
2543 return NULL;
2544 }
2545 self->ob_item = item;
2546 Py_SIZE(self) = n / sizeof(Py_UNICODE);
2547 memcpy(item, PyUnicode_AS_DATA(initial), n);
2548 self->allocated = Py_SIZE(self);
2549 }
2550 }
Alexander Belopolskyef4a03f2011-01-11 21:44:00 +00002551 else if (initial != NULL && array_Check(initial)) {
2552 arrayobject *self = (arrayobject *)a;
2553 arrayobject *other = (arrayobject *)initial;
2554 memcpy(self->ob_item, other->ob_item, len * other->ob_descr->itemsize);
2555 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002556 if (it != NULL) {
2557 if (array_iter_extend((arrayobject *)a, it) == -1) {
2558 Py_DECREF(it);
2559 Py_DECREF(a);
2560 return NULL;
2561 }
2562 Py_DECREF(it);
2563 }
2564 return a;
2565 }
2566 }
2567 PyErr_SetString(PyExc_ValueError,
Meador Inge1c9f0c92011-09-20 19:55:51 -05002568#ifdef HAVE_LONG_LONG
2569 "bad typecode (must be b, B, u, h, H, i, I, l, L, q, Q, f or d)");
2570#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002571 "bad typecode (must be b, B, u, h, H, i, I, l, L, f or d)");
Meador Inge1c9f0c92011-09-20 19:55:51 -05002572#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002573 return NULL;
Guido van Rossum778983b1993-02-19 15:55:02 +00002574}
2575
Guido van Rossum778983b1993-02-19 15:55:02 +00002576
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002577PyDoc_STRVAR(module_doc,
Martin v. Löwis99866332002-03-01 10:27:01 +00002578"This module defines an object type which can efficiently represent\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002579an array of basic values: characters, integers, floating point\n\
2580numbers. Arrays are sequence types and behave very much like lists,\n\
2581except that the type of objects stored in them is constrained. The\n\
2582type is specified at object creation time by using a type code, which\n\
2583is a single character. The following type codes are defined:\n\
2584\n\
2585 Type code C Type Minimum size in bytes \n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002586 'b' signed integer 1 \n\
2587 'B' unsigned integer 1 \n\
Travis E. Oliphantd5c0add2007-10-12 22:05:15 +00002588 'u' Unicode character 2 (see note) \n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002589 'h' signed integer 2 \n\
2590 'H' unsigned integer 2 \n\
2591 'i' signed integer 2 \n\
2592 'I' unsigned integer 2 \n\
2593 'l' signed integer 4 \n\
2594 'L' unsigned integer 4 \n\
Meador Inge1c9f0c92011-09-20 19:55:51 -05002595 'q' signed integer 8 (see note) \n\
2596 'Q' unsigned integer 8 (see note) \n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002597 'f' floating point 4 \n\
2598 'd' floating point 8 \n\
2599\n\
Meador Inge1c9f0c92011-09-20 19:55:51 -05002600NOTE: The 'u' type code corresponds to Python's unicode character. On \n\
Travis E. Oliphantd5c0add2007-10-12 22:05:15 +00002601narrow builds this is 2-bytes on wide builds this is 4-bytes.\n\
2602\n\
Meador Inge1c9f0c92011-09-20 19:55:51 -05002603NOTE: The 'q' and 'Q' type codes are only available if the platform \n\
2604C compiler used to build Python supports 'long long', or, on Windows, \n\
2605'__int64'.\n\
2606\n\
Martin v. Löwis99866332002-03-01 10:27:01 +00002607The constructor is:\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002608\n\
2609array(typecode [, initializer]) -- create a new array\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002610");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002611
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002612PyDoc_STRVAR(arraytype_doc,
Martin v. Löwis99866332002-03-01 10:27:01 +00002613"array(typecode [, initializer]) -> array\n\
2614\n\
2615Return a new array whose items are restricted by typecode, and\n\
Raymond Hettinger6ab78cd2004-08-29 07:50:43 +00002616initialized from the optional initializer value, which must be a list,\n\
2617string. or iterable over elements of the appropriate type.\n\
Martin v. Löwis99866332002-03-01 10:27:01 +00002618\n\
2619Arrays represent basic values and behave very much like lists, except\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002620the type of objects stored in them is constrained.\n\
2621\n\
2622Methods:\n\
2623\n\
2624append() -- append a new item to the end of the array\n\
2625buffer_info() -- return information giving the current memory info\n\
2626byteswap() -- byteswap all the items of the array\n\
Mark Dickinson934896d2009-02-21 20:59:32 +00002627count() -- return number of occurrences of an object\n\
Raymond Hettinger49f9bd12004-03-14 05:43:59 +00002628extend() -- extend array by appending multiple elements from an iterable\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002629fromfile() -- read items from a file object\n\
2630fromlist() -- append items from the list\n\
2631fromstring() -- append items from the string\n\
Mark Dickinson934896d2009-02-21 20:59:32 +00002632index() -- return index of first occurrence of an object\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002633insert() -- insert a new item into the array at a provided position\n\
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00002634pop() -- remove and return item (default last)\n\
Mark Dickinson934896d2009-02-21 20:59:32 +00002635remove() -- remove first occurrence of an object\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002636reverse() -- reverse the order of the items in the array\n\
2637tofile() -- write all items to a file object\n\
2638tolist() -- return the array converted to an ordinary list\n\
2639tostring() -- return the array converted to a string\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002640\n\
Martin v. Löwis99866332002-03-01 10:27:01 +00002641Attributes:\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002642\n\
2643typecode -- the typecode character used to create the array\n\
2644itemsize -- the length in bytes of one array item\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002645");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002646
Raymond Hettinger625812f2003-01-07 01:58:52 +00002647static PyObject *array_iter(arrayobject *ao);
2648
Tim Peters0c322792002-07-17 16:49:03 +00002649static PyTypeObject Arraytype = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002650 PyVarObject_HEAD_INIT(NULL, 0)
2651 "array.array",
2652 sizeof(arrayobject),
2653 0,
2654 (destructor)array_dealloc, /* tp_dealloc */
2655 0, /* tp_print */
2656 0, /* tp_getattr */
2657 0, /* tp_setattr */
2658 0, /* tp_reserved */
2659 (reprfunc)array_repr, /* tp_repr */
2660 0, /* tp_as_number*/
2661 &array_as_sequence, /* tp_as_sequence*/
2662 &array_as_mapping, /* tp_as_mapping*/
2663 0, /* tp_hash */
2664 0, /* tp_call */
2665 0, /* tp_str */
2666 PyObject_GenericGetAttr, /* tp_getattro */
2667 0, /* tp_setattro */
2668 &array_as_buffer, /* tp_as_buffer*/
2669 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
2670 arraytype_doc, /* tp_doc */
2671 0, /* tp_traverse */
2672 0, /* tp_clear */
2673 array_richcompare, /* tp_richcompare */
2674 offsetof(arrayobject, weakreflist), /* tp_weaklistoffset */
2675 (getiterfunc)array_iter, /* tp_iter */
2676 0, /* tp_iternext */
2677 array_methods, /* tp_methods */
2678 0, /* tp_members */
2679 array_getsets, /* tp_getset */
2680 0, /* tp_base */
2681 0, /* tp_dict */
2682 0, /* tp_descr_get */
2683 0, /* tp_descr_set */
2684 0, /* tp_dictoffset */
2685 0, /* tp_init */
2686 PyType_GenericAlloc, /* tp_alloc */
2687 array_new, /* tp_new */
2688 PyObject_Del, /* tp_free */
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002689};
2690
Raymond Hettinger625812f2003-01-07 01:58:52 +00002691
2692/*********************** Array Iterator **************************/
2693
2694typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002695 PyObject_HEAD
2696 Py_ssize_t index;
2697 arrayobject *ao;
2698 PyObject * (*getitem)(struct arrayobject *, Py_ssize_t);
Raymond Hettinger625812f2003-01-07 01:58:52 +00002699} arrayiterobject;
2700
2701static PyTypeObject PyArrayIter_Type;
2702
2703#define PyArrayIter_Check(op) PyObject_TypeCheck(op, &PyArrayIter_Type)
2704
2705static PyObject *
2706array_iter(arrayobject *ao)
2707{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002708 arrayiterobject *it;
Raymond Hettinger625812f2003-01-07 01:58:52 +00002709
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002710 if (!array_Check(ao)) {
2711 PyErr_BadInternalCall();
2712 return NULL;
2713 }
Raymond Hettinger625812f2003-01-07 01:58:52 +00002714
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002715 it = PyObject_GC_New(arrayiterobject, &PyArrayIter_Type);
2716 if (it == NULL)
2717 return NULL;
Raymond Hettinger625812f2003-01-07 01:58:52 +00002718
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002719 Py_INCREF(ao);
2720 it->ao = ao;
2721 it->index = 0;
2722 it->getitem = ao->ob_descr->getitem;
2723 PyObject_GC_Track(it);
2724 return (PyObject *)it;
Raymond Hettinger625812f2003-01-07 01:58:52 +00002725}
2726
2727static PyObject *
Raymond Hettinger625812f2003-01-07 01:58:52 +00002728arrayiter_next(arrayiterobject *it)
2729{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002730 assert(PyArrayIter_Check(it));
2731 if (it->index < Py_SIZE(it->ao))
2732 return (*it->getitem)(it->ao, it->index++);
2733 return NULL;
Raymond Hettinger625812f2003-01-07 01:58:52 +00002734}
2735
2736static void
2737arrayiter_dealloc(arrayiterobject *it)
2738{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002739 PyObject_GC_UnTrack(it);
2740 Py_XDECREF(it->ao);
2741 PyObject_GC_Del(it);
Raymond Hettinger625812f2003-01-07 01:58:52 +00002742}
2743
2744static int
2745arrayiter_traverse(arrayiterobject *it, visitproc visit, void *arg)
2746{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002747 Py_VISIT(it->ao);
2748 return 0;
Raymond Hettinger625812f2003-01-07 01:58:52 +00002749}
2750
2751static PyTypeObject PyArrayIter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002752 PyVarObject_HEAD_INIT(NULL, 0)
2753 "arrayiterator", /* tp_name */
2754 sizeof(arrayiterobject), /* tp_basicsize */
2755 0, /* tp_itemsize */
2756 /* methods */
2757 (destructor)arrayiter_dealloc, /* tp_dealloc */
2758 0, /* tp_print */
2759 0, /* tp_getattr */
2760 0, /* tp_setattr */
2761 0, /* tp_reserved */
2762 0, /* tp_repr */
2763 0, /* tp_as_number */
2764 0, /* tp_as_sequence */
2765 0, /* tp_as_mapping */
2766 0, /* tp_hash */
2767 0, /* tp_call */
2768 0, /* tp_str */
2769 PyObject_GenericGetAttr, /* tp_getattro */
2770 0, /* tp_setattro */
2771 0, /* tp_as_buffer */
2772 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
2773 0, /* tp_doc */
2774 (traverseproc)arrayiter_traverse, /* tp_traverse */
2775 0, /* tp_clear */
2776 0, /* tp_richcompare */
2777 0, /* tp_weaklistoffset */
2778 PyObject_SelfIter, /* tp_iter */
2779 (iternextfunc)arrayiter_next, /* tp_iternext */
2780 0, /* tp_methods */
Raymond Hettinger625812f2003-01-07 01:58:52 +00002781};
2782
2783
2784/*********************** Install Module **************************/
2785
Martin v. Löwis99866332002-03-01 10:27:01 +00002786/* No functions in array module. */
2787static PyMethodDef a_methods[] = {
Alexandre Vassalottiad077152009-07-15 17:49:23 +00002788 {"_array_reconstructor", array_reconstructor, METH_VARARGS,
2789 PyDoc_STR("Internal. Used for pickling support.")},
Martin v. Löwis99866332002-03-01 10:27:01 +00002790 {NULL, NULL, 0, NULL} /* Sentinel */
2791};
2792
Martin v. Löwis1a214512008-06-11 05:26:20 +00002793static struct PyModuleDef arraymodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002794 PyModuleDef_HEAD_INIT,
2795 "array",
2796 module_doc,
2797 -1,
2798 a_methods,
2799 NULL,
2800 NULL,
2801 NULL,
2802 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00002803};
2804
Martin v. Löwis99866332002-03-01 10:27:01 +00002805
Mark Hammondfe51c6d2002-08-02 02:27:13 +00002806PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00002807PyInit_array(void)
Guido van Rossum778983b1993-02-19 15:55:02 +00002808{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002809 PyObject *m;
Georg Brandl4cb0de22011-09-28 21:49:49 +02002810 char buffer[Py_ARRAY_LENGTH(descriptors)], *p;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002811 PyObject *typecodes;
2812 Py_ssize_t size = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002813 struct arraydescr *descr;
Fred Drake0d40ba42000-02-04 20:33:49 +00002814
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002815 if (PyType_Ready(&Arraytype) < 0)
2816 return NULL;
2817 Py_TYPE(&PyArrayIter_Type) = &PyType_Type;
2818 m = PyModule_Create(&arraymodule);
2819 if (m == NULL)
2820 return NULL;
Fred Drakef4e34842002-04-01 03:45:06 +00002821
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002822 Py_INCREF((PyObject *)&Arraytype);
2823 PyModule_AddObject(m, "ArrayType", (PyObject *)&Arraytype);
2824 Py_INCREF((PyObject *)&Arraytype);
2825 PyModule_AddObject(m, "array", (PyObject *)&Arraytype);
Travis E. Oliphantd5c0add2007-10-12 22:05:15 +00002826
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002827 for (descr=descriptors; descr->typecode != '\0'; descr++) {
2828 size++;
2829 }
Travis E. Oliphantd5c0add2007-10-12 22:05:15 +00002830
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002831 p = buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002832 for (descr = descriptors; descr->typecode != '\0'; descr++) {
2833 *p++ = (char)descr->typecode;
2834 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002835 typecodes = PyUnicode_DecodeASCII(buffer, p - buffer, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002836
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002837 PyModule_AddObject(m, "typecodes", typecodes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002838
2839 if (PyErr_Occurred()) {
2840 Py_DECREF(m);
2841 m = NULL;
2842 }
2843 return m;
Guido van Rossum778983b1993-02-19 15:55:02 +00002844}