blob: 04eb67c7906b7c4a17bc545780aef34b7ddc82f1 [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{
Victor Stinner62bb3942012-08-06 00:46:05 +0200177 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{
Victor Stinner62bb3942012-08-06 00:46:05 +0200183 Py_UNICODE *p;
184 Py_ssize_t len;
Martin v. Löwis99866332002-03-01 10:27:01 +0000185
Victor Stinner62bb3942012-08-06 00:46:05 +0200186 if (!PyArg_Parse(v, "u#;array item must be unicode character", &p, &len))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000187 return -1;
Victor Stinner62bb3942012-08-06 00:46:05 +0200188 if (len != 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000189 PyErr_SetString(PyExc_TypeError,
190 "array item must be unicode character");
191 return -1;
192 }
193 if (i >= 0)
Victor Stinner62bb3942012-08-06 00:46:05 +0200194 ((Py_UNICODE *)ap->ob_item)[i] = p[0];
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000195 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},
Victor Stinner62bb3942012-08-06 00:46:05 +0200455 {'u', sizeof(Py_UNICODE), u_getitem, u_setitem, "u", 0, 0},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000456 {'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;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001248 _Py_IDENTIFIER(read);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001249 int not_enough_bytes;
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001250
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001251 if (!PyArg_ParseTuple(args, "On:fromfile", &f, &n))
1252 return NULL;
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001253
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001254 nbytes = n * itemsize;
1255 if (nbytes < 0 || nbytes/itemsize != n) {
1256 PyErr_NoMemory();
1257 return NULL;
1258 }
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001259
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02001260 b = _PyObject_CallMethodId(f, &PyId_read, "n", nbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001261 if (b == NULL)
1262 return NULL;
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001263
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001264 if (!PyBytes_Check(b)) {
1265 PyErr_SetString(PyExc_TypeError,
1266 "read() didn't return bytes");
1267 Py_DECREF(b);
1268 return NULL;
1269 }
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001270
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001271 not_enough_bytes = (PyBytes_GET_SIZE(b) != nbytes);
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001272
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001273 args = Py_BuildValue("(O)", b);
1274 Py_DECREF(b);
1275 if (args == NULL)
1276 return NULL;
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001277
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001278 res = array_frombytes(self, args);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001279 Py_DECREF(args);
1280 if (res == NULL)
1281 return NULL;
Hirokazu Yamamoto54d0df62009-03-06 03:04:07 +00001282
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001283 if (not_enough_bytes) {
1284 PyErr_SetString(PyExc_EOFError,
1285 "read() didn't return enough bytes");
1286 Py_DECREF(res);
1287 return NULL;
1288 }
Guido van Rossum2c94aa52007-05-24 19:02:32 +00001289
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001290 return res;
Guido van Rossum778983b1993-02-19 15:55:02 +00001291}
1292
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001293PyDoc_STRVAR(fromfile_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001294"fromfile(f, n)\n\
1295\n\
1296Read n objects from the file object f and append them to the end of the\n\
Georg Brandlf25ef502008-02-01 11:30:18 +00001297array.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001298
1299
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001300static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001301array_tofile(arrayobject *self, PyObject *f)
Guido van Rossum778983b1993-02-19 15:55:02 +00001302{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001303 Py_ssize_t nbytes = Py_SIZE(self) * self->ob_descr->itemsize;
1304 /* Write 64K blocks at a time */
1305 /* XXX Make the block size settable */
1306 int BLOCKSIZE = 64*1024;
1307 Py_ssize_t nblocks = (nbytes + BLOCKSIZE - 1) / BLOCKSIZE;
1308 Py_ssize_t i;
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001309
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001310 if (Py_SIZE(self) == 0)
1311 goto done;
Guido van Rossumb5ddcfd2007-04-11 17:08:28 +00001312
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001313 for (i = 0; i < nblocks; i++) {
1314 char* ptr = self->ob_item + i*BLOCKSIZE;
1315 Py_ssize_t size = BLOCKSIZE;
1316 PyObject *bytes, *res;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001317 _Py_IDENTIFIER(write);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02001318
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001319 if (i*BLOCKSIZE + size > nbytes)
1320 size = nbytes - i*BLOCKSIZE;
1321 bytes = PyBytes_FromStringAndSize(ptr, size);
1322 if (bytes == NULL)
1323 return NULL;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02001324 res = _PyObject_CallMethodId(f, &PyId_write, "O", bytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001325 Py_DECREF(bytes);
1326 if (res == NULL)
1327 return NULL;
1328 Py_DECREF(res); /* drop write result */
1329 }
Guido van Rossumb5ddcfd2007-04-11 17:08:28 +00001330
1331 done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001332 Py_INCREF(Py_None);
1333 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +00001334}
1335
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001336PyDoc_STRVAR(tofile_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001337"tofile(f)\n\
1338\n\
Georg Brandlf25ef502008-02-01 11:30:18 +00001339Write all items (as machine values) to the file object f.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001340
1341
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001342static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001343array_fromlist(arrayobject *self, PyObject *list)
Guido van Rossum778983b1993-02-19 15:55:02 +00001344{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001345 Py_ssize_t n;
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001346
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001347 if (!PyList_Check(list)) {
1348 PyErr_SetString(PyExc_TypeError, "arg must be list");
1349 return NULL;
1350 }
1351 n = PyList_Size(list);
1352 if (n > 0) {
1353 Py_ssize_t i, old_size;
1354 old_size = Py_SIZE(self);
1355 if (array_resize(self, old_size + n) == -1)
1356 return NULL;
1357 for (i = 0; i < n; i++) {
1358 PyObject *v = PyList_GetItem(list, i);
1359 if ((*self->ob_descr->setitem)(self,
1360 Py_SIZE(self) - n + i, v) != 0) {
1361 array_resize(self, old_size);
1362 return NULL;
1363 }
1364 }
1365 }
1366 Py_INCREF(Py_None);
1367 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +00001368}
1369
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001370PyDoc_STRVAR(fromlist_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001371"fromlist(list)\n\
1372\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001373Append items to array from list.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001374
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001375static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001376array_tolist(arrayobject *self, PyObject *unused)
Guido van Rossum778983b1993-02-19 15:55:02 +00001377{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001378 PyObject *list = PyList_New(Py_SIZE(self));
1379 Py_ssize_t i;
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001380
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001381 if (list == NULL)
1382 return NULL;
1383 for (i = 0; i < Py_SIZE(self); i++) {
1384 PyObject *v = getarrayitem((PyObject *)self, i);
1385 if (v == NULL) {
1386 Py_DECREF(list);
1387 return NULL;
1388 }
1389 PyList_SetItem(list, i, v);
1390 }
1391 return list;
Guido van Rossum778983b1993-02-19 15:55:02 +00001392}
1393
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001394PyDoc_STRVAR(tolist_doc,
Guido van Rossumfc6aba51998-10-14 02:52:31 +00001395"tolist() -> list\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001396\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001397Convert array to an ordinary list with the same items.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001398
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001399static PyObject *
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001400frombytes(arrayobject *self, Py_buffer *buffer)
Guido van Rossum778983b1993-02-19 15:55:02 +00001401{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001402 int itemsize = self->ob_descr->itemsize;
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001403 Py_ssize_t n;
1404 if (buffer->itemsize != 1) {
1405 PyBuffer_Release(buffer);
1406 PyErr_SetString(PyExc_TypeError, "string/buffer of bytes required.");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001407 return NULL;
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001408 }
1409 n = buffer->len;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001410 if (n % itemsize != 0) {
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001411 PyBuffer_Release(buffer);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001412 PyErr_SetString(PyExc_ValueError,
1413 "string length not a multiple of item size");
1414 return NULL;
1415 }
1416 n = n / itemsize;
1417 if (n > 0) {
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001418 Py_ssize_t old_size = Py_SIZE(self);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001419 if ((n > PY_SSIZE_T_MAX - old_size) ||
1420 ((old_size + n) > PY_SSIZE_T_MAX / itemsize)) {
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001421 PyBuffer_Release(buffer);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001422 return PyErr_NoMemory();
1423 }
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001424 if (array_resize(self, old_size + n) == -1) {
1425 PyBuffer_Release(buffer);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001426 return NULL;
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001427 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001428 memcpy(self->ob_item + old_size * itemsize,
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001429 buffer->buf, n * itemsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001430 }
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001431 PyBuffer_Release(buffer);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001432 Py_INCREF(Py_None);
1433 return Py_None;
Guido van Rossum778983b1993-02-19 15:55:02 +00001434}
1435
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001436static PyObject *
1437array_fromstring(arrayobject *self, PyObject *args)
1438{
1439 Py_buffer buffer;
1440 if (PyErr_WarnEx(PyExc_DeprecationWarning,
1441 "fromstring() is deprecated. Use frombytes() instead.", 2) != 0)
1442 return NULL;
1443 if (!PyArg_ParseTuple(args, "s*:fromstring", &buffer))
1444 return NULL;
1445 else
1446 return frombytes(self, &buffer);
1447}
1448
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001449PyDoc_STRVAR(fromstring_doc,
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001450"fromstring(string)\n\
1451\n\
1452Appends items from the string, interpreting it as an array of machine\n\
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001453values, as if it had been read from a file using the fromfile() method).\n\
1454\n\
1455This method is deprecated. Use frombytes instead.");
1456
1457
1458static PyObject *
1459array_frombytes(arrayobject *self, PyObject *args)
1460{
1461 Py_buffer buffer;
1462 if (!PyArg_ParseTuple(args, "y*:frombytes", &buffer))
1463 return NULL;
1464 else
1465 return frombytes(self, &buffer);
1466}
1467
1468PyDoc_STRVAR(frombytes_doc,
1469"frombytes(bytestring)\n\
1470\n\
1471Appends items from the string, interpreting it as an array of machine\n\
Walter Dörwald93b30b52007-06-22 12:21:53 +00001472values, as if it had been read from a file using the fromfile() method).");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001473
1474
Roger E. Masse2919eaa1996-12-09 20:10:36 +00001475static PyObject *
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001476array_tobytes(arrayobject *self, PyObject *unused)
Guido van Rossum778983b1993-02-19 15:55:02 +00001477{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001478 if (Py_SIZE(self) <= PY_SSIZE_T_MAX / self->ob_descr->itemsize) {
1479 return PyBytes_FromStringAndSize(self->ob_item,
1480 Py_SIZE(self) * self->ob_descr->itemsize);
1481 } else {
1482 return PyErr_NoMemory();
1483 }
Guido van Rossum778983b1993-02-19 15:55:02 +00001484}
1485
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001486PyDoc_STRVAR(tobytes_doc,
1487"tobytes() -> bytes\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001488\n\
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001489Convert the array to an array of machine values and return the bytes\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001490representation.");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00001491
Martin v. Löwis99866332002-03-01 10:27:01 +00001492
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001493static PyObject *
1494array_tostring(arrayobject *self, PyObject *unused)
1495{
Victor Stinner9f0b51e2010-11-09 09:38:30 +00001496 if (PyErr_WarnEx(PyExc_DeprecationWarning,
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00001497 "tostring() is deprecated. Use tobytes() instead.", 2) != 0)
1498 return NULL;
1499 return array_tobytes(self, unused);
1500}
1501
1502PyDoc_STRVAR(tostring_doc,
1503"tostring() -> bytes\n\
1504\n\
1505Convert the array to an array of machine values and return the bytes\n\
1506representation.\n\
1507\n\
1508This method is deprecated. Use tobytes instead.");
1509
Martin v. Löwis99866332002-03-01 10:27:01 +00001510
Martin v. Löwis99866332002-03-01 10:27:01 +00001511static PyObject *
1512array_fromunicode(arrayobject *self, PyObject *args)
1513{
Victor Stinner62bb3942012-08-06 00:46:05 +02001514 Py_UNICODE *ustr;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001515 Py_ssize_t n;
Victor Stinner62bb3942012-08-06 00:46:05 +02001516 char typecode;
Martin v. Löwis99866332002-03-01 10:27:01 +00001517
Victor Stinner62bb3942012-08-06 00:46:05 +02001518 if (!PyArg_ParseTuple(args, "u#:fromunicode", &ustr, &n))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001519 return NULL;
Victor Stinner62bb3942012-08-06 00:46:05 +02001520 typecode = self->ob_descr->typecode;
1521 if ((typecode != 'u')) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001522 PyErr_SetString(PyExc_ValueError,
1523 "fromunicode() may only be called on "
1524 "unicode type arrays");
1525 return NULL;
1526 }
1527 if (n > 0) {
1528 Py_ssize_t old_size = Py_SIZE(self);
1529 if (array_resize(self, old_size + n) == -1)
1530 return NULL;
Victor Stinner62bb3942012-08-06 00:46:05 +02001531 memcpy(self->ob_item + old_size * sizeof(Py_UNICODE),
1532 ustr, n * sizeof(Py_UNICODE));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001533 }
Martin v. Löwis99866332002-03-01 10:27:01 +00001534
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001535 Py_INCREF(Py_None);
1536 return Py_None;
Martin v. Löwis99866332002-03-01 10:27:01 +00001537}
1538
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001539PyDoc_STRVAR(fromunicode_doc,
Martin v. Löwis99866332002-03-01 10:27:01 +00001540"fromunicode(ustr)\n\
1541\n\
1542Extends this array with data from the unicode string ustr.\n\
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001543The array must be a unicode type array; otherwise a ValueError\n\
Florent Xiclunac45fb252011-10-24 13:14:55 +02001544is raised. Use array.frombytes(ustr.encode(...)) to\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001545append Unicode data to an array of some other type.");
Martin v. Löwis99866332002-03-01 10:27:01 +00001546
1547
1548static PyObject *
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +00001549array_tounicode(arrayobject *self, PyObject *unused)
Martin v. Löwis99866332002-03-01 10:27:01 +00001550{
Victor Stinner62bb3942012-08-06 00:46:05 +02001551 char typecode;
1552 typecode = self->ob_descr->typecode;
1553 if ((typecode != 'u')) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001554 PyErr_SetString(PyExc_ValueError,
1555 "tounicode() may only be called on unicode type arrays");
1556 return NULL;
1557 }
Victor Stinner62bb3942012-08-06 00:46:05 +02001558 return PyUnicode_FromUnicode((Py_UNICODE *) self->ob_item, Py_SIZE(self));
Martin v. Löwis99866332002-03-01 10:27:01 +00001559}
1560
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001561PyDoc_STRVAR(tounicode_doc,
Martin v. Löwis99866332002-03-01 10:27:01 +00001562"tounicode() -> unicode\n\
1563\n\
1564Convert the array to a unicode string. The array must be\n\
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001565a unicode type array; otherwise a ValueError is raised. Use\n\
Florent Xiclunac45fb252011-10-24 13:14:55 +02001566array.tobytes().decode() to obtain a unicode string from\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001567an array of some other type.");
Martin v. Löwis99866332002-03-01 10:27:01 +00001568
Martin v. Löwis99866332002-03-01 10:27:01 +00001569
Meador Inge03b4d502012-08-10 22:35:45 -05001570static PyObject *
1571array_sizeof(arrayobject *self, PyObject *unused)
1572{
1573 Py_ssize_t res;
1574 res = sizeof(arrayobject) + self->allocated * self->ob_descr->itemsize;
1575 return PyLong_FromSsize_t(res);
1576}
1577
1578PyDoc_STRVAR(sizeof_doc,
1579"__sizeof__() -> int\n\
1580\n\
1581Size of the array in memory, in bytes.");
1582
Martin v. Löwis99866332002-03-01 10:27:01 +00001583
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001584/*********************** Pickling support ************************/
1585
1586enum machine_format_code {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001587 UNKNOWN_FORMAT = -1,
1588 /* UNKNOWN_FORMAT is used to indicate that the machine format for an
1589 * array type code cannot be interpreted. When this occurs, a list of
1590 * Python objects is used to represent the content of the array
1591 * instead of using the memory content of the array directly. In that
1592 * case, the array_reconstructor mechanism is bypassed completely, and
1593 * the standard array constructor is used instead.
1594 *
1595 * This is will most likely occur when the machine doesn't use IEEE
1596 * floating-point numbers.
1597 */
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001598
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001599 UNSIGNED_INT8 = 0,
1600 SIGNED_INT8 = 1,
1601 UNSIGNED_INT16_LE = 2,
1602 UNSIGNED_INT16_BE = 3,
1603 SIGNED_INT16_LE = 4,
1604 SIGNED_INT16_BE = 5,
1605 UNSIGNED_INT32_LE = 6,
1606 UNSIGNED_INT32_BE = 7,
1607 SIGNED_INT32_LE = 8,
1608 SIGNED_INT32_BE = 9,
1609 UNSIGNED_INT64_LE = 10,
1610 UNSIGNED_INT64_BE = 11,
1611 SIGNED_INT64_LE = 12,
1612 SIGNED_INT64_BE = 13,
1613 IEEE_754_FLOAT_LE = 14,
1614 IEEE_754_FLOAT_BE = 15,
1615 IEEE_754_DOUBLE_LE = 16,
1616 IEEE_754_DOUBLE_BE = 17,
1617 UTF16_LE = 18,
1618 UTF16_BE = 19,
1619 UTF32_LE = 20,
1620 UTF32_BE = 21
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001621};
1622#define MACHINE_FORMAT_CODE_MIN 0
1623#define MACHINE_FORMAT_CODE_MAX 21
1624
1625static const struct mformatdescr {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001626 size_t size;
1627 int is_signed;
1628 int is_big_endian;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001629} mformat_descriptors[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001630 {1, 0, 0}, /* 0: UNSIGNED_INT8 */
1631 {1, 1, 0}, /* 1: SIGNED_INT8 */
1632 {2, 0, 0}, /* 2: UNSIGNED_INT16_LE */
1633 {2, 0, 1}, /* 3: UNSIGNED_INT16_BE */
1634 {2, 1, 0}, /* 4: SIGNED_INT16_LE */
1635 {2, 1, 1}, /* 5: SIGNED_INT16_BE */
1636 {4, 0, 0}, /* 6: UNSIGNED_INT32_LE */
1637 {4, 0, 1}, /* 7: UNSIGNED_INT32_BE */
1638 {4, 1, 0}, /* 8: SIGNED_INT32_LE */
1639 {4, 1, 1}, /* 9: SIGNED_INT32_BE */
1640 {8, 0, 0}, /* 10: UNSIGNED_INT64_LE */
1641 {8, 0, 1}, /* 11: UNSIGNED_INT64_BE */
1642 {8, 1, 0}, /* 12: SIGNED_INT64_LE */
1643 {8, 1, 1}, /* 13: SIGNED_INT64_BE */
1644 {4, 0, 0}, /* 14: IEEE_754_FLOAT_LE */
1645 {4, 0, 1}, /* 15: IEEE_754_FLOAT_BE */
1646 {8, 0, 0}, /* 16: IEEE_754_DOUBLE_LE */
1647 {8, 0, 1}, /* 17: IEEE_754_DOUBLE_BE */
1648 {4, 0, 0}, /* 18: UTF16_LE */
1649 {4, 0, 1}, /* 19: UTF16_BE */
1650 {8, 0, 0}, /* 20: UTF32_LE */
1651 {8, 0, 1} /* 21: UTF32_BE */
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001652};
1653
1654
1655/*
1656 * Internal: This function is used to find the machine format of a given
1657 * array type code. This returns UNKNOWN_FORMAT when the machine format cannot
1658 * be found.
1659 */
1660static enum machine_format_code
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02001661typecode_to_mformat_code(char typecode)
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001662{
Alexandre Vassalotti7aaa7702009-07-17 03:51:27 +00001663#ifdef WORDS_BIGENDIAN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001664 const int is_big_endian = 1;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001665#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001666 const int is_big_endian = 0;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001667#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001668 size_t intsize;
1669 int is_signed;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001670
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001671 switch (typecode) {
1672 case 'b':
1673 return SIGNED_INT8;
1674 case 'B':
1675 return UNSIGNED_INT8;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001676
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001677 case 'u':
Victor Stinner62bb3942012-08-06 00:46:05 +02001678 if (sizeof(Py_UNICODE) == 2) {
1679 return UTF16_LE + is_big_endian;
1680 }
1681 if (sizeof(Py_UNICODE) == 4) {
1682 return UTF32_LE + is_big_endian;
1683 }
1684 return UNKNOWN_FORMAT;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001685
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001686 case 'f':
1687 if (sizeof(float) == 4) {
1688 const float y = 16711938.0;
1689 if (memcmp(&y, "\x4b\x7f\x01\x02", 4) == 0)
1690 return IEEE_754_FLOAT_BE;
1691 if (memcmp(&y, "\x02\x01\x7f\x4b", 4) == 0)
1692 return IEEE_754_FLOAT_LE;
1693 }
1694 return UNKNOWN_FORMAT;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001695
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001696 case 'd':
1697 if (sizeof(double) == 8) {
1698 const double x = 9006104071832581.0;
1699 if (memcmp(&x, "\x43\x3f\xff\x01\x02\x03\x04\x05", 8) == 0)
1700 return IEEE_754_DOUBLE_BE;
1701 if (memcmp(&x, "\x05\x04\x03\x02\x01\xff\x3f\x43", 8) == 0)
1702 return IEEE_754_DOUBLE_LE;
1703 }
1704 return UNKNOWN_FORMAT;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001705
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001706 /* Integers */
1707 case 'h':
1708 intsize = sizeof(short);
1709 is_signed = 1;
1710 break;
1711 case 'H':
1712 intsize = sizeof(short);
1713 is_signed = 0;
1714 break;
1715 case 'i':
1716 intsize = sizeof(int);
1717 is_signed = 1;
1718 break;
1719 case 'I':
1720 intsize = sizeof(int);
1721 is_signed = 0;
1722 break;
1723 case 'l':
1724 intsize = sizeof(long);
1725 is_signed = 1;
1726 break;
1727 case 'L':
1728 intsize = sizeof(long);
1729 is_signed = 0;
1730 break;
Meador Inge1c9f0c92011-09-20 19:55:51 -05001731#if HAVE_LONG_LONG
1732 case 'q':
1733 intsize = sizeof(PY_LONG_LONG);
1734 is_signed = 1;
1735 break;
1736 case 'Q':
1737 intsize = sizeof(PY_LONG_LONG);
1738 is_signed = 0;
1739 break;
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02001740#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001741 default:
1742 return UNKNOWN_FORMAT;
1743 }
1744 switch (intsize) {
1745 case 2:
1746 return UNSIGNED_INT16_LE + is_big_endian + (2 * is_signed);
1747 case 4:
1748 return UNSIGNED_INT32_LE + is_big_endian + (2 * is_signed);
1749 case 8:
1750 return UNSIGNED_INT64_LE + is_big_endian + (2 * is_signed);
1751 default:
1752 return UNKNOWN_FORMAT;
1753 }
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001754}
1755
1756/* Forward declaration. */
1757static PyObject *array_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
1758
1759/*
1760 * Internal: This function wraps the array constructor--i.e., array_new()--to
1761 * allow the creation of array objects from C code without having to deal
1762 * directly the tuple argument of array_new(). The typecode argument is a
1763 * Unicode character value, like 'i' or 'f' for example, representing an array
1764 * type code. The items argument is a bytes or a list object from which
1765 * contains the initial value of the array.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001766 *
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001767 * On success, this functions returns the array object created. Otherwise,
1768 * NULL is returned to indicate a failure.
1769 */
1770static PyObject *
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02001771make_array(PyTypeObject *arraytype, char typecode, PyObject *items)
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001772{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001773 PyObject *new_args;
1774 PyObject *array_obj;
1775 PyObject *typecode_obj;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001776
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001777 assert(arraytype != NULL);
1778 assert(items != NULL);
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001779
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02001780 typecode_obj = PyUnicode_FromOrdinal(typecode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001781 if (typecode_obj == NULL)
1782 return NULL;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001783
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001784 new_args = PyTuple_New(2);
1785 if (new_args == NULL)
1786 return NULL;
1787 Py_INCREF(items);
1788 PyTuple_SET_ITEM(new_args, 0, typecode_obj);
1789 PyTuple_SET_ITEM(new_args, 1, items);
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001790
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001791 array_obj = array_new(arraytype, new_args, NULL);
1792 Py_DECREF(new_args);
1793 if (array_obj == NULL)
1794 return NULL;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001795
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001796 return array_obj;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001797}
1798
1799/*
1800 * This functions is a special constructor used when unpickling an array. It
1801 * provides a portable way to rebuild an array from its memory representation.
1802 */
1803static PyObject *
1804array_reconstructor(PyObject *self, PyObject *args)
1805{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001806 PyTypeObject *arraytype;
1807 PyObject *items;
1808 PyObject *converted_items;
1809 PyObject *result;
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02001810 int typecode;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001811 enum machine_format_code mformat_code;
1812 struct arraydescr *descr;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001813
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001814 if (!PyArg_ParseTuple(args, "OCiO:array._array_reconstructor",
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02001815 &arraytype, &typecode, &mformat_code, &items))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001816 return NULL;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001817
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001818 if (!PyType_Check(arraytype)) {
1819 PyErr_Format(PyExc_TypeError,
1820 "first argument must a type object, not %.200s",
1821 Py_TYPE(arraytype)->tp_name);
1822 return NULL;
1823 }
1824 if (!PyType_IsSubtype(arraytype, &Arraytype)) {
1825 PyErr_Format(PyExc_TypeError,
1826 "%.200s is not a subtype of %.200s",
1827 arraytype->tp_name, Arraytype.tp_name);
1828 return NULL;
1829 }
1830 for (descr = descriptors; descr->typecode != '\0'; descr++) {
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02001831 if ((int)descr->typecode == typecode)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001832 break;
1833 }
1834 if (descr->typecode == '\0') {
1835 PyErr_SetString(PyExc_ValueError,
1836 "second argument must be a valid type code");
1837 return NULL;
1838 }
1839 if (mformat_code < MACHINE_FORMAT_CODE_MIN ||
1840 mformat_code > MACHINE_FORMAT_CODE_MAX) {
1841 PyErr_SetString(PyExc_ValueError,
1842 "third argument must be a valid machine format code.");
1843 return NULL;
1844 }
1845 if (!PyBytes_Check(items)) {
1846 PyErr_Format(PyExc_TypeError,
1847 "fourth argument should be bytes, not %.200s",
1848 Py_TYPE(items)->tp_name);
1849 return NULL;
1850 }
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001851
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001852 /* Fast path: No decoding has to be done. */
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02001853 if (mformat_code == typecode_to_mformat_code((char)typecode) ||
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001854 mformat_code == UNKNOWN_FORMAT) {
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02001855 return make_array(arraytype, (char)typecode, items);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001856 }
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001857
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001858 /* Slow path: Decode the byte string according to the given machine
1859 * format code. This occurs when the computer unpickling the array
1860 * object is architecturally different from the one that pickled the
1861 * array.
1862 */
1863 if (Py_SIZE(items) % mformat_descriptors[mformat_code].size != 0) {
1864 PyErr_SetString(PyExc_ValueError,
1865 "string length not a multiple of item size");
1866 return NULL;
1867 }
1868 switch (mformat_code) {
1869 case IEEE_754_FLOAT_LE:
1870 case IEEE_754_FLOAT_BE: {
1871 int i;
1872 int le = (mformat_code == IEEE_754_FLOAT_LE) ? 1 : 0;
1873 Py_ssize_t itemcount = Py_SIZE(items) / 4;
1874 const unsigned char *memstr =
1875 (unsigned char *)PyBytes_AS_STRING(items);
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001876
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001877 converted_items = PyList_New(itemcount);
1878 if (converted_items == NULL)
1879 return NULL;
1880 for (i = 0; i < itemcount; i++) {
1881 PyObject *pyfloat = PyFloat_FromDouble(
1882 _PyFloat_Unpack4(&memstr[i * 4], le));
1883 if (pyfloat == NULL) {
1884 Py_DECREF(converted_items);
1885 return NULL;
1886 }
1887 PyList_SET_ITEM(converted_items, i, pyfloat);
1888 }
1889 break;
1890 }
1891 case IEEE_754_DOUBLE_LE:
1892 case IEEE_754_DOUBLE_BE: {
1893 int i;
1894 int le = (mformat_code == IEEE_754_DOUBLE_LE) ? 1 : 0;
1895 Py_ssize_t itemcount = Py_SIZE(items) / 8;
1896 const unsigned char *memstr =
1897 (unsigned char *)PyBytes_AS_STRING(items);
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001898
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001899 converted_items = PyList_New(itemcount);
1900 if (converted_items == NULL)
1901 return NULL;
1902 for (i = 0; i < itemcount; i++) {
1903 PyObject *pyfloat = PyFloat_FromDouble(
1904 _PyFloat_Unpack8(&memstr[i * 8], le));
1905 if (pyfloat == NULL) {
1906 Py_DECREF(converted_items);
1907 return NULL;
1908 }
1909 PyList_SET_ITEM(converted_items, i, pyfloat);
1910 }
1911 break;
1912 }
1913 case UTF16_LE:
1914 case UTF16_BE: {
1915 int byteorder = (mformat_code == UTF16_LE) ? -1 : 1;
1916 converted_items = PyUnicode_DecodeUTF16(
1917 PyBytes_AS_STRING(items), Py_SIZE(items),
1918 "strict", &byteorder);
1919 if (converted_items == NULL)
1920 return NULL;
1921 break;
1922 }
1923 case UTF32_LE:
1924 case UTF32_BE: {
1925 int byteorder = (mformat_code == UTF32_LE) ? -1 : 1;
1926 converted_items = PyUnicode_DecodeUTF32(
1927 PyBytes_AS_STRING(items), Py_SIZE(items),
1928 "strict", &byteorder);
1929 if (converted_items == NULL)
1930 return NULL;
1931 break;
1932 }
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001933
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001934 case UNSIGNED_INT8:
1935 case SIGNED_INT8:
1936 case UNSIGNED_INT16_LE:
1937 case UNSIGNED_INT16_BE:
1938 case SIGNED_INT16_LE:
1939 case SIGNED_INT16_BE:
1940 case UNSIGNED_INT32_LE:
1941 case UNSIGNED_INT32_BE:
1942 case SIGNED_INT32_LE:
1943 case SIGNED_INT32_BE:
1944 case UNSIGNED_INT64_LE:
1945 case UNSIGNED_INT64_BE:
1946 case SIGNED_INT64_LE:
1947 case SIGNED_INT64_BE: {
1948 int i;
1949 const struct mformatdescr mf_descr =
1950 mformat_descriptors[mformat_code];
1951 Py_ssize_t itemcount = Py_SIZE(items) / mf_descr.size;
1952 const unsigned char *memstr =
1953 (unsigned char *)PyBytes_AS_STRING(items);
1954 struct arraydescr *descr;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001955
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001956 /* If possible, try to pack array's items using a data type
1957 * that fits better. This may result in an array with narrower
1958 * or wider elements.
1959 *
1960 * For example, if a 32-bit machine pickles a L-code array of
1961 * unsigned longs, then the array will be unpickled by 64-bit
1962 * machine as an I-code array of unsigned ints.
1963 *
1964 * XXX: Is it possible to write a unit test for this?
1965 */
1966 for (descr = descriptors; descr->typecode != '\0'; descr++) {
1967 if (descr->is_integer_type &&
1968 descr->itemsize == mf_descr.size &&
1969 descr->is_signed == mf_descr.is_signed)
1970 typecode = descr->typecode;
1971 }
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001972
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001973 converted_items = PyList_New(itemcount);
1974 if (converted_items == NULL)
1975 return NULL;
1976 for (i = 0; i < itemcount; i++) {
1977 PyObject *pylong;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00001978
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001979 pylong = _PyLong_FromByteArray(
1980 &memstr[i * mf_descr.size],
1981 mf_descr.size,
1982 !mf_descr.is_big_endian,
1983 mf_descr.is_signed);
1984 if (pylong == NULL) {
1985 Py_DECREF(converted_items);
1986 return NULL;
1987 }
1988 PyList_SET_ITEM(converted_items, i, pylong);
1989 }
1990 break;
1991 }
1992 case UNKNOWN_FORMAT:
1993 /* Impossible, but needed to shut up GCC about the unhandled
1994 * enumeration value.
1995 */
1996 default:
1997 PyErr_BadArgument();
1998 return NULL;
1999 }
Alexandre Vassalottiad077152009-07-15 17:49:23 +00002000
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02002001 result = make_array(arraytype, (char)typecode, converted_items);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002002 Py_DECREF(converted_items);
2003 return result;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00002004}
2005
2006static PyObject *
2007array_reduce_ex(arrayobject *array, PyObject *value)
2008{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002009 PyObject *dict;
2010 PyObject *result;
2011 PyObject *array_str;
2012 int typecode = array->ob_descr->typecode;
2013 int mformat_code;
2014 static PyObject *array_reconstructor = NULL;
2015 long protocol;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002016 _Py_IDENTIFIER(_array_reconstructor);
2017 _Py_IDENTIFIER(__dict__);
Alexandre Vassalottiad077152009-07-15 17:49:23 +00002018
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002019 if (array_reconstructor == NULL) {
2020 PyObject *array_module = PyImport_ImportModule("array");
2021 if (array_module == NULL)
2022 return NULL;
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02002023 array_reconstructor = _PyObject_GetAttrId(
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002024 array_module,
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02002025 &PyId__array_reconstructor);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002026 Py_DECREF(array_module);
2027 if (array_reconstructor == NULL)
2028 return NULL;
2029 }
Alexandre Vassalottiad077152009-07-15 17:49:23 +00002030
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002031 if (!PyLong_Check(value)) {
2032 PyErr_SetString(PyExc_TypeError,
2033 "__reduce_ex__ argument should an integer");
2034 return NULL;
2035 }
2036 protocol = PyLong_AsLong(value);
2037 if (protocol == -1 && PyErr_Occurred())
2038 return NULL;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00002039
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02002040 dict = _PyObject_GetAttrId((PyObject *)array, &PyId___dict__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002041 if (dict == NULL) {
2042 if (!PyErr_ExceptionMatches(PyExc_AttributeError))
2043 return NULL;
2044 PyErr_Clear();
2045 dict = Py_None;
2046 Py_INCREF(dict);
2047 }
Alexandre Vassalottiad077152009-07-15 17:49:23 +00002048
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002049 mformat_code = typecode_to_mformat_code(typecode);
2050 if (mformat_code == UNKNOWN_FORMAT || protocol < 3) {
2051 /* Convert the array to a list if we got something weird
2052 * (e.g., non-IEEE floats), or we are pickling the array using
2053 * a Python 2.x compatible protocol.
2054 *
2055 * It is necessary to use a list representation for Python 2.x
2056 * compatible pickle protocol, since Python 2's str objects
2057 * are unpickled as unicode by Python 3. Thus it is impossible
2058 * to make arrays unpicklable by Python 3 by using their memory
2059 * representation, unless we resort to ugly hacks such as
2060 * coercing unicode objects to bytes in array_reconstructor.
2061 */
2062 PyObject *list;
2063 list = array_tolist(array, NULL);
2064 if (list == NULL) {
2065 Py_DECREF(dict);
2066 return NULL;
2067 }
2068 result = Py_BuildValue(
2069 "O(CO)O", Py_TYPE(array), typecode, list, dict);
2070 Py_DECREF(list);
2071 Py_DECREF(dict);
2072 return result;
2073 }
Alexandre Vassalottiad077152009-07-15 17:49:23 +00002074
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00002075 array_str = array_tobytes(array, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002076 if (array_str == NULL) {
2077 Py_DECREF(dict);
2078 return NULL;
2079 }
2080 result = Py_BuildValue(
2081 "O(OCiN)O", array_reconstructor, Py_TYPE(array), typecode,
2082 mformat_code, array_str, dict);
2083 Py_DECREF(dict);
2084 return result;
Alexandre Vassalottiad077152009-07-15 17:49:23 +00002085}
2086
2087PyDoc_STRVAR(reduce_doc, "Return state information for pickling.");
2088
Martin v. Löwis99866332002-03-01 10:27:01 +00002089static PyObject *
2090array_get_typecode(arrayobject *a, void *closure)
2091{
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02002092 char typecode = a->ob_descr->typecode;
2093 return PyUnicode_FromOrdinal(typecode);
Martin v. Löwis99866332002-03-01 10:27:01 +00002094}
2095
2096static PyObject *
2097array_get_itemsize(arrayobject *a, void *closure)
2098{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002099 return PyLong_FromLong((long)a->ob_descr->itemsize);
Martin v. Löwis99866332002-03-01 10:27:01 +00002100}
2101
2102static PyGetSetDef array_getsets [] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002103 {"typecode", (getter) array_get_typecode, NULL,
2104 "the typecode character used to create the array"},
2105 {"itemsize", (getter) array_get_itemsize, NULL,
2106 "the size, in bytes, of one array item"},
2107 {NULL}
Martin v. Löwis99866332002-03-01 10:27:01 +00002108};
2109
Martin v. Löwis59683e82008-06-13 07:50:45 +00002110static PyMethodDef array_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002111 {"append", (PyCFunction)array_append, METH_O,
2112 append_doc},
2113 {"buffer_info", (PyCFunction)array_buffer_info, METH_NOARGS,
2114 buffer_info_doc},
2115 {"byteswap", (PyCFunction)array_byteswap, METH_NOARGS,
2116 byteswap_doc},
2117 {"__copy__", (PyCFunction)array_copy, METH_NOARGS,
2118 copy_doc},
2119 {"count", (PyCFunction)array_count, METH_O,
2120 count_doc},
2121 {"__deepcopy__",(PyCFunction)array_copy, METH_O,
2122 copy_doc},
2123 {"extend", (PyCFunction)array_extend, METH_O,
2124 extend_doc},
2125 {"fromfile", (PyCFunction)array_fromfile, METH_VARARGS,
2126 fromfile_doc},
2127 {"fromlist", (PyCFunction)array_fromlist, METH_O,
2128 fromlist_doc},
2129 {"fromstring", (PyCFunction)array_fromstring, METH_VARARGS,
2130 fromstring_doc},
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00002131 {"frombytes", (PyCFunction)array_frombytes, METH_VARARGS,
2132 frombytes_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002133 {"fromunicode", (PyCFunction)array_fromunicode, METH_VARARGS,
2134 fromunicode_doc},
2135 {"index", (PyCFunction)array_index, METH_O,
2136 index_doc},
2137 {"insert", (PyCFunction)array_insert, METH_VARARGS,
2138 insert_doc},
2139 {"pop", (PyCFunction)array_pop, METH_VARARGS,
2140 pop_doc},
2141 {"__reduce_ex__", (PyCFunction)array_reduce_ex, METH_O,
2142 reduce_doc},
2143 {"remove", (PyCFunction)array_remove, METH_O,
2144 remove_doc},
2145 {"reverse", (PyCFunction)array_reverse, METH_NOARGS,
2146 reverse_doc},
2147/* {"sort", (PyCFunction)array_sort, METH_VARARGS,
2148 sort_doc},*/
2149 {"tofile", (PyCFunction)array_tofile, METH_O,
2150 tofile_doc},
2151 {"tolist", (PyCFunction)array_tolist, METH_NOARGS,
2152 tolist_doc},
2153 {"tostring", (PyCFunction)array_tostring, METH_NOARGS,
2154 tostring_doc},
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00002155 {"tobytes", (PyCFunction)array_tobytes, METH_NOARGS,
2156 tobytes_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002157 {"tounicode", (PyCFunction)array_tounicode, METH_NOARGS,
2158 tounicode_doc},
Meador Inge03b4d502012-08-10 22:35:45 -05002159 {"__sizeof__", (PyCFunction)array_sizeof, METH_NOARGS,
2160 sizeof_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002161 {NULL, NULL} /* sentinel */
Guido van Rossum778983b1993-02-19 15:55:02 +00002162};
2163
Roger E. Masse2919eaa1996-12-09 20:10:36 +00002164static PyObject *
Peter Schneider-Kamp9656abd2000-07-13 21:10:57 +00002165array_repr(arrayobject *a)
Guido van Rossum778983b1993-02-19 15:55:02 +00002166{
Victor Stinnerf8bb7d02011-09-30 00:03:59 +02002167 char typecode;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002168 PyObject *s, *v = NULL;
2169 Py_ssize_t len;
Martin v. Löwis99866332002-03-01 10:27:01 +00002170
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002171 len = Py_SIZE(a);
2172 typecode = a->ob_descr->typecode;
2173 if (len == 0) {
Amaury Forgeot d'Arc24aa26b2010-11-25 08:13:35 +00002174 return PyUnicode_FromFormat("array('%c')", (int)typecode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002175 }
Brett Cannon4a5e5de2011-06-07 20:09:32 -07002176 if (typecode == 'u')
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002177 v = array_tounicode(a, NULL);
2178 else
2179 v = array_tolist(a, NULL);
Raymond Hettinger88ba1e32003-04-23 17:27:00 +00002180
Amaury Forgeot d'Arc24aa26b2010-11-25 08:13:35 +00002181 s = PyUnicode_FromFormat("array('%c', %R)", (int)typecode, v);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002182 Py_DECREF(v);
2183 return s;
Guido van Rossum778983b1993-02-19 15:55:02 +00002184}
2185
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00002186static PyObject*
2187array_subscr(arrayobject* self, PyObject* item)
2188{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002189 if (PyIndex_Check(item)) {
2190 Py_ssize_t i = PyNumber_AsSsize_t(item, PyExc_IndexError);
2191 if (i==-1 && PyErr_Occurred()) {
2192 return NULL;
2193 }
2194 if (i < 0)
2195 i += Py_SIZE(self);
2196 return array_item(self, i);
2197 }
2198 else if (PySlice_Check(item)) {
2199 Py_ssize_t start, stop, step, slicelength, cur, i;
2200 PyObject* result;
2201 arrayobject* ar;
2202 int itemsize = self->ob_descr->itemsize;
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00002203
Martin v. Löwis4d0d4712010-12-03 20:14:31 +00002204 if (PySlice_GetIndicesEx(item, Py_SIZE(self),
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002205 &start, &stop, &step, &slicelength) < 0) {
2206 return NULL;
2207 }
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00002208
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002209 if (slicelength <= 0) {
2210 return newarrayobject(&Arraytype, 0, self->ob_descr);
2211 }
2212 else if (step == 1) {
2213 PyObject *result = newarrayobject(&Arraytype,
2214 slicelength, self->ob_descr);
2215 if (result == NULL)
2216 return NULL;
2217 memcpy(((arrayobject *)result)->ob_item,
2218 self->ob_item + start * itemsize,
2219 slicelength * itemsize);
2220 return result;
2221 }
2222 else {
2223 result = newarrayobject(&Arraytype, slicelength, self->ob_descr);
2224 if (!result) return NULL;
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00002225
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002226 ar = (arrayobject*)result;
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00002227
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002228 for (cur = start, i = 0; i < slicelength;
2229 cur += step, i++) {
2230 memcpy(ar->ob_item + i*itemsize,
2231 self->ob_item + cur*itemsize,
2232 itemsize);
2233 }
2234
2235 return result;
2236 }
2237 }
2238 else {
2239 PyErr_SetString(PyExc_TypeError,
2240 "array indices must be integers");
2241 return NULL;
2242 }
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00002243}
2244
2245static int
2246array_ass_subscr(arrayobject* self, PyObject* item, PyObject* value)
2247{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002248 Py_ssize_t start, stop, step, slicelength, needed;
2249 arrayobject* other;
2250 int itemsize;
Thomas Woutersed03b412007-08-28 21:37:11 +00002251
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002252 if (PyIndex_Check(item)) {
2253 Py_ssize_t i = PyNumber_AsSsize_t(item, PyExc_IndexError);
Alexandre Vassalotti47137252009-07-05 19:57:00 +00002254
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002255 if (i == -1 && PyErr_Occurred())
2256 return -1;
2257 if (i < 0)
2258 i += Py_SIZE(self);
2259 if (i < 0 || i >= Py_SIZE(self)) {
2260 PyErr_SetString(PyExc_IndexError,
2261 "array assignment index out of range");
2262 return -1;
2263 }
2264 if (value == NULL) {
2265 /* Fall through to slice assignment */
2266 start = i;
2267 stop = i + 1;
2268 step = 1;
2269 slicelength = 1;
2270 }
2271 else
2272 return (*self->ob_descr->setitem)(self, i, value);
2273 }
2274 else if (PySlice_Check(item)) {
Martin v. Löwis4d0d4712010-12-03 20:14:31 +00002275 if (PySlice_GetIndicesEx(item,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002276 Py_SIZE(self), &start, &stop,
2277 &step, &slicelength) < 0) {
2278 return -1;
2279 }
2280 }
2281 else {
2282 PyErr_SetString(PyExc_TypeError,
2283 "array indices must be integer");
2284 return -1;
2285 }
2286 if (value == NULL) {
2287 other = NULL;
2288 needed = 0;
2289 }
2290 else if (array_Check(value)) {
2291 other = (arrayobject *)value;
2292 needed = Py_SIZE(other);
2293 if (self == other) {
2294 /* Special case "self[i:j] = self" -- copy self first */
2295 int ret;
2296 value = array_slice(other, 0, needed);
2297 if (value == NULL)
2298 return -1;
2299 ret = array_ass_subscr(self, item, value);
2300 Py_DECREF(value);
2301 return ret;
2302 }
2303 if (other->ob_descr != self->ob_descr) {
2304 PyErr_BadArgument();
2305 return -1;
2306 }
2307 }
2308 else {
2309 PyErr_Format(PyExc_TypeError,
2310 "can only assign array (not \"%.200s\") to array slice",
2311 Py_TYPE(value)->tp_name);
2312 return -1;
2313 }
2314 itemsize = self->ob_descr->itemsize;
2315 /* for 'a[2:1] = ...', the insertion point is 'start', not 'stop' */
2316 if ((step > 0 && stop < start) ||
2317 (step < 0 && stop > start))
2318 stop = start;
Alexandre Vassalotti47137252009-07-05 19:57:00 +00002319
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002320 /* Issue #4509: If the array has exported buffers and the slice
2321 assignment would change the size of the array, fail early to make
2322 sure we don't modify it. */
2323 if ((needed == 0 || slicelength != needed) && self->ob_exports > 0) {
2324 PyErr_SetString(PyExc_BufferError,
2325 "cannot resize an array that is exporting buffers");
2326 return -1;
2327 }
Mark Dickinsonbc099642010-01-29 17:27:24 +00002328
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002329 if (step == 1) {
2330 if (slicelength > needed) {
2331 memmove(self->ob_item + (start + needed) * itemsize,
2332 self->ob_item + stop * itemsize,
2333 (Py_SIZE(self) - stop) * itemsize);
2334 if (array_resize(self, Py_SIZE(self) +
2335 needed - slicelength) < 0)
2336 return -1;
2337 }
2338 else if (slicelength < needed) {
2339 if (array_resize(self, Py_SIZE(self) +
2340 needed - slicelength) < 0)
2341 return -1;
2342 memmove(self->ob_item + (start + needed) * itemsize,
2343 self->ob_item + stop * itemsize,
2344 (Py_SIZE(self) - start - needed) * itemsize);
2345 }
2346 if (needed > 0)
2347 memcpy(self->ob_item + start * itemsize,
2348 other->ob_item, needed * itemsize);
2349 return 0;
2350 }
2351 else if (needed == 0) {
2352 /* Delete slice */
2353 size_t cur;
2354 Py_ssize_t i;
Thomas Woutersed03b412007-08-28 21:37:11 +00002355
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002356 if (step < 0) {
2357 stop = start + 1;
2358 start = stop + step * (slicelength - 1) - 1;
2359 step = -step;
2360 }
2361 for (cur = start, i = 0; i < slicelength;
2362 cur += step, i++) {
2363 Py_ssize_t lim = step - 1;
Thomas Woutersed03b412007-08-28 21:37:11 +00002364
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002365 if (cur + step >= (size_t)Py_SIZE(self))
2366 lim = Py_SIZE(self) - cur - 1;
2367 memmove(self->ob_item + (cur - i) * itemsize,
2368 self->ob_item + (cur + 1) * itemsize,
2369 lim * itemsize);
2370 }
Mark Dickinsonc7d93b72011-09-25 15:34:32 +01002371 cur = start + (size_t)slicelength * step;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002372 if (cur < (size_t)Py_SIZE(self)) {
2373 memmove(self->ob_item + (cur-slicelength) * itemsize,
2374 self->ob_item + cur * itemsize,
2375 (Py_SIZE(self) - cur) * itemsize);
2376 }
2377 if (array_resize(self, Py_SIZE(self) - slicelength) < 0)
2378 return -1;
2379 return 0;
2380 }
2381 else {
2382 Py_ssize_t cur, i;
2383
2384 if (needed != slicelength) {
2385 PyErr_Format(PyExc_ValueError,
2386 "attempt to assign array of size %zd "
2387 "to extended slice of size %zd",
2388 needed, slicelength);
2389 return -1;
2390 }
2391 for (cur = start, i = 0; i < slicelength;
2392 cur += step, i++) {
2393 memcpy(self->ob_item + cur * itemsize,
2394 other->ob_item + i * itemsize,
2395 itemsize);
2396 }
2397 return 0;
2398 }
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00002399}
2400
2401static PyMappingMethods array_as_mapping = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002402 (lenfunc)array_length,
2403 (binaryfunc)array_subscr,
2404 (objobjargproc)array_ass_subscr
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00002405};
2406
Guido van Rossumd8faa362007-04-27 19:54:29 +00002407static const void *emptybuf = "";
2408
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00002409
2410static int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +00002411array_buffer_getbuf(arrayobject *self, Py_buffer *view, int flags)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00002412{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002413 if (view==NULL) goto finish;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00002414
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002415 view->buf = (void *)self->ob_item;
2416 view->obj = (PyObject*)self;
2417 Py_INCREF(self);
2418 if (view->buf == NULL)
2419 view->buf = (void *)emptybuf;
2420 view->len = (Py_SIZE(self)) * self->ob_descr->itemsize;
2421 view->readonly = 0;
2422 view->ndim = 1;
2423 view->itemsize = self->ob_descr->itemsize;
2424 view->suboffsets = NULL;
2425 view->shape = NULL;
2426 if ((flags & PyBUF_ND)==PyBUF_ND) {
2427 view->shape = &((Py_SIZE(self)));
2428 }
2429 view->strides = NULL;
2430 if ((flags & PyBUF_STRIDES)==PyBUF_STRIDES)
2431 view->strides = &(view->itemsize);
2432 view->format = NULL;
2433 view->internal = NULL;
Victor Stinner62bb3942012-08-06 00:46:05 +02002434 if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002435 view->format = self->ob_descr->formats;
Victor Stinner62bb3942012-08-06 00:46:05 +02002436#ifdef Py_UNICODE_WIDE
2437 if (self->ob_descr->typecode == 'u') {
2438 view->format = "w";
2439 }
2440#endif
2441 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00002442
2443 finish:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002444 self->ob_exports++;
2445 return 0;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00002446}
2447
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00002448static void
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +00002449array_buffer_relbuf(arrayobject *self, Py_buffer *view)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00002450{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002451 self->ob_exports--;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00002452}
2453
Roger E. Masse2919eaa1996-12-09 20:10:36 +00002454static PySequenceMethods array_as_sequence = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002455 (lenfunc)array_length, /*sq_length*/
2456 (binaryfunc)array_concat, /*sq_concat*/
2457 (ssizeargfunc)array_repeat, /*sq_repeat*/
2458 (ssizeargfunc)array_item, /*sq_item*/
2459 0, /*sq_slice*/
2460 (ssizeobjargproc)array_ass_item, /*sq_ass_item*/
2461 0, /*sq_ass_slice*/
2462 (objobjproc)array_contains, /*sq_contains*/
2463 (binaryfunc)array_inplace_concat, /*sq_inplace_concat*/
2464 (ssizeargfunc)array_inplace_repeat /*sq_inplace_repeat*/
Guido van Rossum778983b1993-02-19 15:55:02 +00002465};
2466
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00002467static PyBufferProcs array_as_buffer = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002468 (getbufferproc)array_buffer_getbuf,
2469 (releasebufferproc)array_buffer_relbuf
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00002470};
2471
Roger E. Masse2919eaa1996-12-09 20:10:36 +00002472static PyObject *
Martin v. Löwis99866332002-03-01 10:27:01 +00002473array_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
Guido van Rossum778983b1993-02-19 15:55:02 +00002474{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002475 int c;
2476 PyObject *initial = NULL, *it = NULL;
2477 struct arraydescr *descr;
Martin v. Löwis99866332002-03-01 10:27:01 +00002478
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002479 if (type == &Arraytype && !_PyArg_NoKeywords("array.array()", kwds))
2480 return NULL;
Martin v. Löwis99866332002-03-01 10:27:01 +00002481
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002482 if (!PyArg_ParseTuple(args, "C|O:array", &c, &initial))
2483 return NULL;
Raymond Hettinger84fc9aa2003-04-24 10:41:55 +00002484
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002485 if (!(initial == NULL || PyList_Check(initial)
2486 || PyByteArray_Check(initial)
2487 || PyBytes_Check(initial)
2488 || PyTuple_Check(initial)
Alexander Belopolskyef4a03f2011-01-11 21:44:00 +00002489 || ((c=='u') && PyUnicode_Check(initial))
2490 || (array_Check(initial)
2491 && c == ((arrayobject*)initial)->ob_descr->typecode))) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002492 it = PyObject_GetIter(initial);
2493 if (it == NULL)
2494 return NULL;
2495 /* We set initial to NULL so that the subsequent code
2496 will create an empty array of the appropriate type
2497 and afterwards we can use array_iter_extend to populate
2498 the array.
2499 */
2500 initial = NULL;
2501 }
2502 for (descr = descriptors; descr->typecode != '\0'; descr++) {
2503 if (descr->typecode == c) {
2504 PyObject *a;
2505 Py_ssize_t len;
Martin v. Löwis99866332002-03-01 10:27:01 +00002506
Alexander Belopolskyef4a03f2011-01-11 21:44:00 +00002507 if (initial == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002508 len = 0;
Alexander Belopolskyef4a03f2011-01-11 21:44:00 +00002509 else if (PyList_Check(initial))
2510 len = PyList_GET_SIZE(initial);
2511 else if (PyTuple_Check(initial) || array_Check(initial))
2512 len = Py_SIZE(initial);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002513 else
Alexander Belopolskyef4a03f2011-01-11 21:44:00 +00002514 len = 0;
Martin v. Löwis99866332002-03-01 10:27:01 +00002515
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002516 a = newarrayobject(type, len, descr);
2517 if (a == NULL)
2518 return NULL;
2519
Alexander Belopolskyef4a03f2011-01-11 21:44:00 +00002520 if (len > 0 && !array_Check(initial)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002521 Py_ssize_t i;
2522 for (i = 0; i < len; i++) {
2523 PyObject *v =
2524 PySequence_GetItem(initial, i);
2525 if (v == NULL) {
2526 Py_DECREF(a);
2527 return NULL;
2528 }
2529 if (setarrayitem(a, i, v) != 0) {
2530 Py_DECREF(v);
2531 Py_DECREF(a);
2532 return NULL;
2533 }
2534 Py_DECREF(v);
2535 }
2536 }
2537 else if (initial != NULL && (PyByteArray_Check(initial) ||
2538 PyBytes_Check(initial))) {
2539 PyObject *t_initial, *v;
2540 t_initial = PyTuple_Pack(1, initial);
2541 if (t_initial == NULL) {
2542 Py_DECREF(a);
2543 return NULL;
2544 }
Antoine Pitrou1ce3eb52010-09-01 20:29:34 +00002545 v = array_frombytes((arrayobject *)a,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002546 t_initial);
2547 Py_DECREF(t_initial);
2548 if (v == NULL) {
2549 Py_DECREF(a);
2550 return NULL;
2551 }
2552 Py_DECREF(v);
2553 }
2554 else if (initial != NULL && PyUnicode_Check(initial)) {
Victor Stinner62bb3942012-08-06 00:46:05 +02002555 Py_UNICODE *ustr;
Victor Stinner1fbcaef2011-09-30 01:54:04 +02002556 Py_ssize_t n;
Victor Stinner62bb3942012-08-06 00:46:05 +02002557
2558 ustr = PyUnicode_AsUnicode(initial);
2559 if (ustr == NULL) {
2560 PyErr_NoMemory();
Victor Stinner1fbcaef2011-09-30 01:54:04 +02002561 Py_DECREF(a);
2562 return NULL;
2563 }
Victor Stinner62bb3942012-08-06 00:46:05 +02002564
2565 n = PyUnicode_GET_DATA_SIZE(initial);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002566 if (n > 0) {
2567 arrayobject *self = (arrayobject *)a;
Victor Stinner62bb3942012-08-06 00:46:05 +02002568 char *item = self->ob_item;
2569 item = (char *)PyMem_Realloc(item, n);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002570 if (item == NULL) {
2571 PyErr_NoMemory();
2572 Py_DECREF(a);
2573 return NULL;
2574 }
Victor Stinner62bb3942012-08-06 00:46:05 +02002575 self->ob_item = item;
2576 Py_SIZE(self) = n / sizeof(Py_UNICODE);
2577 memcpy(item, ustr, n);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002578 self->allocated = Py_SIZE(self);
2579 }
2580 }
Alexander Belopolskyef4a03f2011-01-11 21:44:00 +00002581 else if (initial != NULL && array_Check(initial)) {
2582 arrayobject *self = (arrayobject *)a;
2583 arrayobject *other = (arrayobject *)initial;
2584 memcpy(self->ob_item, other->ob_item, len * other->ob_descr->itemsize);
2585 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002586 if (it != NULL) {
2587 if (array_iter_extend((arrayobject *)a, it) == -1) {
2588 Py_DECREF(it);
2589 Py_DECREF(a);
2590 return NULL;
2591 }
2592 Py_DECREF(it);
2593 }
2594 return a;
2595 }
2596 }
2597 PyErr_SetString(PyExc_ValueError,
Meador Inge1c9f0c92011-09-20 19:55:51 -05002598#ifdef HAVE_LONG_LONG
2599 "bad typecode (must be b, B, u, h, H, i, I, l, L, q, Q, f or d)");
2600#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002601 "bad typecode (must be b, B, u, h, H, i, I, l, L, f or d)");
Meador Inge1c9f0c92011-09-20 19:55:51 -05002602#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002603 return NULL;
Guido van Rossum778983b1993-02-19 15:55:02 +00002604}
2605
Guido van Rossum778983b1993-02-19 15:55:02 +00002606
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002607PyDoc_STRVAR(module_doc,
Martin v. Löwis99866332002-03-01 10:27:01 +00002608"This module defines an object type which can efficiently represent\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002609an array of basic values: characters, integers, floating point\n\
2610numbers. Arrays are sequence types and behave very much like lists,\n\
2611except that the type of objects stored in them is constrained. The\n\
2612type is specified at object creation time by using a type code, which\n\
2613is a single character. The following type codes are defined:\n\
2614\n\
2615 Type code C Type Minimum size in bytes \n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002616 'b' signed integer 1 \n\
2617 'B' unsigned integer 1 \n\
Victor Stinner62bb3942012-08-06 00:46:05 +02002618 'u' Unicode character 2 (see note) \n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002619 'h' signed integer 2 \n\
2620 'H' unsigned integer 2 \n\
2621 'i' signed integer 2 \n\
2622 'I' unsigned integer 2 \n\
2623 'l' signed integer 4 \n\
2624 'L' unsigned integer 4 \n\
Meador Inge1c9f0c92011-09-20 19:55:51 -05002625 'q' signed integer 8 (see note) \n\
2626 'Q' unsigned integer 8 (see note) \n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002627 'f' floating point 4 \n\
2628 'd' floating point 8 \n\
2629\n\
Victor Stinner62bb3942012-08-06 00:46:05 +02002630NOTE: The 'u' typecode corresponds to Python's unicode character. On \n\
2631narrow builds this is 2-bytes on wide builds this is 4-bytes.\n\
2632\n\
Meador Inge1c9f0c92011-09-20 19:55:51 -05002633NOTE: The 'q' and 'Q' type codes are only available if the platform \n\
2634C compiler used to build Python supports 'long long', or, on Windows, \n\
2635'__int64'.\n\
2636\n\
Martin v. Löwis99866332002-03-01 10:27:01 +00002637The constructor is:\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002638\n\
2639array(typecode [, initializer]) -- create a new array\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002640");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002641
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002642PyDoc_STRVAR(arraytype_doc,
Martin v. Löwis99866332002-03-01 10:27:01 +00002643"array(typecode [, initializer]) -> array\n\
2644\n\
2645Return a new array whose items are restricted by typecode, and\n\
Raymond Hettinger6ab78cd2004-08-29 07:50:43 +00002646initialized from the optional initializer value, which must be a list,\n\
Florent Xicluna0e686cb2011-12-09 23:41:19 +01002647string or iterable over elements of the appropriate type.\n\
Martin v. Löwis99866332002-03-01 10:27:01 +00002648\n\
2649Arrays represent basic values and behave very much like lists, except\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002650the type of objects stored in them is constrained.\n\
2651\n\
2652Methods:\n\
2653\n\
2654append() -- append a new item to the end of the array\n\
2655buffer_info() -- return information giving the current memory info\n\
2656byteswap() -- byteswap all the items of the array\n\
Mark Dickinson934896d2009-02-21 20:59:32 +00002657count() -- return number of occurrences of an object\n\
Raymond Hettinger49f9bd12004-03-14 05:43:59 +00002658extend() -- extend array by appending multiple elements from an iterable\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002659fromfile() -- read items from a file object\n\
2660fromlist() -- append items from the list\n\
Florent Xiclunac45fb252011-10-24 13:14:55 +02002661frombytes() -- append items from the string\n\
Mark Dickinson934896d2009-02-21 20:59:32 +00002662index() -- return index of first occurrence of an object\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002663insert() -- insert a new item into the array at a provided position\n\
Peter Schneider-Kamp5a65c2d2000-07-31 20:52:21 +00002664pop() -- remove and return item (default last)\n\
Mark Dickinson934896d2009-02-21 20:59:32 +00002665remove() -- remove first occurrence of an object\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002666reverse() -- reverse the order of the items in the array\n\
2667tofile() -- write all items to a file object\n\
2668tolist() -- return the array converted to an ordinary list\n\
Florent Xiclunac45fb252011-10-24 13:14:55 +02002669tobytes() -- return the array converted to a string\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002670\n\
Martin v. Löwis99866332002-03-01 10:27:01 +00002671Attributes:\n\
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002672\n\
2673typecode -- the typecode character used to create the array\n\
2674itemsize -- the length in bytes of one array item\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002675");
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002676
Raymond Hettinger625812f2003-01-07 01:58:52 +00002677static PyObject *array_iter(arrayobject *ao);
2678
Tim Peters0c322792002-07-17 16:49:03 +00002679static PyTypeObject Arraytype = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002680 PyVarObject_HEAD_INIT(NULL, 0)
2681 "array.array",
2682 sizeof(arrayobject),
2683 0,
2684 (destructor)array_dealloc, /* tp_dealloc */
2685 0, /* tp_print */
2686 0, /* tp_getattr */
2687 0, /* tp_setattr */
2688 0, /* tp_reserved */
2689 (reprfunc)array_repr, /* tp_repr */
2690 0, /* tp_as_number*/
2691 &array_as_sequence, /* tp_as_sequence*/
2692 &array_as_mapping, /* tp_as_mapping*/
2693 0, /* tp_hash */
2694 0, /* tp_call */
2695 0, /* tp_str */
2696 PyObject_GenericGetAttr, /* tp_getattro */
2697 0, /* tp_setattro */
2698 &array_as_buffer, /* tp_as_buffer*/
2699 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
2700 arraytype_doc, /* tp_doc */
2701 0, /* tp_traverse */
2702 0, /* tp_clear */
2703 array_richcompare, /* tp_richcompare */
2704 offsetof(arrayobject, weakreflist), /* tp_weaklistoffset */
2705 (getiterfunc)array_iter, /* tp_iter */
2706 0, /* tp_iternext */
2707 array_methods, /* tp_methods */
2708 0, /* tp_members */
2709 array_getsets, /* tp_getset */
2710 0, /* tp_base */
2711 0, /* tp_dict */
2712 0, /* tp_descr_get */
2713 0, /* tp_descr_set */
2714 0, /* tp_dictoffset */
2715 0, /* tp_init */
2716 PyType_GenericAlloc, /* tp_alloc */
2717 array_new, /* tp_new */
2718 PyObject_Del, /* tp_free */
Guido van Rossumb39b90d1998-10-13 14:27:22 +00002719};
2720
Raymond Hettinger625812f2003-01-07 01:58:52 +00002721
2722/*********************** Array Iterator **************************/
2723
2724typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002725 PyObject_HEAD
2726 Py_ssize_t index;
2727 arrayobject *ao;
2728 PyObject * (*getitem)(struct arrayobject *, Py_ssize_t);
Raymond Hettinger625812f2003-01-07 01:58:52 +00002729} arrayiterobject;
2730
2731static PyTypeObject PyArrayIter_Type;
2732
2733#define PyArrayIter_Check(op) PyObject_TypeCheck(op, &PyArrayIter_Type)
2734
2735static PyObject *
2736array_iter(arrayobject *ao)
2737{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002738 arrayiterobject *it;
Raymond Hettinger625812f2003-01-07 01:58:52 +00002739
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002740 if (!array_Check(ao)) {
2741 PyErr_BadInternalCall();
2742 return NULL;
2743 }
Raymond Hettinger625812f2003-01-07 01:58:52 +00002744
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002745 it = PyObject_GC_New(arrayiterobject, &PyArrayIter_Type);
2746 if (it == NULL)
2747 return NULL;
Raymond Hettinger625812f2003-01-07 01:58:52 +00002748
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002749 Py_INCREF(ao);
2750 it->ao = ao;
2751 it->index = 0;
2752 it->getitem = ao->ob_descr->getitem;
2753 PyObject_GC_Track(it);
2754 return (PyObject *)it;
Raymond Hettinger625812f2003-01-07 01:58:52 +00002755}
2756
2757static PyObject *
Raymond Hettinger625812f2003-01-07 01:58:52 +00002758arrayiter_next(arrayiterobject *it)
2759{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002760 assert(PyArrayIter_Check(it));
2761 if (it->index < Py_SIZE(it->ao))
2762 return (*it->getitem)(it->ao, it->index++);
2763 return NULL;
Raymond Hettinger625812f2003-01-07 01:58:52 +00002764}
2765
2766static void
2767arrayiter_dealloc(arrayiterobject *it)
2768{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002769 PyObject_GC_UnTrack(it);
2770 Py_XDECREF(it->ao);
2771 PyObject_GC_Del(it);
Raymond Hettinger625812f2003-01-07 01:58:52 +00002772}
2773
2774static int
2775arrayiter_traverse(arrayiterobject *it, visitproc visit, void *arg)
2776{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002777 Py_VISIT(it->ao);
2778 return 0;
Raymond Hettinger625812f2003-01-07 01:58:52 +00002779}
2780
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +00002781static PyObject *
2782arrayiter_reduce(arrayiterobject *it)
2783{
Antoine Pitroua7013882012-04-05 00:04:20 +02002784 return Py_BuildValue("N(O)n", _PyObject_GetBuiltin("iter"),
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +00002785 it->ao, it->index);
2786}
2787
2788static PyObject *
2789arrayiter_setstate(arrayiterobject *it, PyObject *state)
2790{
2791 Py_ssize_t index = PyLong_AsSsize_t(state);
2792 if (index == -1 && PyErr_Occurred())
2793 return NULL;
2794 if (index < 0)
2795 index = 0;
2796 it->index = index;
2797 Py_RETURN_NONE;
2798}
2799
2800PyDoc_STRVAR(setstate_doc, "Set state information for unpickling.");
2801static PyMethodDef arrayiter_methods[] = {
2802 {"__reduce__", (PyCFunction)arrayiter_reduce, METH_NOARGS,
2803 reduce_doc},
2804 {"__setstate__", (PyCFunction)arrayiter_setstate, METH_O,
2805 setstate_doc},
2806 {NULL, NULL} /* sentinel */
2807};
2808
Raymond Hettinger625812f2003-01-07 01:58:52 +00002809static PyTypeObject PyArrayIter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002810 PyVarObject_HEAD_INIT(NULL, 0)
2811 "arrayiterator", /* tp_name */
2812 sizeof(arrayiterobject), /* tp_basicsize */
2813 0, /* tp_itemsize */
2814 /* methods */
2815 (destructor)arrayiter_dealloc, /* tp_dealloc */
2816 0, /* tp_print */
2817 0, /* tp_getattr */
2818 0, /* tp_setattr */
2819 0, /* tp_reserved */
2820 0, /* tp_repr */
2821 0, /* tp_as_number */
2822 0, /* tp_as_sequence */
2823 0, /* tp_as_mapping */
2824 0, /* tp_hash */
2825 0, /* tp_call */
2826 0, /* tp_str */
2827 PyObject_GenericGetAttr, /* tp_getattro */
2828 0, /* tp_setattro */
2829 0, /* tp_as_buffer */
2830 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
2831 0, /* tp_doc */
2832 (traverseproc)arrayiter_traverse, /* tp_traverse */
2833 0, /* tp_clear */
2834 0, /* tp_richcompare */
2835 0, /* tp_weaklistoffset */
2836 PyObject_SelfIter, /* tp_iter */
2837 (iternextfunc)arrayiter_next, /* tp_iternext */
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +00002838 arrayiter_methods, /* tp_methods */
Raymond Hettinger625812f2003-01-07 01:58:52 +00002839};
2840
2841
2842/*********************** Install Module **************************/
2843
Martin v. Löwis99866332002-03-01 10:27:01 +00002844/* No functions in array module. */
2845static PyMethodDef a_methods[] = {
Alexandre Vassalottiad077152009-07-15 17:49:23 +00002846 {"_array_reconstructor", array_reconstructor, METH_VARARGS,
2847 PyDoc_STR("Internal. Used for pickling support.")},
Martin v. Löwis99866332002-03-01 10:27:01 +00002848 {NULL, NULL, 0, NULL} /* Sentinel */
2849};
2850
Martin v. Löwis1a214512008-06-11 05:26:20 +00002851static struct PyModuleDef arraymodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002852 PyModuleDef_HEAD_INIT,
2853 "array",
2854 module_doc,
2855 -1,
2856 a_methods,
2857 NULL,
2858 NULL,
2859 NULL,
2860 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00002861};
2862
Martin v. Löwis99866332002-03-01 10:27:01 +00002863
Mark Hammondfe51c6d2002-08-02 02:27:13 +00002864PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00002865PyInit_array(void)
Guido van Rossum778983b1993-02-19 15:55:02 +00002866{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002867 PyObject *m;
Georg Brandl4cb0de22011-09-28 21:49:49 +02002868 char buffer[Py_ARRAY_LENGTH(descriptors)], *p;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002869 PyObject *typecodes;
2870 Py_ssize_t size = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002871 struct arraydescr *descr;
Fred Drake0d40ba42000-02-04 20:33:49 +00002872
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002873 if (PyType_Ready(&Arraytype) < 0)
2874 return NULL;
2875 Py_TYPE(&PyArrayIter_Type) = &PyType_Type;
2876 m = PyModule_Create(&arraymodule);
2877 if (m == NULL)
2878 return NULL;
Fred Drakef4e34842002-04-01 03:45:06 +00002879
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002880 Py_INCREF((PyObject *)&Arraytype);
2881 PyModule_AddObject(m, "ArrayType", (PyObject *)&Arraytype);
2882 Py_INCREF((PyObject *)&Arraytype);
2883 PyModule_AddObject(m, "array", (PyObject *)&Arraytype);
Travis E. Oliphantd5c0add2007-10-12 22:05:15 +00002884
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002885 for (descr=descriptors; descr->typecode != '\0'; descr++) {
2886 size++;
2887 }
Travis E. Oliphantd5c0add2007-10-12 22:05:15 +00002888
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002889 p = buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002890 for (descr = descriptors; descr->typecode != '\0'; descr++) {
2891 *p++ = (char)descr->typecode;
2892 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002893 typecodes = PyUnicode_DecodeASCII(buffer, p - buffer, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002894
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002895 PyModule_AddObject(m, "typecodes", typecodes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002896
2897 if (PyErr_Occurred()) {
2898 Py_DECREF(m);
2899 m = NULL;
2900 }
2901 return m;
Guido van Rossum778983b1993-02-19 15:55:02 +00002902}