blob: e303cafcc08e1e4665777d2375cf602fa1750ae1 [file] [log] [blame]
Guido van Rossume15dee51995-07-18 14:12:02 +00001/* Abstract Object Interface (many thanks to Jim Fulton) */
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002
Guido van Rossume15dee51995-07-18 14:12:02 +00003#include "Python.h"
Guido van Rossumfa0b6ab1998-05-22 15:23:36 +00004#include <ctype.h>
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00005#include "structmember.h" /* we need the offsetof() macro from there */
Tim Peters64b5ce32001-09-10 20:52:51 +00006#include "longintrepr.h"
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00007
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00008
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00009
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000010/* Shorthands to return certain errors */
Guido van Rossume15dee51995-07-18 14:12:02 +000011
12static PyObject *
Thomas Wouters0e3f5912006-08-11 14:57:12 +000013type_error(const char *msg, PyObject *obj)
Guido van Rossume15dee51995-07-18 14:12:02 +000014{
Thomas Wouters0e3f5912006-08-11 14:57:12 +000015 PyErr_Format(PyExc_TypeError, msg, obj->ob_type->tp_name);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000016 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +000017}
18
Guido van Rossum052b7e11996-11-11 15:08:19 +000019static PyObject *
Fred Drake79912472000-07-09 04:06:11 +000020null_error(void)
Guido van Rossume15dee51995-07-18 14:12:02 +000021{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000022 if (!PyErr_Occurred())
23 PyErr_SetString(PyExc_SystemError,
24 "null argument to internal routine");
25 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +000026}
27
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000028/* Operations on any object */
29
30int
Fred Drake79912472000-07-09 04:06:11 +000031PyObject_Cmp(PyObject *o1, PyObject *o2, int *result)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000032{
33 int r;
34
35 if (o1 == NULL || o2 == NULL) {
36 null_error();
37 return -1;
38 }
39 r = PyObject_Compare(o1, o2);
40 if (PyErr_Occurred())
41 return -1;
42 *result = r;
Guido van Rossume15dee51995-07-18 14:12:02 +000043 return 0;
44}
Guido van Rossume15dee51995-07-18 14:12:02 +000045
46PyObject *
Fred Drake79912472000-07-09 04:06:11 +000047PyObject_Type(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +000048{
49 PyObject *v;
50
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000051 if (o == NULL)
52 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +000053 v = (PyObject *)o->ob_type;
54 Py_INCREF(v);
55 return v;
56}
57
Martin v. Löwis18e16552006-02-15 17:27:45 +000058Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +000059PyObject_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +000060{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000061 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +000062
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000063 if (o == NULL) {
64 null_error();
65 return -1;
66 }
Guido van Rossume15dee51995-07-18 14:12:02 +000067
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000068 m = o->ob_type->tp_as_sequence;
69 if (m && m->sq_length)
70 return m->sq_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +000071
Jeremy Hylton6253f832000-07-12 12:56:19 +000072 return PyMapping_Size(o);
Guido van Rossume15dee51995-07-18 14:12:02 +000073}
74
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000075#undef PyObject_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +000076Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000077PyObject_Length(PyObject *o)
78{
79 return PyObject_Size(o);
80}
81#define PyObject_Length PyObject_Size
82
Martin v. Löwis18e16552006-02-15 17:27:45 +000083Py_ssize_t
Armin Rigof5b3e362006-02-11 21:32:43 +000084_PyObject_LengthHint(PyObject *o)
Raymond Hettinger6b27cda2005-09-24 21:23:05 +000085{
Martin v. Löwis18e16552006-02-15 17:27:45 +000086 Py_ssize_t rv = PyObject_Size(o);
Raymond Hettinger6b27cda2005-09-24 21:23:05 +000087 if (rv != -1)
88 return rv;
89 if (PyErr_ExceptionMatches(PyExc_TypeError) ||
90 PyErr_ExceptionMatches(PyExc_AttributeError)) {
91 PyObject *err_type, *err_value, *err_tb, *ro;
92
93 PyErr_Fetch(&err_type, &err_value, &err_tb);
Armin Rigof5b3e362006-02-11 21:32:43 +000094 ro = PyObject_CallMethod(o, "__length_hint__", NULL);
Raymond Hettinger6b27cda2005-09-24 21:23:05 +000095 if (ro != NULL) {
Martin v. Löwis18e16552006-02-15 17:27:45 +000096 rv = PyInt_AsLong(ro);
Raymond Hettinger6b27cda2005-09-24 21:23:05 +000097 Py_DECREF(ro);
98 Py_XDECREF(err_type);
99 Py_XDECREF(err_value);
100 Py_XDECREF(err_tb);
101 return rv;
102 }
103 PyErr_Restore(err_type, err_value, err_tb);
104 }
105 return -1;
106}
107
Guido van Rossume15dee51995-07-18 14:12:02 +0000108PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000109PyObject_GetItem(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +0000110{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000111 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +0000112
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000113 if (o == NULL || key == NULL)
114 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +0000115
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000116 m = o->ob_type->tp_as_mapping;
117 if (m && m->mp_subscript)
118 return m->mp_subscript(o, key);
Guido van Rossume15dee51995-07-18 14:12:02 +0000119
Guido van Rossum21308241998-08-13 16:44:44 +0000120 if (o->ob_type->tp_as_sequence) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000121 if (PyIndex_Check(key)) {
122 Py_ssize_t key_value;
123 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
Andrew M. Kuchling0f223d22000-02-23 22:21:50 +0000124 if (key_value == -1 && PyErr_Occurred())
125 return NULL;
126 return PySequence_GetItem(o, key_value);
127 }
Guido van Rossum64585f62001-11-24 18:24:47 +0000128 else if (o->ob_type->tp_as_sequence->sq_item)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000129 return type_error("sequence index must "
130 "be integer, not '%.200s'", key);
Guido van Rossum21308241998-08-13 16:44:44 +0000131 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000132
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000133 return type_error("'%.200s' object is unsubscriptable", o);
Guido van Rossume15dee51995-07-18 14:12:02 +0000134}
135
136int
Fred Drake79912472000-07-09 04:06:11 +0000137PyObject_SetItem(PyObject *o, PyObject *key, PyObject *value)
Guido van Rossume15dee51995-07-18 14:12:02 +0000138{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000139 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +0000140
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000141 if (o == NULL || key == NULL || value == NULL) {
142 null_error();
143 return -1;
144 }
145 m = o->ob_type->tp_as_mapping;
146 if (m && m->mp_ass_subscript)
147 return m->mp_ass_subscript(o, key, value);
Guido van Rossume15dee51995-07-18 14:12:02 +0000148
Guido van Rossum21308241998-08-13 16:44:44 +0000149 if (o->ob_type->tp_as_sequence) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000150 if (PyIndex_Check(key)) {
151 Py_ssize_t key_value;
152 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
Andrew M. Kuchling0f223d22000-02-23 22:21:50 +0000153 if (key_value == -1 && PyErr_Occurred())
154 return -1;
155 return PySequence_SetItem(o, key_value, value);
156 }
Guido van Rossum64585f62001-11-24 18:24:47 +0000157 else if (o->ob_type->tp_as_sequence->sq_ass_item) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000158 type_error("sequence index must be "
159 "integer, not '%.200s'", key);
Guido van Rossum64585f62001-11-24 18:24:47 +0000160 return -1;
161 }
Guido van Rossum21308241998-08-13 16:44:44 +0000162 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000163
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000164 type_error("'%.200s' object does not support item assignment", o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000165 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +0000166}
167
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000168int
Fred Drake79912472000-07-09 04:06:11 +0000169PyObject_DelItem(PyObject *o, PyObject *key)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000170{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000171 PyMappingMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000172
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000173 if (o == NULL || key == NULL) {
174 null_error();
175 return -1;
176 }
177 m = o->ob_type->tp_as_mapping;
178 if (m && m->mp_ass_subscript)
179 return m->mp_ass_subscript(o, key, (PyObject*)NULL);
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000180
Guido van Rossum21308241998-08-13 16:44:44 +0000181 if (o->ob_type->tp_as_sequence) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000182 if (PyIndex_Check(key)) {
183 Py_ssize_t key_value;
184 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
Andrew M. Kuchling0f223d22000-02-23 22:21:50 +0000185 if (key_value == -1 && PyErr_Occurred())
186 return -1;
187 return PySequence_DelItem(o, key_value);
188 }
Guido van Rossum64585f62001-11-24 18:24:47 +0000189 else if (o->ob_type->tp_as_sequence->sq_ass_item) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000190 type_error("sequence index must be "
191 "integer, not '%.200s'", key);
Guido van Rossum64585f62001-11-24 18:24:47 +0000192 return -1;
193 }
Guido van Rossum21308241998-08-13 16:44:44 +0000194 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000195
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000196 type_error("'%.200s' object does not support item deletion", o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000197 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000198}
199
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000200int
201PyObject_DelItemString(PyObject *o, char *key)
202{
203 PyObject *okey;
204 int ret;
205
206 if (o == NULL || key == NULL) {
207 null_error();
208 return -1;
209 }
Martin v. Löwis5b222132007-06-10 09:51:05 +0000210 okey = PyUnicode_FromString(key);
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000211 if (okey == NULL)
212 return -1;
213 ret = PyObject_DelItem(o, okey);
214 Py_DECREF(okey);
215 return ret;
216}
217
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000218/* We release the buffer right after use of this function which could
219 cause issues later on. Don't use these functions in new code.
220 */
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000221int
222PyObject_AsCharBuffer(PyObject *obj,
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000223 const char **buffer,
224 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000225{
226 PyBufferProcs *pb;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000227 PyBuffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000228
229 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
230 null_error();
231 return -1;
232 }
233 pb = obj->ob_type->tp_as_buffer;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000234 if (pb == NULL || pb->bf_getbuffer == NULL) {
Guido van Rossum4c08d552000-03-10 22:55:18 +0000235 PyErr_SetString(PyExc_TypeError,
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000236 "expected an object with the buffer interface");
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000237 return -1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000238 }
239 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_CHARACTER)) return -1;
240
241 *buffer = view.buf;
242 *buffer_len = view.len;
243 if (pb->bf_releasebuffer != NULL)
244 (*pb->bf_releasebuffer)(obj, &view);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000245 return 0;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000246}
Guido van Rossum4c08d552000-03-10 22:55:18 +0000247
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000248int
249PyObject_CheckReadBuffer(PyObject *obj)
250{
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000251 PyBufferProcs *pb = obj->ob_type->tp_as_buffer;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000252
253 if (pb == NULL ||
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000254 pb->bf_getbuffer == NULL)
255 return 0;
256 if ((*pb->bf_getbuffer)(obj, NULL, PyBUF_SIMPLE) == -1) {
257 PyErr_Clear();
258 return 0;
259 }
260 if (*pb->bf_releasebuffer != NULL)
261 (*pb->bf_releasebuffer)(obj, NULL);
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000262 return 1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000263}
264
265int PyObject_AsReadBuffer(PyObject *obj,
266 const void **buffer,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000267 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000268{
269 PyBufferProcs *pb;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000270 PyBuffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000271
272 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
273 null_error();
274 return -1;
275 }
276 pb = obj->ob_type->tp_as_buffer;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000277 if (pb == NULL ||
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000278 pb->bf_getbuffer == NULL) {
Guido van Rossum4c08d552000-03-10 22:55:18 +0000279 PyErr_SetString(PyExc_TypeError,
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000280 "expected an object with a buffer interface");
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000281 return -1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000282 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000283
284 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE)) return -1;
285
286 *buffer = view.buf;
287 *buffer_len = view.len;
288 if (pb->bf_releasebuffer != NULL)
289 (*pb->bf_releasebuffer)(obj, &view);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000290 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000291}
292
293int PyObject_AsWriteBuffer(PyObject *obj,
294 void **buffer,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000295 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000296{
297 PyBufferProcs *pb;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000298 PyBuffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000299
300 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
301 null_error();
302 return -1;
303 }
304 pb = obj->ob_type->tp_as_buffer;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000305 if (pb == NULL ||
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000306 pb->bf_getbuffer == NULL ||
307 ((*pb->bf_getbuffer)(obj, &view, PyBUF_WRITEABLE) != 0)) {
308 PyErr_SetString(PyExc_TypeError,
309 "expected an object with a writeable buffer interface");
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000310 return -1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000311 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000312
313 *buffer = view.buf;
314 *buffer_len = view.len;
315 if (pb->bf_releasebuffer != NULL)
316 (*pb->bf_releasebuffer)(obj, &view);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000317 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000318}
319
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000320/* Buffer C-API for Python 3.0 */
321
322int
323PyObject_GetBuffer(PyObject *obj, PyBuffer *view, int flags)
324{
325 if (!PyObject_CheckBuffer(obj)) {
326 PyErr_SetString(PyExc_TypeError,
327 "object does not have the buffer interface");
328 return -1;
329 }
330 return (*(obj->ob_type->tp_as_buffer->bf_getbuffer))(obj, view, flags);
331}
332
333void
334PyObject_ReleaseBuffer(PyObject *obj, PyBuffer *view)
335{
336 if (obj->ob_type->tp_as_buffer != NULL &&
337 obj->ob_type->tp_as_buffer->bf_releasebuffer != NULL) {
338 (*(obj->ob_type->tp_as_buffer->bf_releasebuffer))(obj, view);
339 }
340}
341
342
343static int
344_IsFortranContiguous(PyBuffer *view)
345{
346 Py_ssize_t sd, dim;
347 int i;
348
349 if (view->ndim == 0) return 1;
350 if (view->strides == NULL) return (view->ndim == 1);
351
352 sd = view->itemsize;
353 if (view->ndim == 1) return (view->shape[0] == 1 ||
354 sd == view->strides[0]);
355 for (i=0; i<view->ndim; i++) {
356 dim = view->shape[i];
357 if (dim == 0) return 1;
358 if (view->strides[i] != sd) return 0;
359 sd *= dim;
360 }
361 return 1;
362}
363
364static int
365_IsCContiguous(PyBuffer *view)
366{
367 Py_ssize_t sd, dim;
368 int i;
369
370 if (view->ndim == 0) return 1;
371 if (view->strides == NULL) return 1;
372
373 sd = view->itemsize;
374 if (view->ndim == 1) return (view->shape[0] == 1 ||
375 sd == view->strides[0]);
376 for (i=view->ndim-1; i>=0; i--) {
377 dim = view->shape[i];
378 if (dim == 0) return 1;
379 if (view->strides[i] != sd) return 0;
380 sd *= dim;
381 }
382 return 1;
383}
384
385int
386PyBuffer_IsContiguous(PyBuffer *view, char fort)
387{
388
389 if (view->suboffsets != NULL) return 0;
390
391 if (fort == 'C')
392 return _IsCContiguous(view);
393 else if (fort == 'F')
394 return _IsFortranContiguous(view);
395 else if (fort == 'A')
396 return (_IsCContiguous(view) || _IsFortranContiguous(view));
397 return 0;
398}
399
400
401void*
402PyBuffer_GetPointer(PyBuffer *view, Py_ssize_t *indices)
403{
404 char* pointer;
405 int i;
406 pointer = (char *)view->buf;
407 for (i = 0; i < view->ndim; i++) {
408 pointer += view->strides[i]*indices[i];
409 if ((view->suboffsets != NULL) && (view->suboffsets[i] >= 0)) {
410 pointer = *((char**)pointer) + view->suboffsets[i];
411 }
412 }
413 return (void*)pointer;
414}
415
416
417void
418_add_one_to_index_F(int nd, Py_ssize_t *index, Py_ssize_t *shape)
419{
420 int k;
421
422 for (k=0; k<nd; k++) {
423 if (index[k] < shape[k]-1) {
424 index[k]++;
425 break;
426 }
427 else {
428 index[k] = 0;
429 }
430 }
431}
432
433void
434_add_one_to_index_C(int nd, Py_ssize_t *index, Py_ssize_t *shape)
435{
436 int k;
437
438 for (k=nd-1; k>=0; k--) {
439 if (index[k] < shape[k]-1) {
440 index[k]++;
441 break;
442 }
443 else {
444 index[k] = 0;
445 }
446 }
447}
448
449 /* view is not checked for consistency in either of these. It is
450 assumed that the size of the buffer is view->len in
451 view->len / view->itemsize elements.
452 */
453
454int
455PyBuffer_ToContiguous(void *buf, PyBuffer *view, Py_ssize_t len, char fort)
456{
457 int k;
458 void (*addone)(int, Py_ssize_t *, Py_ssize_t *);
459 Py_ssize_t *indices, elements;
460 char *dest, *ptr;
461
462 if (len > view->len) {
463 len = view->len;
464 }
465
466 if (PyBuffer_IsContiguous(view, fort)) {
467 /* simplest copy is all that is needed */
468 memcpy(buf, view->buf, len);
469 return 0;
470 }
471
472 /* Otherwise a more elaborate scheme is needed */
473
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000474 /* XXX(nnorwitz): need to check for overflow! */
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000475 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
476 if (indices == NULL) {
477 PyErr_NoMemory();
478 return -1;
479 }
480 for (k=0; k<view->ndim;k++) {
481 indices[k] = 0;
482 }
483
484 if (fort == 'F') {
485 addone = _add_one_to_index_F;
486 }
487 else {
488 addone = _add_one_to_index_C;
489 }
490 dest = buf;
491 /* XXX : This is not going to be the fastest code in the world
492 several optimizations are possible.
493 */
494 elements = len / view->itemsize;
495 while (elements--) {
496 addone(view->ndim, indices, view->shape);
497 ptr = PyBuffer_GetPointer(view, indices);
498 memcpy(dest, ptr, view->itemsize);
499 dest += view->itemsize;
500 }
501 PyMem_Free(indices);
502 return 0;
503}
504
505int
506PyBuffer_FromContiguous(PyBuffer *view, void *buf, Py_ssize_t len, char fort)
507{
508 int k;
509 void (*addone)(int, Py_ssize_t *, Py_ssize_t *);
510 Py_ssize_t *indices, elements;
511 char *src, *ptr;
512
513 if (len > view->len) {
514 len = view->len;
515 }
516
517 if (PyBuffer_IsContiguous(view, fort)) {
518 /* simplest copy is all that is needed */
519 memcpy(view->buf, buf, len);
520 return 0;
521 }
522
523 /* Otherwise a more elaborate scheme is needed */
524
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000525 /* XXX(nnorwitz): need to check for overflow! */
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000526 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
527 if (indices == NULL) {
528 PyErr_NoMemory();
529 return -1;
530 }
531 for (k=0; k<view->ndim;k++) {
532 indices[k] = 0;
533 }
534
535 if (fort == 'F') {
536 addone = _add_one_to_index_F;
537 }
538 else {
539 addone = _add_one_to_index_C;
540 }
541 src = buf;
542 /* XXX : This is not going to be the fastest code in the world
543 several optimizations are possible.
544 */
545 elements = len / view->itemsize;
546 while (elements--) {
547 addone(view->ndim, indices, view->shape);
548 ptr = PyBuffer_GetPointer(view, indices);
549 memcpy(ptr, src, view->itemsize);
550 src += view->itemsize;
551 }
552
553 PyMem_Free(indices);
554 return 0;
555}
556
557int PyObject_CopyData(PyObject *dest, PyObject *src)
558{
559 PyBuffer view_dest, view_src;
560 int k;
561 Py_ssize_t *indices, elements;
562 char *dptr, *sptr;
563
564 if (!PyObject_CheckBuffer(dest) ||
565 !PyObject_CheckBuffer(src)) {
566 PyErr_SetString(PyExc_TypeError,
567 "both destination and source must have the "\
568 "buffer interface");
569 return -1;
570 }
571
572 if (PyObject_GetBuffer(dest, &view_dest, PyBUF_FULL) != 0) return -1;
573 if (PyObject_GetBuffer(src, &view_src, PyBUF_FULL_RO) != 0) {
574 PyObject_ReleaseBuffer(dest, &view_dest);
575 return -1;
576 }
577
578 if (view_dest.len < view_src.len) {
579 PyErr_SetString(PyExc_BufferError,
580 "destination is too small to receive data from source");
581 PyObject_ReleaseBuffer(dest, &view_dest);
582 PyObject_ReleaseBuffer(src, &view_src);
583 return -1;
584 }
585
586 if ((PyBuffer_IsContiguous(&view_dest, 'C') &&
587 PyBuffer_IsContiguous(&view_src, 'C')) ||
588 (PyBuffer_IsContiguous(&view_dest, 'F') &&
589 PyBuffer_IsContiguous(&view_src, 'F'))) {
590 /* simplest copy is all that is needed */
591 memcpy(view_dest.buf, view_src.buf, view_src.len);
592 PyObject_ReleaseBuffer(dest, &view_dest);
593 PyObject_ReleaseBuffer(src, &view_src);
594 return 0;
595 }
596
597 /* Otherwise a more elaborate copy scheme is needed */
598
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000599 /* XXX(nnorwitz): need to check for overflow! */
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000600 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*view_src.ndim);
601 if (indices == NULL) {
602 PyErr_NoMemory();
603 PyObject_ReleaseBuffer(dest, &view_dest);
604 PyObject_ReleaseBuffer(src, &view_src);
605 return -1;
606 }
607 for (k=0; k<view_src.ndim;k++) {
608 indices[k] = 0;
609 }
610 elements = 1;
611 for (k=0; k<view_src.ndim; k++) {
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000612 /* XXX(nnorwitz): can this overflow? */
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000613 elements *= view_src.shape[k];
614 }
615 while (elements--) {
616 _add_one_to_index_C(view_src.ndim, indices, view_src.shape);
617 dptr = PyBuffer_GetPointer(&view_dest, indices);
618 sptr = PyBuffer_GetPointer(&view_src, indices);
619 memcpy(dptr, sptr, view_src.itemsize);
620 }
621 PyMem_Free(indices);
622 PyObject_ReleaseBuffer(dest, &view_dest);
623 PyObject_ReleaseBuffer(src, &view_src);
624 return 0;
625}
626
627void
628PyBuffer_FillContiguousStrides(int nd, Py_ssize_t *shape,
629 Py_ssize_t *strides, int itemsize,
630 char fort)
631{
632 int k;
633 Py_ssize_t sd;
634
635 sd = itemsize;
636 if (fort == 'F') {
637 for (k=0; k<nd; k++) {
638 strides[k] = sd;
639 sd *= shape[k];
640 }
641 }
642 else {
643 for (k=nd-1; k>=0; k--) {
644 strides[k] = sd;
645 sd *= shape[k];
646 }
647 }
648 return;
649}
650
651int
652PyBuffer_FillInfo(PyBuffer *view, void *buf, Py_ssize_t len,
653 int readonly, int flags)
654{
655 if (view == NULL) return 0;
656 if (((flags & PyBUF_LOCKDATA) == PyBUF_LOCKDATA) &&
657 readonly != -1) {
658 PyErr_SetString(PyExc_BufferError,
659 "Cannot make this object read-only.");
660 return -1;
661 }
662 if (((flags & PyBUF_WRITEABLE) == PyBUF_WRITEABLE) &&
663 readonly == 1) {
664 PyErr_SetString(PyExc_BufferError,
665 "Object is not writeable.");
666 return -1;
667 }
668
669 view->buf = buf;
670 view->len = len;
671 view->readonly = readonly;
672 view->itemsize = 1;
673 view->format = NULL;
674 if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT)
675 view->format = "B";
676 view->ndim = 1;
677 view->shape = NULL;
678 if ((flags & PyBUF_ND) == PyBUF_ND)
679 view->shape = &(view->len);
680 view->strides = NULL;
681 if ((flags & PyBUF_STRIDES) == PyBUF_STRIDES)
682 view->strides = &(view->itemsize);
683 view->suboffsets = NULL;
684 view->internal = NULL;
685 return 0;
686}
687
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000688/* Operations on numbers */
689
690int
Fred Drake79912472000-07-09 04:06:11 +0000691PyNumber_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +0000692{
Guido van Rossum6921eca2003-02-18 16:36:28 +0000693 return o && o->ob_type->tp_as_number &&
694 (o->ob_type->tp_as_number->nb_int ||
695 o->ob_type->tp_as_number->nb_float);
Guido van Rossume15dee51995-07-18 14:12:02 +0000696}
697
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000698/* Binary operators */
Guido van Rossume15dee51995-07-18 14:12:02 +0000699
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000700#define NB_SLOT(x) offsetof(PyNumberMethods, x)
701#define NB_BINOP(nb_methods, slot) \
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000702 (*(binaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000703#define NB_TERNOP(nb_methods, slot) \
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000704 (*(ternaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000705
706/*
707 Calling scheme used for binary operations:
708
Neal Norwitz4886cc32006-08-21 17:06:07 +0000709 Order operations are tried until either a valid result or error:
710 w.op(v,w)[*], v.op(v,w), w.op(v,w)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000711
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000712 [*] only when v->ob_type != w->ob_type && w->ob_type is a subclass of
713 v->ob_type
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000714 */
715
716static PyObject *
717binary_op1(PyObject *v, PyObject *w, const int op_slot)
Guido van Rossume15dee51995-07-18 14:12:02 +0000718{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000719 PyObject *x;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000720 binaryfunc slotv = NULL;
721 binaryfunc slotw = NULL;
722
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000723 if (v->ob_type->tp_as_number != NULL)
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000724 slotv = NB_BINOP(v->ob_type->tp_as_number, op_slot);
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000725 if (w->ob_type != v->ob_type &&
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000726 w->ob_type->tp_as_number != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000727 slotw = NB_BINOP(w->ob_type->tp_as_number, op_slot);
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000728 if (slotw == slotv)
729 slotw = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000730 }
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000731 if (slotv) {
Guido van Rossum89c42642001-10-01 17:10:18 +0000732 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
733 x = slotw(v, w);
734 if (x != Py_NotImplemented)
735 return x;
736 Py_DECREF(x); /* can't do it */
737 slotw = NULL;
738 }
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000739 x = slotv(v, w);
740 if (x != Py_NotImplemented)
741 return x;
742 Py_DECREF(x); /* can't do it */
743 }
744 if (slotw) {
745 x = slotw(v, w);
746 if (x != Py_NotImplemented)
747 return x;
748 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000749 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000750 Py_INCREF(Py_NotImplemented);
751 return Py_NotImplemented;
752}
Guido van Rossum77660912002-04-16 16:32:50 +0000753
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000754static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000755binop_type_error(PyObject *v, PyObject *w, const char *op_name)
756{
757 PyErr_Format(PyExc_TypeError,
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000758 "unsupported operand type(s) for %.100s: "
759 "'%.100s' and '%.100s'",
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000760 op_name,
761 v->ob_type->tp_name,
762 w->ob_type->tp_name);
763 return NULL;
764}
765
766static PyObject *
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000767binary_op(PyObject *v, PyObject *w, const int op_slot, const char *op_name)
768{
769 PyObject *result = binary_op1(v, w, op_slot);
770 if (result == Py_NotImplemented) {
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000771 Py_DECREF(result);
772 return binop_type_error(v, w, op_name);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000773 }
774 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000775}
776
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000777
778/*
779 Calling scheme used for ternary operations:
780
Neal Norwitz4886cc32006-08-21 17:06:07 +0000781 Order operations are tried until either a valid result or error:
782 v.op(v,w,z), w.op(v,w,z), z.op(v,w,z)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000783 */
784
785static PyObject *
786ternary_op(PyObject *v,
787 PyObject *w,
788 PyObject *z,
789 const int op_slot,
790 const char *op_name)
Guido van Rossume15dee51995-07-18 14:12:02 +0000791{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000792 PyNumberMethods *mv, *mw, *mz;
Guido van Rossum84675ac2001-09-29 01:05:03 +0000793 PyObject *x = NULL;
794 ternaryfunc slotv = NULL;
795 ternaryfunc slotw = NULL;
796 ternaryfunc slotz = NULL;
Guido van Rossum77660912002-04-16 16:32:50 +0000797
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000798 mv = v->ob_type->tp_as_number;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000799 mw = w->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000800 if (mv != NULL)
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000801 slotv = NB_TERNOP(mv, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000802 if (w->ob_type != v->ob_type &&
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000803 mw != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000804 slotw = NB_TERNOP(mw, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000805 if (slotw == slotv)
806 slotw = NULL;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000807 }
Guido van Rossum84675ac2001-09-29 01:05:03 +0000808 if (slotv) {
Guido van Rossum89c42642001-10-01 17:10:18 +0000809 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
810 x = slotw(v, w, z);
811 if (x != Py_NotImplemented)
812 return x;
813 Py_DECREF(x); /* can't do it */
814 slotw = NULL;
815 }
Guido van Rossum84675ac2001-09-29 01:05:03 +0000816 x = slotv(v, w, z);
817 if (x != Py_NotImplemented)
818 return x;
819 Py_DECREF(x); /* can't do it */
820 }
821 if (slotw) {
822 x = slotw(v, w, z);
823 if (x != Py_NotImplemented)
824 return x;
825 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000826 }
827 mz = z->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000828 if (mz != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000829 slotz = NB_TERNOP(mz, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000830 if (slotz == slotv || slotz == slotw)
831 slotz = NULL;
832 if (slotz) {
833 x = slotz(v, w, z);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000834 if (x != Py_NotImplemented)
835 return x;
Guido van Rossum84675ac2001-09-29 01:05:03 +0000836 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000837 }
838 }
839
Guido van Rossum5c66a262001-10-22 04:12:44 +0000840 if (z == Py_None)
841 PyErr_Format(
842 PyExc_TypeError,
843 "unsupported operand type(s) for ** or pow(): "
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000844 "'%.100s' and '%.100s'",
Guido van Rossum5c66a262001-10-22 04:12:44 +0000845 v->ob_type->tp_name,
846 w->ob_type->tp_name);
847 else
848 PyErr_Format(
849 PyExc_TypeError,
850 "unsupported operand type(s) for pow(): "
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000851 "'%.100s', '%.100s', '%.100s'",
Guido van Rossum5c66a262001-10-22 04:12:44 +0000852 v->ob_type->tp_name,
853 w->ob_type->tp_name,
854 z->ob_type->tp_name);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000855 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000856}
857
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000858#define BINARY_FUNC(func, op, op_name) \
859 PyObject * \
860 func(PyObject *v, PyObject *w) { \
861 return binary_op(v, w, NB_SLOT(op), op_name); \
862 }
Guido van Rossume15dee51995-07-18 14:12:02 +0000863
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000864BINARY_FUNC(PyNumber_Or, nb_or, "|")
865BINARY_FUNC(PyNumber_Xor, nb_xor, "^")
866BINARY_FUNC(PyNumber_And, nb_and, "&")
867BINARY_FUNC(PyNumber_Lshift, nb_lshift, "<<")
868BINARY_FUNC(PyNumber_Rshift, nb_rshift, ">>")
869BINARY_FUNC(PyNumber_Subtract, nb_subtract, "-")
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000870BINARY_FUNC(PyNumber_Divmod, nb_divmod, "divmod()")
Guido van Rossume15dee51995-07-18 14:12:02 +0000871
872PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000873PyNumber_Add(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000874{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000875 PyObject *result = binary_op1(v, w, NB_SLOT(nb_add));
876 if (result == Py_NotImplemented) {
877 PySequenceMethods *m = v->ob_type->tp_as_sequence;
Armin Rigofd163f92005-12-29 15:59:19 +0000878 Py_DECREF(result);
Jeremy Hylton0522d982002-03-08 21:28:54 +0000879 if (m && m->sq_concat) {
Armin Rigofd163f92005-12-29 15:59:19 +0000880 return (*m->sq_concat)(v, w);
Jeremy Hylton0522d982002-03-08 21:28:54 +0000881 }
Armin Rigofd163f92005-12-29 15:59:19 +0000882 result = binop_type_error(v, w, "+");
Guido van Rossume15dee51995-07-18 14:12:02 +0000883 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000884 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000885}
886
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000887static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000888sequence_repeat(ssizeargfunc repeatfunc, PyObject *seq, PyObject *n)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000889{
Guido van Rossum38fff8c2006-03-07 18:50:55 +0000890 Py_ssize_t count;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000891 if (PyIndex_Check(n)) {
892 count = PyNumber_AsSsize_t(n, PyExc_OverflowError);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000893 if (count == -1 && PyErr_Occurred())
894 return NULL;
895 }
896 else {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000897 return type_error("can't multiply sequence by "
898 "non-int of type '%.200s'", n);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000899 }
Guido van Rossum38fff8c2006-03-07 18:50:55 +0000900 return (*repeatfunc)(seq, count);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000901}
902
903PyObject *
904PyNumber_Multiply(PyObject *v, PyObject *w)
905{
906 PyObject *result = binary_op1(v, w, NB_SLOT(nb_multiply));
907 if (result == Py_NotImplemented) {
908 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
909 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
Guido van Rossuma3a243e2002-12-31 19:50:03 +0000910 Py_DECREF(result);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000911 if (mv && mv->sq_repeat) {
912 return sequence_repeat(mv->sq_repeat, v, w);
913 }
914 else if (mw && mw->sq_repeat) {
915 return sequence_repeat(mw->sq_repeat, w, v);
916 }
917 result = binop_type_error(v, w, "*");
918 }
919 return result;
920}
921
Guido van Rossume15dee51995-07-18 14:12:02 +0000922PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +0000923PyNumber_FloorDivide(PyObject *v, PyObject *w)
924{
Guido van Rossum4668b002001-08-08 05:00:18 +0000925 return binary_op(v, w, NB_SLOT(nb_floor_divide), "//");
926}
927
928PyObject *
929PyNumber_TrueDivide(PyObject *v, PyObject *w)
930{
Guido van Rossum4668b002001-08-08 05:00:18 +0000931 return binary_op(v, w, NB_SLOT(nb_true_divide), "/");
932}
933
934PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000935PyNumber_Remainder(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000936{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000937 return binary_op(v, w, NB_SLOT(nb_remainder), "%");
Guido van Rossume15dee51995-07-18 14:12:02 +0000938}
939
940PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000941PyNumber_Power(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossume15dee51995-07-18 14:12:02 +0000942{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000943 return ternary_op(v, w, z, NB_SLOT(nb_power), "** or pow()");
Guido van Rossume15dee51995-07-18 14:12:02 +0000944}
945
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000946/* Binary in-place operators */
947
948/* The in-place operators are defined to fall back to the 'normal',
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000949 non in-place operations, if the in-place methods are not in place.
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000950
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000951 - If the left hand object has the appropriate struct members, and
952 they are filled, call the appropriate function and return the
953 result. No coercion is done on the arguments; the left-hand object
954 is the one the operation is performed on, and it's up to the
955 function to deal with the right-hand object.
Guido van Rossum77660912002-04-16 16:32:50 +0000956
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000957 - Otherwise, in-place modification is not supported. Handle it exactly as
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000958 a non in-place operation of the same kind.
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000959
960 */
961
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000962static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000963binary_iop1(PyObject *v, PyObject *w, const int iop_slot, const int op_slot)
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000964{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000965 PyNumberMethods *mv = v->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000966 if (mv != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000967 binaryfunc slot = NB_BINOP(mv, iop_slot);
968 if (slot) {
969 PyObject *x = (slot)(v, w);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000970 if (x != Py_NotImplemented) {
971 return x;
972 }
973 Py_DECREF(x);
974 }
Thomas Woutersf2b332d2000-09-02 08:34:40 +0000975 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000976 return binary_op1(v, w, op_slot);
977}
978
979static PyObject *
980binary_iop(PyObject *v, PyObject *w, const int iop_slot, const int op_slot,
981 const char *op_name)
982{
983 PyObject *result = binary_iop1(v, w, iop_slot, op_slot);
984 if (result == Py_NotImplemented) {
985 Py_DECREF(result);
986 return binop_type_error(v, w, op_name);
987 }
988 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000989}
990
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000991#define INPLACE_BINOP(func, iop, op, op_name) \
992 PyObject * \
993 func(PyObject *v, PyObject *w) { \
994 return binary_iop(v, w, NB_SLOT(iop), NB_SLOT(op), op_name); \
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000995 }
996
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000997INPLACE_BINOP(PyNumber_InPlaceOr, nb_inplace_or, nb_or, "|=")
998INPLACE_BINOP(PyNumber_InPlaceXor, nb_inplace_xor, nb_xor, "^=")
999INPLACE_BINOP(PyNumber_InPlaceAnd, nb_inplace_and, nb_and, "&=")
1000INPLACE_BINOP(PyNumber_InPlaceLshift, nb_inplace_lshift, nb_lshift, "<<=")
1001INPLACE_BINOP(PyNumber_InPlaceRshift, nb_inplace_rshift, nb_rshift, ">>=")
1002INPLACE_BINOP(PyNumber_InPlaceSubtract, nb_inplace_subtract, nb_subtract, "-=")
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001003
1004PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +00001005PyNumber_InPlaceFloorDivide(PyObject *v, PyObject *w)
1006{
Guido van Rossum4668b002001-08-08 05:00:18 +00001007 return binary_iop(v, w, NB_SLOT(nb_inplace_floor_divide),
1008 NB_SLOT(nb_floor_divide), "//=");
1009}
1010
1011PyObject *
1012PyNumber_InPlaceTrueDivide(PyObject *v, PyObject *w)
1013{
Guido van Rossum4668b002001-08-08 05:00:18 +00001014 return binary_iop(v, w, NB_SLOT(nb_inplace_true_divide),
1015 NB_SLOT(nb_true_divide), "/=");
1016}
1017
1018PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001019PyNumber_InPlaceAdd(PyObject *v, PyObject *w)
1020{
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001021 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_add),
1022 NB_SLOT(nb_add));
1023 if (result == Py_NotImplemented) {
1024 PySequenceMethods *m = v->ob_type->tp_as_sequence;
1025 Py_DECREF(result);
1026 if (m != NULL) {
1027 binaryfunc f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001028 f = m->sq_inplace_concat;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001029 if (f == NULL)
1030 f = m->sq_concat;
1031 if (f != NULL)
1032 return (*f)(v, w);
1033 }
1034 result = binop_type_error(v, w, "+=");
Guido van Rossumbb8be932000-09-01 23:27:32 +00001035 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001036 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001037}
1038
1039PyObject *
1040PyNumber_InPlaceMultiply(PyObject *v, PyObject *w)
1041{
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001042 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_multiply),
1043 NB_SLOT(nb_multiply));
1044 if (result == Py_NotImplemented) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001045 ssizeargfunc f = NULL;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001046 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
1047 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
1048 Py_DECREF(result);
1049 if (mv != NULL) {
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001050 f = mv->sq_inplace_repeat;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001051 if (f == NULL)
1052 f = mv->sq_repeat;
1053 if (f != NULL)
1054 return sequence_repeat(f, v, w);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001055 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001056 else if (mw != NULL) {
1057 /* Note that the right hand operand should not be
1058 * mutated in this case so sq_inplace_repeat is not
1059 * used. */
1060 if (mw->sq_repeat)
1061 return sequence_repeat(mw->sq_repeat, w, v);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001062 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001063 result = binop_type_error(v, w, "*=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001064 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001065 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001066}
1067
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001068PyObject *
1069PyNumber_InPlaceRemainder(PyObject *v, PyObject *w)
1070{
Neil Schemenauerd46fbc32002-11-24 01:07:42 +00001071 return binary_iop(v, w, NB_SLOT(nb_inplace_remainder),
1072 NB_SLOT(nb_remainder), "%=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001073}
1074
1075PyObject *
1076PyNumber_InPlacePower(PyObject *v, PyObject *w, PyObject *z)
1077{
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001078 if (v->ob_type->tp_as_number &&
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001079 v->ob_type->tp_as_number->nb_inplace_power != NULL) {
1080 return ternary_op(v, w, z, NB_SLOT(nb_inplace_power), "**=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001081 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001082 else {
1083 return ternary_op(v, w, z, NB_SLOT(nb_power), "**=");
1084 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001085}
1086
1087
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001088/* Unary operators and functions */
Guido van Rossume15dee51995-07-18 14:12:02 +00001089
1090PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001091PyNumber_Negative(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001092{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001093 PyNumberMethods *m;
1094
1095 if (o == NULL)
1096 return null_error();
1097 m = o->ob_type->tp_as_number;
1098 if (m && m->nb_negative)
1099 return (*m->nb_negative)(o);
1100
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001101 return type_error("bad operand type for unary -: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001102}
1103
1104PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001105PyNumber_Positive(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001106{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001107 PyNumberMethods *m;
1108
1109 if (o == NULL)
1110 return null_error();
1111 m = o->ob_type->tp_as_number;
1112 if (m && m->nb_positive)
1113 return (*m->nb_positive)(o);
1114
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001115 return type_error("bad operand type for unary +: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001116}
1117
1118PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001119PyNumber_Invert(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001120{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001121 PyNumberMethods *m;
1122
1123 if (o == NULL)
1124 return null_error();
1125 m = o->ob_type->tp_as_number;
1126 if (m && m->nb_invert)
1127 return (*m->nb_invert)(o);
1128
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001129 return type_error("bad operand type for unary ~: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001130}
1131
1132PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001133PyNumber_Absolute(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001134{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001135 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001136
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001137 if (o == NULL)
1138 return null_error();
1139 m = o->ob_type->tp_as_number;
1140 if (m && m->nb_absolute)
1141 return m->nb_absolute(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001142
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001143 return type_error("bad operand type for abs(): '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001144}
1145
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001146/* Return a Python Int or Long from the object item
1147 Raise TypeError if the result is not an int-or-long
1148 or if the object cannot be interpreted as an index.
1149*/
1150PyObject *
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001151PyNumber_Index(PyObject *item)
1152{
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001153 PyObject *result = NULL;
1154 if (item == NULL)
1155 return null_error();
1156 if (PyInt_Check(item) || PyLong_Check(item)) {
1157 Py_INCREF(item);
1158 return item;
1159 }
1160 if (PyIndex_Check(item)) {
1161 result = item->ob_type->tp_as_number->nb_index(item);
1162 if (result &&
1163 !PyInt_Check(result) && !PyLong_Check(result)) {
1164 PyErr_Format(PyExc_TypeError,
Guido van Rossum032a2842007-02-26 05:44:27 +00001165 "__index__ returned non-int "
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001166 "(type %.200s)",
1167 result->ob_type->tp_name);
1168 Py_DECREF(result);
1169 return NULL;
1170 }
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001171 }
1172 else {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001173 PyErr_Format(PyExc_TypeError,
1174 "'%.200s' object cannot be interpreted "
Guido van Rossum032a2842007-02-26 05:44:27 +00001175 "as an integer", item->ob_type->tp_name);
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001176 }
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001177 return result;
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001178}
1179
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001180/* Return an error on Overflow only if err is not NULL*/
1181
1182Py_ssize_t
1183PyNumber_AsSsize_t(PyObject *item, PyObject *err)
1184{
1185 Py_ssize_t result;
1186 PyObject *runerr;
1187 PyObject *value = PyNumber_Index(item);
1188 if (value == NULL)
1189 return -1;
1190
1191 /* We're done if PyInt_AsSsize_t() returns without error. */
1192 result = PyInt_AsSsize_t(value);
1193 if (result != -1 || !(runerr = PyErr_Occurred()))
1194 goto finish;
1195
1196 /* Error handling code -- only manage OverflowError differently */
1197 if (!PyErr_GivenExceptionMatches(runerr, PyExc_OverflowError))
1198 goto finish;
1199
1200 PyErr_Clear();
1201 /* If no error-handling desired then the default clipping
1202 is sufficient.
1203 */
1204 if (!err) {
1205 assert(PyLong_Check(value));
1206 /* Whether or not it is less than or equal to
1207 zero is determined by the sign of ob_size
1208 */
1209 if (_PyLong_Sign(value) < 0)
1210 result = PY_SSIZE_T_MIN;
1211 else
1212 result = PY_SSIZE_T_MAX;
1213 }
1214 else {
1215 /* Otherwise replace the error with caller's error object. */
1216 PyErr_Format(err,
1217 "cannot fit '%.200s' into an index-sized integer",
1218 item->ob_type->tp_name);
1219 }
1220
1221 finish:
1222 Py_DECREF(value);
1223 return result;
1224}
1225
1226
Guido van Rossum9e896b32000-04-05 20:11:21 +00001227/* Add a check for embedded NULL-bytes in the argument. */
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001228static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001229long_from_string(const char *s, Py_ssize_t len)
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001230{
Guido van Rossum4c08d552000-03-10 22:55:18 +00001231 char *end;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001232 PyObject *x;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001233
Guido van Rossum4c08d552000-03-10 22:55:18 +00001234 x = PyLong_FromString((char*)s, &end, 10);
Guido van Rossum9e896b32000-04-05 20:11:21 +00001235 if (x == NULL)
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001236 return NULL;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001237 if (end != s + len) {
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001238 PyErr_SetString(PyExc_ValueError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00001239 "null byte in argument for int()");
Guido van Rossum9e896b32000-04-05 20:11:21 +00001240 Py_DECREF(x);
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001241 return NULL;
1242 }
1243 return x;
1244}
1245
Guido van Rossume15dee51995-07-18 14:12:02 +00001246PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001247PyNumber_Long(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001248{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001249 PyNumberMethods *m;
Guido van Rossum4c08d552000-03-10 22:55:18 +00001250 const char *buffer;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001251 Py_ssize_t buffer_len;
Guido van Rossume15dee51995-07-18 14:12:02 +00001252
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001253 if (o == NULL)
1254 return null_error();
Guido van Rossumddefaf32007-01-14 03:31:43 +00001255 if (PyLong_CheckExact(o)) {
1256 Py_INCREF(o);
1257 return o;
1258 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001259 m = o->ob_type->tp_as_number;
Guido van Rossumddefaf32007-01-14 03:31:43 +00001260 if (m && m->nb_int) { /* This should include subclasses of int */
1261 PyObject *res = m->nb_int(o);
1262 if (res && !PyLong_Check(res)) {
1263 PyErr_Format(PyExc_TypeError,
1264 "__int__ returned non-int (type %.200s)",
1265 res->ob_type->tp_name);
1266 Py_DECREF(res);
1267 return NULL;
1268 }
1269 return res;
1270 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001271 if (m && m->nb_long) { /* This should include subclasses of long */
1272 PyObject *res = m->nb_long(o);
1273 if (res && (!PyInt_Check(res) && !PyLong_Check(res))) {
1274 PyErr_Format(PyExc_TypeError,
1275 "__long__ returned non-long (type %.200s)",
1276 res->ob_type->tp_name);
1277 Py_DECREF(res);
1278 return NULL;
1279 }
1280 return res;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001281 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001282 if (PyLong_Check(o)) /* A long subclass without nb_long */
Tim Petersdb30ac42002-03-02 04:14:21 +00001283 return _PyLong_Copy((PyLongObject *)o);
Guido van Rossum9e896b32000-04-05 20:11:21 +00001284 if (PyUnicode_Check(o))
1285 /* The above check is done in PyLong_FromUnicode(). */
1286 return PyLong_FromUnicode(PyUnicode_AS_UNICODE(o),
1287 PyUnicode_GET_SIZE(o),
1288 10);
Guido van Rossum4c08d552000-03-10 22:55:18 +00001289 if (!PyObject_AsCharBuffer(o, &buffer, &buffer_len))
1290 return long_from_string(buffer, buffer_len);
Guido van Rossume15dee51995-07-18 14:12:02 +00001291
Guido van Rossumddefaf32007-01-14 03:31:43 +00001292 return type_error("int() argument must be a string or a "
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001293 "number, not '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001294}
1295
1296PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001297PyNumber_Float(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001298{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001299 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001300
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001301 if (o == NULL)
1302 return null_error();
Brett Cannonc3647ac2005-04-26 03:45:26 +00001303 m = o->ob_type->tp_as_number;
1304 if (m && m->nb_float) { /* This should include subclasses of float */
1305 PyObject *res = m->nb_float(o);
1306 if (res && !PyFloat_Check(res)) {
1307 PyErr_Format(PyExc_TypeError,
1308 "__float__ returned non-float (type %.200s)",
1309 res->ob_type->tp_name);
1310 Py_DECREF(res);
1311 return NULL;
1312 }
1313 return res;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001314 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001315 if (PyFloat_Check(o)) { /* A float subclass with nb_float == NULL */
Tim Peters7a50f252001-09-10 21:28:20 +00001316 PyFloatObject *po = (PyFloatObject *)o;
1317 return PyFloat_FromDouble(po->ob_fval);
1318 }
Georg Brandl428f0642007-03-18 18:35:15 +00001319 return PyFloat_FromString(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001320}
1321
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001322
1323PyObject *
1324PyNumber_ToBase(PyObject *n, int base)
1325{
1326 PyObject *res;
1327 PyObject *index = PyNumber_Index(n);
1328
1329 if (!index)
1330 return NULL;
1331 assert(PyLong_Check(index));
1332 res = _PyLong_Format(index, base);
1333 Py_DECREF(index);
1334 return res;
1335}
1336
1337
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001338/* Operations on sequences */
Guido van Rossume15dee51995-07-18 14:12:02 +00001339
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001340int
Fred Drake79912472000-07-09 04:06:11 +00001341PySequence_Check(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001342{
Thomas Wouterscf297e42007-02-23 15:07:44 +00001343 if (PyObject_IsInstance(s, (PyObject *)&PyDict_Type))
1344 return 0;
Guido van Rossum8700b422001-09-07 20:20:11 +00001345 return s != NULL && s->ob_type->tp_as_sequence &&
1346 s->ob_type->tp_as_sequence->sq_item != NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001347}
1348
Martin v. Löwis18e16552006-02-15 17:27:45 +00001349Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001350PySequence_Size(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001351{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001352 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001353
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001354 if (s == NULL) {
1355 null_error();
1356 return -1;
1357 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001358
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001359 m = s->ob_type->tp_as_sequence;
1360 if (m && m->sq_length)
1361 return m->sq_length(s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001362
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001363 type_error("object of type '%.200s' has no len()", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001364 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001365}
1366
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001367#undef PySequence_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001368Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001369PySequence_Length(PyObject *s)
1370{
1371 return PySequence_Size(s);
1372}
1373#define PySequence_Length PySequence_Size
1374
Guido van Rossume15dee51995-07-18 14:12:02 +00001375PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001376PySequence_Concat(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001377{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001378 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001379
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001380 if (s == NULL || o == NULL)
1381 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001382
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001383 m = s->ob_type->tp_as_sequence;
1384 if (m && m->sq_concat)
1385 return m->sq_concat(s, o);
1386
Armin Rigofd163f92005-12-29 15:59:19 +00001387 /* Instances of user classes defining an __add__() method only
1388 have an nb_add slot, not an sq_concat slot. So we fall back
1389 to nb_add if both arguments appear to be sequences. */
1390 if (PySequence_Check(s) && PySequence_Check(o)) {
1391 PyObject *result = binary_op1(s, o, NB_SLOT(nb_add));
1392 if (result != Py_NotImplemented)
1393 return result;
1394 Py_DECREF(result);
1395 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001396 return type_error("'%.200s' object can't be concatenated", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001397}
1398
1399PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001400PySequence_Repeat(PyObject *o, Py_ssize_t count)
Guido van Rossume15dee51995-07-18 14:12:02 +00001401{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001402 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001403
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001404 if (o == NULL)
1405 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001406
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001407 m = o->ob_type->tp_as_sequence;
1408 if (m && m->sq_repeat)
1409 return m->sq_repeat(o, count);
1410
Armin Rigofd163f92005-12-29 15:59:19 +00001411 /* Instances of user classes defining a __mul__() method only
1412 have an nb_multiply slot, not an sq_repeat slot. so we fall back
1413 to nb_multiply if o appears to be a sequence. */
1414 if (PySequence_Check(o)) {
1415 PyObject *n, *result;
Martin v. Löwiseb079f12006-02-16 14:32:27 +00001416 n = PyInt_FromSsize_t(count);
Armin Rigofd163f92005-12-29 15:59:19 +00001417 if (n == NULL)
1418 return NULL;
1419 result = binary_op1(o, n, NB_SLOT(nb_multiply));
1420 Py_DECREF(n);
1421 if (result != Py_NotImplemented)
1422 return result;
1423 Py_DECREF(result);
1424 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001425 return type_error("'%.200s' object can't be repeated", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001426}
1427
1428PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001429PySequence_InPlaceConcat(PyObject *s, PyObject *o)
1430{
1431 PySequenceMethods *m;
1432
1433 if (s == NULL || o == NULL)
1434 return null_error();
1435
1436 m = s->ob_type->tp_as_sequence;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001437 if (m && m->sq_inplace_concat)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001438 return m->sq_inplace_concat(s, o);
1439 if (m && m->sq_concat)
1440 return m->sq_concat(s, o);
1441
Armin Rigofd163f92005-12-29 15:59:19 +00001442 if (PySequence_Check(s) && PySequence_Check(o)) {
1443 PyObject *result = binary_iop1(s, o, NB_SLOT(nb_inplace_add),
1444 NB_SLOT(nb_add));
1445 if (result != Py_NotImplemented)
1446 return result;
1447 Py_DECREF(result);
1448 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001449 return type_error("'%.200s' object can't be concatenated", s);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001450}
1451
1452PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001453PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001454{
1455 PySequenceMethods *m;
1456
1457 if (o == NULL)
1458 return null_error();
1459
1460 m = o->ob_type->tp_as_sequence;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001461 if (m && m->sq_inplace_repeat)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001462 return m->sq_inplace_repeat(o, count);
1463 if (m && m->sq_repeat)
1464 return m->sq_repeat(o, count);
1465
Armin Rigofd163f92005-12-29 15:59:19 +00001466 if (PySequence_Check(o)) {
1467 PyObject *n, *result;
Martin v. Löwiseb079f12006-02-16 14:32:27 +00001468 n = PyInt_FromSsize_t(count);
Armin Rigofd163f92005-12-29 15:59:19 +00001469 if (n == NULL)
1470 return NULL;
1471 result = binary_iop1(o, n, NB_SLOT(nb_inplace_multiply),
1472 NB_SLOT(nb_multiply));
1473 Py_DECREF(n);
1474 if (result != Py_NotImplemented)
1475 return result;
1476 Py_DECREF(result);
1477 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001478 return type_error("'%.200s' object can't be repeated", o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001479}
1480
1481PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001482PySequence_GetItem(PyObject *s, Py_ssize_t i)
Guido van Rossume15dee51995-07-18 14:12:02 +00001483{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001484 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001485
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001486 if (s == NULL)
1487 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001488
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001489 m = s->ob_type->tp_as_sequence;
1490 if (m && m->sq_item) {
1491 if (i < 0) {
1492 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001493 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001494 if (l < 0)
1495 return NULL;
1496 i += l;
1497 }
1498 }
1499 return m->sq_item(s, i);
1500 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001501
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001502 return type_error("'%.200s' object is unindexable", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001503}
1504
1505PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001506PySequence_GetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossume15dee51995-07-18 14:12:02 +00001507{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001508 PySequenceMethods *m;
Thomas Wouters1d75a792000-08-17 22:37:32 +00001509 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001510
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001511 if (!s) return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001512
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001513 m = s->ob_type->tp_as_sequence;
1514 if (m && m->sq_slice) {
1515 if (i1 < 0 || i2 < 0) {
1516 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001517 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001518 if (l < 0)
1519 return NULL;
1520 if (i1 < 0)
1521 i1 += l;
1522 if (i2 < 0)
1523 i2 += l;
1524 }
1525 }
1526 return m->sq_slice(s, i1, i2);
Thomas Wouters1d75a792000-08-17 22:37:32 +00001527 } else if ((mp = s->ob_type->tp_as_mapping) && mp->mp_subscript) {
1528 PyObject *res;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001529 PyObject *slice = _PySlice_FromIndices(i1, i2);
Thomas Wouters1d75a792000-08-17 22:37:32 +00001530 if (!slice)
1531 return NULL;
1532 res = mp->mp_subscript(s, slice);
1533 Py_DECREF(slice);
1534 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001535 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001536
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001537 return type_error("'%.200s' object is unsliceable", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001538}
1539
1540int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001541PySequence_SetItem(PyObject *s, Py_ssize_t i, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001542{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001543 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001544
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001545 if (s == NULL) {
1546 null_error();
1547 return -1;
1548 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001549
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001550 m = s->ob_type->tp_as_sequence;
1551 if (m && m->sq_ass_item) {
1552 if (i < 0) {
1553 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001554 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001555 if (l < 0)
Guido van Rossumed6219b1998-05-29 02:59:33 +00001556 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001557 i += l;
1558 }
1559 }
1560 return m->sq_ass_item(s, i, o);
1561 }
1562
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001563 type_error("'%.200s' object does not support item assignment", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001564 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001565}
1566
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001567int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001568PySequence_DelItem(PyObject *s, Py_ssize_t i)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001569{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001570 PySequenceMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001571
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001572 if (s == NULL) {
1573 null_error();
1574 return -1;
1575 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001576
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001577 m = s->ob_type->tp_as_sequence;
1578 if (m && m->sq_ass_item) {
1579 if (i < 0) {
1580 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001581 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001582 if (l < 0)
Guido van Rossumed6219b1998-05-29 02:59:33 +00001583 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001584 i += l;
1585 }
1586 }
1587 return m->sq_ass_item(s, i, (PyObject *)NULL);
1588 }
1589
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001590 type_error("'%.200s' object doesn't support item deletion", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001591 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001592}
1593
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001594int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001595PySequence_SetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001596{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001597 PySequenceMethods *m;
Thomas Wouters1d75a792000-08-17 22:37:32 +00001598 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001599
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001600 if (s == NULL) {
1601 null_error();
1602 return -1;
1603 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001604
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001605 m = s->ob_type->tp_as_sequence;
1606 if (m && m->sq_ass_slice) {
1607 if (i1 < 0 || i2 < 0) {
1608 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001609 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001610 if (l < 0)
Guido van Rossumed6219b1998-05-29 02:59:33 +00001611 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001612 if (i1 < 0)
1613 i1 += l;
1614 if (i2 < 0)
1615 i2 += l;
1616 }
1617 }
1618 return m->sq_ass_slice(s, i1, i2, o);
Thomas Wouters1d75a792000-08-17 22:37:32 +00001619 } else if ((mp = s->ob_type->tp_as_mapping) && mp->mp_ass_subscript) {
1620 int res;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001621 PyObject *slice = _PySlice_FromIndices(i1, i2);
Thomas Wouters1d75a792000-08-17 22:37:32 +00001622 if (!slice)
1623 return -1;
1624 res = mp->mp_ass_subscript(s, slice, o);
1625 Py_DECREF(slice);
1626 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001627 }
Thomas Wouters1d75a792000-08-17 22:37:32 +00001628
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001629 type_error("'%.200s' object doesn't support slice assignment", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001630 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001631}
1632
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001633int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001634PySequence_DelSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001635{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001636 PySequenceMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001637
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001638 if (s == NULL) {
1639 null_error();
1640 return -1;
1641 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001642
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001643 m = s->ob_type->tp_as_sequence;
1644 if (m && m->sq_ass_slice) {
1645 if (i1 < 0 || i2 < 0) {
1646 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001647 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001648 if (l < 0)
Guido van Rossumed6219b1998-05-29 02:59:33 +00001649 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001650 if (i1 < 0)
1651 i1 += l;
1652 if (i2 < 0)
1653 i2 += l;
1654 }
1655 }
1656 return m->sq_ass_slice(s, i1, i2, (PyObject *)NULL);
1657 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001658 type_error("'%.200s' object doesn't support slice deletion", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001659 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001660}
1661
Guido van Rossume15dee51995-07-18 14:12:02 +00001662PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001663PySequence_Tuple(PyObject *v)
Guido van Rossume15dee51995-07-18 14:12:02 +00001664{
Tim Peters6912d4d2001-05-05 03:56:37 +00001665 PyObject *it; /* iter(v) */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001666 Py_ssize_t n; /* guess for result tuple size */
Tim Peters6912d4d2001-05-05 03:56:37 +00001667 PyObject *result;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001668 Py_ssize_t j;
Guido van Rossume15dee51995-07-18 14:12:02 +00001669
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001670 if (v == NULL)
1671 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001672
Tim Peters6912d4d2001-05-05 03:56:37 +00001673 /* Special-case the common tuple and list cases, for efficiency. */
Tim Peters4c3a0a32001-09-10 23:37:46 +00001674 if (PyTuple_CheckExact(v)) {
1675 /* Note that we can't know whether it's safe to return
1676 a tuple *subclass* instance as-is, hence the restriction
Tim Peters8ff70a92001-09-10 23:53:53 +00001677 to exact tuples here. In contrast, lists always make
1678 a copy, so there's no need for exactness below. */
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001679 Py_INCREF(v);
1680 return v;
Guido van Rossume15dee51995-07-18 14:12:02 +00001681 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001682 if (PyList_Check(v))
1683 return PyList_AsTuple(v);
1684
Tim Peters6912d4d2001-05-05 03:56:37 +00001685 /* Get iterator. */
1686 it = PyObject_GetIter(v);
1687 if (it == NULL)
Tim Peters1fc240e2001-10-26 05:06:50 +00001688 return NULL;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001689
Tim Peters6912d4d2001-05-05 03:56:37 +00001690 /* Guess result size and allocate space. */
Armin Rigof5b3e362006-02-11 21:32:43 +00001691 n = _PyObject_LengthHint(v);
Tim Peters6912d4d2001-05-05 03:56:37 +00001692 if (n < 0) {
Raymond Hettingera710b332005-08-21 11:03:59 +00001693 if (!PyErr_ExceptionMatches(PyExc_TypeError) &&
1694 !PyErr_ExceptionMatches(PyExc_AttributeError)) {
1695 Py_DECREF(it);
1696 return NULL;
1697 }
Tim Peters6912d4d2001-05-05 03:56:37 +00001698 PyErr_Clear();
1699 n = 10; /* arbitrary */
1700 }
1701 result = PyTuple_New(n);
1702 if (result == NULL)
1703 goto Fail;
1704
1705 /* Fill the tuple. */
1706 for (j = 0; ; ++j) {
1707 PyObject *item = PyIter_Next(it);
1708 if (item == NULL) {
1709 if (PyErr_Occurred())
1710 goto Fail;
1711 break;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001712 }
Tim Peters6912d4d2001-05-05 03:56:37 +00001713 if (j >= n) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001714 Py_ssize_t oldn = n;
Raymond Hettinger4d012592004-12-16 10:38:38 +00001715 /* The over-allocation strategy can grow a bit faster
1716 than for lists because unlike lists the
1717 over-allocation isn't permanent -- we reclaim
1718 the excess before the end of this routine.
1719 So, grow by ten and then add 25%.
1720 */
1721 n += 10;
1722 n += n >> 2;
1723 if (n < oldn) {
1724 /* Check for overflow */
1725 PyErr_NoMemory();
Raymond Hettingere6bdb372004-12-16 15:10:21 +00001726 Py_DECREF(item);
Raymond Hettinger4d012592004-12-16 10:38:38 +00001727 goto Fail;
1728 }
Tim Peters4324aa32001-05-28 22:30:08 +00001729 if (_PyTuple_Resize(&result, n) != 0) {
Tim Peters12d0a6c2001-05-05 04:10:25 +00001730 Py_DECREF(item);
Tim Peters6912d4d2001-05-05 03:56:37 +00001731 goto Fail;
Tim Peters12d0a6c2001-05-05 04:10:25 +00001732 }
Tim Peters6912d4d2001-05-05 03:56:37 +00001733 }
1734 PyTuple_SET_ITEM(result, j, item);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001735 }
1736
Tim Peters6912d4d2001-05-05 03:56:37 +00001737 /* Cut tuple back if guess was too large. */
1738 if (j < n &&
Tim Peters4324aa32001-05-28 22:30:08 +00001739 _PyTuple_Resize(&result, j) != 0)
Tim Peters6912d4d2001-05-05 03:56:37 +00001740 goto Fail;
1741
1742 Py_DECREF(it);
1743 return result;
1744
1745Fail:
1746 Py_XDECREF(result);
1747 Py_DECREF(it);
1748 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001749}
1750
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001751PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001752PySequence_List(PyObject *v)
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001753{
Tim Petersf553f892001-05-01 20:45:31 +00001754 PyObject *result; /* result list */
Raymond Hettinger8ca92ae2004-03-11 09:13:12 +00001755 PyObject *rv; /* return value from PyList_Extend */
Guido van Rossum4669fb41997-04-02 05:31:09 +00001756
Guido van Rossum5dba9e81998-07-10 18:03:50 +00001757 if (v == NULL)
1758 return null_error();
1759
Raymond Hettinger8ca92ae2004-03-11 09:13:12 +00001760 result = PyList_New(0);
1761 if (result == NULL)
Tim Petersf553f892001-05-01 20:45:31 +00001762 return NULL;
1763
Raymond Hettinger8ca92ae2004-03-11 09:13:12 +00001764 rv = _PyList_Extend((PyListObject *)result, v);
1765 if (rv == NULL) {
1766 Py_DECREF(result);
Tim Petersf553f892001-05-01 20:45:31 +00001767 return NULL;
1768 }
Raymond Hettinger969d8c02004-03-17 05:24:23 +00001769 Py_DECREF(rv);
Tim Petersf553f892001-05-01 20:45:31 +00001770 return result;
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001771}
1772
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001773PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001774PySequence_Fast(PyObject *v, const char *m)
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001775{
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001776 PyObject *it;
1777
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001778 if (v == NULL)
1779 return null_error();
1780
Michael W. Hudson2801fe12002-11-05 18:05:49 +00001781 if (PyList_CheckExact(v) || PyTuple_CheckExact(v)) {
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001782 Py_INCREF(v);
1783 return v;
1784 }
1785
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001786 it = PyObject_GetIter(v);
1787 if (it == NULL) {
1788 if (PyErr_ExceptionMatches(PyExc_TypeError))
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001789 PyErr_SetString(PyExc_TypeError, m);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001790 return NULL;
1791 }
1792
Raymond Hettinger193814c2004-12-18 19:00:59 +00001793 v = PySequence_List(it);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001794 Py_DECREF(it);
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001795
1796 return v;
1797}
1798
Tim Peters16a77ad2001-09-08 04:00:12 +00001799/* Iterate over seq. Result depends on the operation:
1800 PY_ITERSEARCH_COUNT: -1 if error, else # of times obj appears in seq.
1801 PY_ITERSEARCH_INDEX: 0-based index of first occurence of obj in seq;
1802 set ValueError and return -1 if none found; also return -1 on error.
1803 Py_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on error.
1804*/
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001805Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001806_PySequence_IterSearch(PyObject *seq, PyObject *obj, int operation)
Guido van Rossume15dee51995-07-18 14:12:02 +00001807{
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001808 Py_ssize_t n;
Tim Peters16a77ad2001-09-08 04:00:12 +00001809 int wrapped; /* for PY_ITERSEARCH_INDEX, true iff n wrapped around */
1810 PyObject *it; /* iter(seq) */
Guido van Rossume15dee51995-07-18 14:12:02 +00001811
Tim Peters16a77ad2001-09-08 04:00:12 +00001812 if (seq == NULL || obj == NULL) {
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001813 null_error();
1814 return -1;
1815 }
Tim Peters75f8e352001-05-05 11:33:43 +00001816
Tim Peters16a77ad2001-09-08 04:00:12 +00001817 it = PyObject_GetIter(seq);
Tim Peters75f8e352001-05-05 11:33:43 +00001818 if (it == NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001819 type_error("argument of type '%.200s' is not iterable", seq);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001820 return -1;
Tim Peters75f8e352001-05-05 11:33:43 +00001821 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001822
Tim Peters16a77ad2001-09-08 04:00:12 +00001823 n = wrapped = 0;
Tim Peters75f8e352001-05-05 11:33:43 +00001824 for (;;) {
1825 int cmp;
1826 PyObject *item = PyIter_Next(it);
1827 if (item == NULL) {
1828 if (PyErr_Occurred())
1829 goto Fail;
1830 break;
1831 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001832
1833 cmp = PyObject_RichCompareBool(obj, item, Py_EQ);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001834 Py_DECREF(item);
Tim Peters75f8e352001-05-05 11:33:43 +00001835 if (cmp < 0)
1836 goto Fail;
1837 if (cmp > 0) {
Tim Peters16a77ad2001-09-08 04:00:12 +00001838 switch (operation) {
1839 case PY_ITERSEARCH_COUNT:
Thomas Wouters89f507f2006-12-13 04:49:30 +00001840 if (n == PY_SSIZE_T_MAX) {
Tim Peters16a77ad2001-09-08 04:00:12 +00001841 PyErr_SetString(PyExc_OverflowError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00001842 "count exceeds C integer size");
Tim Peters16a77ad2001-09-08 04:00:12 +00001843 goto Fail;
1844 }
Thomas Wouters89f507f2006-12-13 04:49:30 +00001845 ++n;
Tim Peters16a77ad2001-09-08 04:00:12 +00001846 break;
1847
1848 case PY_ITERSEARCH_INDEX:
1849 if (wrapped) {
1850 PyErr_SetString(PyExc_OverflowError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00001851 "index exceeds C integer size");
Tim Peters16a77ad2001-09-08 04:00:12 +00001852 goto Fail;
1853 }
1854 goto Done;
1855
1856 case PY_ITERSEARCH_CONTAINS:
1857 n = 1;
1858 goto Done;
1859
1860 default:
1861 assert(!"unknown operation");
Tim Peters75f8e352001-05-05 11:33:43 +00001862 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001863 }
1864
1865 if (operation == PY_ITERSEARCH_INDEX) {
Thomas Wouters89f507f2006-12-13 04:49:30 +00001866 if (n == PY_SSIZE_T_MAX)
Tim Peters16a77ad2001-09-08 04:00:12 +00001867 wrapped = 1;
Thomas Wouters89f507f2006-12-13 04:49:30 +00001868 ++n;
Tim Peters75f8e352001-05-05 11:33:43 +00001869 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001870 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001871
1872 if (operation != PY_ITERSEARCH_INDEX)
1873 goto Done;
1874
1875 PyErr_SetString(PyExc_ValueError,
1876 "sequence.index(x): x not in sequence");
1877 /* fall into failure code */
1878Fail:
1879 n = -1;
1880 /* fall through */
1881Done:
Tim Peters75f8e352001-05-05 11:33:43 +00001882 Py_DECREF(it);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001883 return n;
Tim Peters75f8e352001-05-05 11:33:43 +00001884
Guido van Rossume15dee51995-07-18 14:12:02 +00001885}
1886
Tim Peters16a77ad2001-09-08 04:00:12 +00001887/* Return # of times o appears in s. */
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001888Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001889PySequence_Count(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001890{
Tim Peters16a77ad2001-09-08 04:00:12 +00001891 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_COUNT);
Guido van Rossume15dee51995-07-18 14:12:02 +00001892}
1893
Tim Peterscb8d3682001-05-05 21:05:01 +00001894/* Return -1 if error; 1 if ob in seq; 0 if ob not in seq.
Tim Peters16a77ad2001-09-08 04:00:12 +00001895 * Use sq_contains if possible, else defer to _PySequence_IterSearch().
Tim Peterscb8d3682001-05-05 21:05:01 +00001896 */
1897int
1898PySequence_Contains(PyObject *seq, PyObject *ob)
1899{
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001900 Py_ssize_t result;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001901 PySequenceMethods *sqm = seq->ob_type->tp_as_sequence;
1902 if (sqm != NULL && sqm->sq_contains != NULL)
1903 return (*sqm->sq_contains)(seq, ob);
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001904 result = _PySequence_IterSearch(seq, ob, PY_ITERSEARCH_CONTAINS);
1905 return Py_SAFE_DOWNCAST(result, Py_ssize_t, int);
Tim Peterscb8d3682001-05-05 21:05:01 +00001906}
1907
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001908/* Backwards compatibility */
1909#undef PySequence_In
1910int
Fred Drake79912472000-07-09 04:06:11 +00001911PySequence_In(PyObject *w, PyObject *v)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001912{
1913 return PySequence_Contains(w, v);
1914}
1915
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001916Py_ssize_t
Fred Drake79912472000-07-09 04:06:11 +00001917PySequence_Index(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001918{
Tim Peters16a77ad2001-09-08 04:00:12 +00001919 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_INDEX);
Guido van Rossume15dee51995-07-18 14:12:02 +00001920}
1921
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001922/* Operations on mappings */
1923
1924int
Fred Drake79912472000-07-09 04:06:11 +00001925PyMapping_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001926{
Raymond Hettingere2eda602004-04-04 08:51:41 +00001927 return o && o->ob_type->tp_as_mapping &&
1928 o->ob_type->tp_as_mapping->mp_subscript &&
Raymond Hettingered9192e2004-04-05 08:14:48 +00001929 !(o->ob_type->tp_as_sequence &&
1930 o->ob_type->tp_as_sequence->sq_slice);
Guido van Rossume15dee51995-07-18 14:12:02 +00001931}
1932
Martin v. Löwis18e16552006-02-15 17:27:45 +00001933Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001934PyMapping_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001935{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001936 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001937
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001938 if (o == NULL) {
1939 null_error();
1940 return -1;
1941 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001942
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001943 m = o->ob_type->tp_as_mapping;
1944 if (m && m->mp_length)
1945 return m->mp_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001946
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001947 type_error("object of type '%.200s' has no len()", o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001948 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001949}
1950
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001951#undef PyMapping_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001952Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001953PyMapping_Length(PyObject *o)
1954{
1955 return PyMapping_Size(o);
1956}
1957#define PyMapping_Length PyMapping_Size
1958
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001959PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001960PyMapping_GetItemString(PyObject *o, char *key)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001961{
1962 PyObject *okey, *r;
1963
1964 if (key == NULL)
1965 return null_error();
1966
Martin v. Löwis5b222132007-06-10 09:51:05 +00001967 okey = PyUnicode_FromString(key);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001968 if (okey == NULL)
1969 return NULL;
1970 r = PyObject_GetItem(o, okey);
1971 Py_DECREF(okey);
1972 return r;
1973}
1974
1975int
Fred Drake79912472000-07-09 04:06:11 +00001976PyMapping_SetItemString(PyObject *o, char *key, PyObject *value)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001977{
1978 PyObject *okey;
1979 int r;
1980
1981 if (key == NULL) {
1982 null_error();
1983 return -1;
1984 }
1985
Martin v. Löwis5b222132007-06-10 09:51:05 +00001986 okey = PyUnicode_FromString(key);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001987 if (okey == NULL)
Guido van Rossumed6219b1998-05-29 02:59:33 +00001988 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001989 r = PyObject_SetItem(o, okey, value);
1990 Py_DECREF(okey);
1991 return r;
1992}
1993
1994int
Fred Drake79912472000-07-09 04:06:11 +00001995PyMapping_HasKeyString(PyObject *o, char *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00001996{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001997 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00001998
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001999 v = PyMapping_GetItemString(o, key);
2000 if (v) {
2001 Py_DECREF(v);
2002 return 1;
2003 }
2004 PyErr_Clear();
2005 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002006}
2007
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002008int
Fred Drake79912472000-07-09 04:06:11 +00002009PyMapping_HasKey(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002010{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002011 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002012
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002013 v = PyObject_GetItem(o, key);
2014 if (v) {
2015 Py_DECREF(v);
2016 return 1;
2017 }
2018 PyErr_Clear();
2019 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002020}
2021
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002022PyObject *
2023PyMapping_Keys(PyObject *o)
2024{
2025 PyObject *keys;
2026 PyObject *fast;
2027
2028 if (PyDict_CheckExact(o))
2029 return PyDict_Keys(o);
2030 keys = PyObject_CallMethod(o, "keys", NULL);
2031 if (keys == NULL)
2032 return NULL;
2033 fast = PySequence_Fast(keys, "o.keys() are not iterable");
2034 Py_DECREF(keys);
2035 return fast;
2036}
2037
2038PyObject *
2039PyMapping_Items(PyObject *o)
2040{
2041 PyObject *items;
2042 PyObject *fast;
2043
2044 if (PyDict_CheckExact(o))
2045 return PyDict_Items(o);
2046 items = PyObject_CallMethod(o, "items", NULL);
2047 if (items == NULL)
2048 return NULL;
2049 fast = PySequence_Fast(items, "o.items() are not iterable");
2050 Py_DECREF(items);
2051 return fast;
2052}
2053
2054PyObject *
2055PyMapping_Values(PyObject *o)
2056{
2057 PyObject *values;
2058 PyObject *fast;
2059
2060 if (PyDict_CheckExact(o))
2061 return PyDict_Values(o);
2062 values = PyObject_CallMethod(o, "values", NULL);
2063 if (values == NULL)
2064 return NULL;
2065 fast = PySequence_Fast(values, "o.values() are not iterable");
2066 Py_DECREF(values);
2067 return fast;
2068}
2069
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002070/* Operations on callable objects */
2071
2072/* XXX PyCallable_Check() is in object.c */
2073
Guido van Rossume15dee51995-07-18 14:12:02 +00002074PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002075PyObject_CallObject(PyObject *o, PyObject *a)
Guido van Rossume15dee51995-07-18 14:12:02 +00002076{
Guido van Rossum5560b742001-09-14 16:47:50 +00002077 return PyEval_CallObjectWithKeywords(o, a, NULL);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002078}
Guido van Rossume15dee51995-07-18 14:12:02 +00002079
2080PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00002081PyObject_Call(PyObject *func, PyObject *arg, PyObject *kw)
2082{
2083 ternaryfunc call;
2084
2085 if ((call = func->ob_type->tp_call) != NULL) {
2086 PyObject *result = (*call)(func, arg, kw);
2087 if (result == NULL && !PyErr_Occurred())
2088 PyErr_SetString(
2089 PyExc_SystemError,
2090 "NULL result without error in PyObject_Call");
2091 return result;
2092 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002093 PyErr_Format(PyExc_TypeError, "'%.200s' object is not callable",
Fred Drake573395a2001-11-01 20:26:12 +00002094 func->ob_type->tp_name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002095 return NULL;
2096}
2097
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002098static PyObject*
2099call_function_tail(PyObject *callable, PyObject *args)
2100{
2101 PyObject *retval;
2102
2103 if (args == NULL)
2104 return NULL;
2105
2106 if (!PyTuple_Check(args)) {
2107 PyObject *a;
2108
2109 a = PyTuple_New(1);
2110 if (a == NULL) {
2111 Py_DECREF(args);
2112 return NULL;
2113 }
2114 PyTuple_SET_ITEM(a, 0, args);
2115 args = a;
2116 }
2117 retval = PyObject_Call(callable, args, NULL);
2118
2119 Py_DECREF(args);
2120
2121 return retval;
2122}
2123
Tim Peters6d6c1a32001-08-02 04:15:00 +00002124PyObject *
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002125PyObject_CallFunction(PyObject *callable, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002126{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002127 va_list va;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002128 PyObject *args;
Guido van Rossume15dee51995-07-18 14:12:02 +00002129
Fred Drakeb92cf062001-10-27 06:16:31 +00002130 if (callable == NULL)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002131 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002132
Fred Drakeb92cf062001-10-27 06:16:31 +00002133 if (format && *format) {
2134 va_start(va, format);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002135 args = Py_VaBuildValue(format, va);
Fred Drakeb92cf062001-10-27 06:16:31 +00002136 va_end(va);
2137 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002138 else
2139 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002140
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002141 return call_function_tail(callable, args);
2142}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002143
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002144PyObject *
2145_PyObject_CallFunction_SizeT(PyObject *callable, char *format, ...)
2146{
2147 va_list va;
2148 PyObject *args;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002149
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002150 if (callable == NULL)
2151 return null_error();
2152
2153 if (format && *format) {
2154 va_start(va, format);
2155 args = _Py_VaBuildValue_SizeT(format, va);
2156 va_end(va);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002157 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002158 else
2159 args = PyTuple_New(0);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002160
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002161 return call_function_tail(callable, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002162}
2163
2164PyObject *
Guido van Rossume15dee51995-07-18 14:12:02 +00002165PyObject_CallMethod(PyObject *o, char *name, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002166{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002167 va_list va;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002168 PyObject *args;
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002169 PyObject *func = NULL;
2170 PyObject *retval = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002171
Fred Drakeb92cf062001-10-27 06:16:31 +00002172 if (o == NULL || name == NULL)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002173 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002174
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002175 func = PyObject_GetAttrString(o, name);
2176 if (func == NULL) {
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002177 PyErr_SetString(PyExc_AttributeError, name);
2178 return 0;
2179 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002180
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002181 if (!PyCallable_Check(func)) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002182 type_error("attribute of type '%.200s' is not callable", func);
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002183 goto exit;
2184 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002185
Fred Drakeb92cf062001-10-27 06:16:31 +00002186 if (format && *format) {
2187 va_start(va, format);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002188 args = Py_VaBuildValue(format, va);
Fred Drakeb92cf062001-10-27 06:16:31 +00002189 va_end(va);
2190 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002191 else
2192 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002193
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002194 retval = call_function_tail(func, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002195
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002196 exit:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002197 /* args gets consumed in call_function_tail */
2198 Py_XDECREF(func);
2199
2200 return retval;
2201}
2202
2203PyObject *
2204_PyObject_CallMethod_SizeT(PyObject *o, char *name, char *format, ...)
2205{
2206 va_list va;
2207 PyObject *args;
2208 PyObject *func = NULL;
2209 PyObject *retval = NULL;
2210
2211 if (o == NULL || name == NULL)
2212 return null_error();
2213
2214 func = PyObject_GetAttrString(o, name);
2215 if (func == NULL) {
2216 PyErr_SetString(PyExc_AttributeError, name);
2217 return 0;
2218 }
2219
2220 if (!PyCallable_Check(func)) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002221 type_error("attribute of type '%.200s' is not callable", func);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002222 goto exit;
2223 }
2224
2225 if (format && *format) {
2226 va_start(va, format);
2227 args = _Py_VaBuildValue_SizeT(format, va);
2228 va_end(va);
2229 }
2230 else
2231 args = PyTuple_New(0);
2232
2233 retval = call_function_tail(func, args);
2234
2235 exit:
2236 /* args gets consumed in call_function_tail */
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002237 Py_XDECREF(func);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002238
2239 return retval;
Guido van Rossume15dee51995-07-18 14:12:02 +00002240}
Guido van Rossum823649d2001-03-21 18:40:58 +00002241
2242
Fred Drakeb421b8c2001-10-26 16:21:32 +00002243static PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002244objargs_mktuple(va_list va)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002245{
2246 int i, n = 0;
2247 va_list countva;
2248 PyObject *result, *tmp;
2249
2250#ifdef VA_LIST_IS_ARRAY
2251 memcpy(countva, va, sizeof(va_list));
2252#else
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002253#ifdef __va_copy
2254 __va_copy(countva, va);
2255#else
Fred Drakeb421b8c2001-10-26 16:21:32 +00002256 countva = va;
2257#endif
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002258#endif
Fred Drakeb421b8c2001-10-26 16:21:32 +00002259
2260 while (((PyObject *)va_arg(countva, PyObject *)) != NULL)
2261 ++n;
2262 result = PyTuple_New(n);
2263 if (result != NULL && n > 0) {
2264 for (i = 0; i < n; ++i) {
2265 tmp = (PyObject *)va_arg(va, PyObject *);
2266 PyTuple_SET_ITEM(result, i, tmp);
2267 Py_INCREF(tmp);
2268 }
2269 }
2270 return result;
2271}
2272
2273PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002274PyObject_CallMethodObjArgs(PyObject *callable, PyObject *name, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002275{
2276 PyObject *args, *tmp;
2277 va_list vargs;
2278
2279 if (callable == NULL || name == NULL)
2280 return null_error();
2281
2282 callable = PyObject_GetAttr(callable, name);
2283 if (callable == NULL)
2284 return NULL;
2285
2286 /* count the args */
2287 va_start(vargs, name);
Fred Drakeb0c079e2001-10-28 02:39:03 +00002288 args = objargs_mktuple(vargs);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002289 va_end(vargs);
2290 if (args == NULL) {
2291 Py_DECREF(callable);
2292 return NULL;
2293 }
2294 tmp = PyObject_Call(callable, args, NULL);
2295 Py_DECREF(args);
2296 Py_DECREF(callable);
2297
2298 return tmp;
2299}
2300
2301PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002302PyObject_CallFunctionObjArgs(PyObject *callable, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002303{
2304 PyObject *args, *tmp;
2305 va_list vargs;
2306
2307 if (callable == NULL)
2308 return null_error();
2309
2310 /* count the args */
2311 va_start(vargs, callable);
Fred Drakeb0c079e2001-10-28 02:39:03 +00002312 args = objargs_mktuple(vargs);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002313 va_end(vargs);
2314 if (args == NULL)
2315 return NULL;
2316 tmp = PyObject_Call(callable, args, NULL);
2317 Py_DECREF(args);
2318
2319 return tmp;
2320}
2321
2322
Guido van Rossum823649d2001-03-21 18:40:58 +00002323/* isinstance(), issubclass() */
2324
Barry Warsawf16951c2002-04-23 22:45:44 +00002325/* abstract_get_bases() has logically 4 return states, with a sort of 0th
2326 * state that will almost never happen.
2327 *
2328 * 0. creating the __bases__ static string could get a MemoryError
2329 * 1. getattr(cls, '__bases__') could raise an AttributeError
2330 * 2. getattr(cls, '__bases__') could raise some other exception
2331 * 3. getattr(cls, '__bases__') could return a tuple
2332 * 4. getattr(cls, '__bases__') could return something other than a tuple
2333 *
2334 * Only state #3 is a non-error state and only it returns a non-NULL object
2335 * (it returns the retrieved tuple).
2336 *
2337 * Any raised AttributeErrors are masked by clearing the exception and
2338 * returning NULL. If an object other than a tuple comes out of __bases__,
2339 * then again, the return value is NULL. So yes, these two situations
2340 * produce exactly the same results: NULL is returned and no error is set.
2341 *
2342 * If some exception other than AttributeError is raised, then NULL is also
2343 * returned, but the exception is not cleared. That's because we want the
2344 * exception to be propagated along.
2345 *
2346 * Callers are expected to test for PyErr_Occurred() when the return value
2347 * is NULL to decide whether a valid exception should be propagated or not.
2348 * When there's no exception to propagate, it's customary for the caller to
2349 * set a TypeError.
2350 */
Neil Schemenauer6b471292001-10-18 03:18:43 +00002351static PyObject *
2352abstract_get_bases(PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002353{
2354 static PyObject *__bases__ = NULL;
2355 PyObject *bases;
Guido van Rossum823649d2001-03-21 18:40:58 +00002356
2357 if (__bases__ == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002358 __bases__ = PyUnicode_FromString("__bases__");
Guido van Rossum823649d2001-03-21 18:40:58 +00002359 if (__bases__ == NULL)
Neil Schemenauer6b471292001-10-18 03:18:43 +00002360 return NULL;
Guido van Rossum823649d2001-03-21 18:40:58 +00002361 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002362 Py_ALLOW_RECURSION
Neil Schemenauer6b471292001-10-18 03:18:43 +00002363 bases = PyObject_GetAttr(cls, __bases__);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002364 Py_END_ALLOW_RECURSION
Barry Warsawf16951c2002-04-23 22:45:44 +00002365 if (bases == NULL) {
2366 if (PyErr_ExceptionMatches(PyExc_AttributeError))
2367 PyErr_Clear();
Neil Schemenauer6b471292001-10-18 03:18:43 +00002368 return NULL;
Guido van Rossum823649d2001-03-21 18:40:58 +00002369 }
Barry Warsawf16951c2002-04-23 22:45:44 +00002370 if (!PyTuple_Check(bases)) {
2371 Py_DECREF(bases);
2372 return NULL;
2373 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002374 return bases;
2375}
2376
2377
2378static int
2379abstract_issubclass(PyObject *derived, PyObject *cls)
2380{
2381 PyObject *bases;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002382 Py_ssize_t i, n;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002383 int r = 0;
2384
2385
Guido van Rossum823649d2001-03-21 18:40:58 +00002386 if (derived == cls)
2387 return 1;
2388
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002389 if (PyTuple_Check(cls)) {
2390 /* Not a general sequence -- that opens up the road to
2391 recursion and stack overflow. */
2392 n = PyTuple_GET_SIZE(cls);
2393 for (i = 0; i < n; i++) {
2394 if (derived == PyTuple_GET_ITEM(cls, i))
2395 return 1;
2396 }
2397 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002398 bases = abstract_get_bases(derived);
Barry Warsawf16951c2002-04-23 22:45:44 +00002399 if (bases == NULL) {
2400 if (PyErr_Occurred())
2401 return -1;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002402 return 0;
Barry Warsawf16951c2002-04-23 22:45:44 +00002403 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002404 n = PyTuple_GET_SIZE(bases);
2405 for (i = 0; i < n; i++) {
Neil Schemenauer6b471292001-10-18 03:18:43 +00002406 r = abstract_issubclass(PyTuple_GET_ITEM(bases, i), cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002407 if (r != 0)
2408 break;
2409 }
2410
2411 Py_DECREF(bases);
2412
2413 return r;
2414}
2415
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002416static int
2417check_class(PyObject *cls, const char *error)
2418{
2419 PyObject *bases = abstract_get_bases(cls);
2420 if (bases == NULL) {
2421 /* Do not mask errors. */
2422 if (!PyErr_Occurred())
2423 PyErr_SetString(PyExc_TypeError, error);
2424 return 0;
2425 }
2426 Py_DECREF(bases);
2427 return -1;
2428}
2429
Brett Cannon4f653312004-03-20 22:52:14 +00002430static int
2431recursive_isinstance(PyObject *inst, PyObject *cls, int recursion_depth)
Guido van Rossum823649d2001-03-21 18:40:58 +00002432{
2433 PyObject *icls;
2434 static PyObject *__class__ = NULL;
2435 int retval = 0;
2436
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002437 if (__class__ == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002438 __class__ = PyUnicode_FromString("__class__");
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002439 if (__class__ == NULL)
2440 return -1;
2441 }
2442
Guido van Rossum45aecf42006-03-15 04:58:47 +00002443 if (PyType_Check(cls)) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00002444 retval = PyObject_TypeCheck(inst, (PyTypeObject *)cls);
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002445 if (retval == 0) {
2446 PyObject *c = PyObject_GetAttr(inst, __class__);
2447 if (c == NULL) {
2448 PyErr_Clear();
2449 }
2450 else {
Guido van Rossume5b130b2003-02-12 03:36:05 +00002451 if (c != (PyObject *)(inst->ob_type) &&
2452 PyType_Check(c))
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002453 retval = PyType_IsSubtype(
2454 (PyTypeObject *)c,
2455 (PyTypeObject *)cls);
2456 Py_DECREF(c);
2457 }
2458 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002459 }
Guido van Rossum03290ec2001-10-07 20:54:12 +00002460 else if (PyTuple_Check(cls)) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00002461 Py_ssize_t i, n;
Guido van Rossum03290ec2001-10-07 20:54:12 +00002462
Brett Cannon4f653312004-03-20 22:52:14 +00002463 if (!recursion_depth) {
2464 PyErr_SetString(PyExc_RuntimeError,
2465 "nest level of tuple too deep");
Tim Peters5f112eb2004-03-21 16:59:09 +00002466 return -1;
Brett Cannon4f653312004-03-20 22:52:14 +00002467 }
2468
Guido van Rossum03290ec2001-10-07 20:54:12 +00002469 n = PyTuple_GET_SIZE(cls);
2470 for (i = 0; i < n; i++) {
Brett Cannon4f653312004-03-20 22:52:14 +00002471 retval = recursive_isinstance(
2472 inst,
2473 PyTuple_GET_ITEM(cls, i),
2474 recursion_depth-1);
Guido van Rossum03290ec2001-10-07 20:54:12 +00002475 if (retval != 0)
2476 break;
2477 }
Guido van Rossum03290ec2001-10-07 20:54:12 +00002478 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002479 else {
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002480 if (!check_class(cls,
2481 "isinstance() arg 2 must be a class, type,"
2482 " or tuple of classes and types"))
Neil Schemenauer6b471292001-10-18 03:18:43 +00002483 return -1;
Guido van Rossum823649d2001-03-21 18:40:58 +00002484 icls = PyObject_GetAttr(inst, __class__);
Neil Schemenauer6b471292001-10-18 03:18:43 +00002485 if (icls == NULL) {
2486 PyErr_Clear();
2487 retval = 0;
Guido van Rossum823649d2001-03-21 18:40:58 +00002488 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002489 else {
2490 retval = abstract_issubclass(icls, cls);
2491 Py_DECREF(icls);
2492 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002493 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002494
Guido van Rossum823649d2001-03-21 18:40:58 +00002495 return retval;
2496}
2497
2498int
Brett Cannon4f653312004-03-20 22:52:14 +00002499PyObject_IsInstance(PyObject *inst, PyObject *cls)
2500{
Guido van Rossumadee45e2007-05-25 17:55:52 +00002501 PyObject *t, *v, *tb;
Guido van Rossume7ba4952007-06-06 23:52:48 +00002502 PyObject *checker;
Guido van Rossumadee45e2007-05-25 17:55:52 +00002503 PyErr_Fetch(&t, &v, &tb);
Guido van Rossume7ba4952007-06-06 23:52:48 +00002504 checker = PyObject_GetAttrString(cls, "__instancecheck__");
Guido van Rossumadee45e2007-05-25 17:55:52 +00002505 PyErr_Restore(t, v, tb);
2506 if (checker != NULL) {
2507 PyObject *res;
2508 int ok = -1;
Guido van Rossum29478ef2007-05-29 00:39:44 +00002509 if (Py_EnterRecursiveCall(" in __instancecheck__")) {
2510 Py_DECREF(checker);
Guido van Rossumadee45e2007-05-25 17:55:52 +00002511 return ok;
Guido van Rossum29478ef2007-05-29 00:39:44 +00002512 }
Guido van Rossumadee45e2007-05-25 17:55:52 +00002513 res = PyObject_CallFunctionObjArgs(checker, inst, NULL);
2514 Py_LeaveRecursiveCall();
2515 Py_DECREF(checker);
2516 if (res != NULL) {
2517 ok = PyObject_IsTrue(res);
2518 Py_DECREF(res);
2519 }
2520 return ok;
2521 }
2522 return recursive_isinstance(inst, cls, Py_GetRecursionLimit());
Brett Cannon4f653312004-03-20 22:52:14 +00002523}
2524
2525static int
2526recursive_issubclass(PyObject *derived, PyObject *cls, int recursion_depth)
Guido van Rossum823649d2001-03-21 18:40:58 +00002527{
2528 int retval;
2529
Guido van Rossum45aecf42006-03-15 04:58:47 +00002530 {
Guido van Rossumf6c9ba82003-02-10 16:05:43 +00002531 if (!check_class(derived,
2532 "issubclass() arg 1 must be a class"))
Neil Schemenauer6b471292001-10-18 03:18:43 +00002533 return -1;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002534
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002535 if (PyTuple_Check(cls)) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00002536 Py_ssize_t i;
2537 Py_ssize_t n = PyTuple_GET_SIZE(cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002538
2539 if (!recursion_depth) {
2540 PyErr_SetString(PyExc_RuntimeError,
2541 "nest level of tuple too deep");
Tim Peters5f112eb2004-03-21 16:59:09 +00002542 return -1;
Brett Cannon4f653312004-03-20 22:52:14 +00002543 }
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002544 for (i = 0; i < n; ++i) {
Brett Cannon4f653312004-03-20 22:52:14 +00002545 retval = recursive_issubclass(
2546 derived,
2547 PyTuple_GET_ITEM(cls, i),
2548 recursion_depth-1);
Guido van Rossumf6c9ba82003-02-10 16:05:43 +00002549 if (retval != 0) {
2550 /* either found it, or got an error */
Walter Dörwald7e5c6a02002-12-12 19:14:08 +00002551 return retval;
Guido van Rossumf6c9ba82003-02-10 16:05:43 +00002552 }
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002553 }
Walter Dörwald7e5c6a02002-12-12 19:14:08 +00002554 return 0;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002555 }
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002556 else {
2557 if (!check_class(cls,
2558 "issubclass() arg 2 must be a class"
2559 " or tuple of classes"))
2560 return -1;
2561 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002562
2563 retval = abstract_issubclass(derived, cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002564 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002565
2566 return retval;
2567}
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002568
Brett Cannon4f653312004-03-20 22:52:14 +00002569int
2570PyObject_IsSubclass(PyObject *derived, PyObject *cls)
2571{
Guido van Rossumadee45e2007-05-25 17:55:52 +00002572 PyObject *t, *v, *tb;
Guido van Rossume7ba4952007-06-06 23:52:48 +00002573 PyObject *checker;
Guido van Rossumadee45e2007-05-25 17:55:52 +00002574 PyErr_Fetch(&t, &v, &tb);
Guido van Rossume7ba4952007-06-06 23:52:48 +00002575 checker = PyObject_GetAttrString(cls, "__subclasscheck__");
Guido van Rossumadee45e2007-05-25 17:55:52 +00002576 PyErr_Restore(t, v, tb);
2577 if (checker != NULL) {
2578 PyObject *res;
2579 int ok = -1;
2580 if (Py_EnterRecursiveCall(" in __subclasscheck__"))
2581 return ok;
2582 res = PyObject_CallFunctionObjArgs(checker, derived, NULL);
2583 Py_LeaveRecursiveCall();
2584 Py_DECREF(checker);
2585 if (res != NULL) {
2586 ok = PyObject_IsTrue(res);
2587 Py_DECREF(res);
2588 }
2589 return ok;
2590 }
2591 return recursive_issubclass(derived, cls, Py_GetRecursionLimit());
Brett Cannon4f653312004-03-20 22:52:14 +00002592}
2593
2594
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002595PyObject *
2596PyObject_GetIter(PyObject *o)
2597{
2598 PyTypeObject *t = o->ob_type;
2599 getiterfunc f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00002600 f = t->tp_iter;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002601 if (f == NULL) {
2602 if (PySequence_Check(o))
Guido van Rossum213c7a62001-04-23 14:08:49 +00002603 return PySeqIter_New(o);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002604 return type_error("'%.200s' object is not iterable", o);
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002605 }
Guido van Rossum213c7a62001-04-23 14:08:49 +00002606 else {
2607 PyObject *res = (*f)(o);
2608 if (res != NULL && !PyIter_Check(res)) {
2609 PyErr_Format(PyExc_TypeError,
2610 "iter() returned non-iterator "
2611 "of type '%.100s'",
2612 res->ob_type->tp_name);
2613 Py_DECREF(res);
2614 res = NULL;
2615 }
2616 return res;
2617 }
2618}
2619
Tim Petersf4848da2001-05-05 00:14:56 +00002620/* Return next item.
2621 * If an error occurs, return NULL. PyErr_Occurred() will be true.
2622 * If the iteration terminates normally, return NULL and clear the
2623 * PyExc_StopIteration exception (if it was set). PyErr_Occurred()
2624 * will be false.
2625 * Else return the next object. PyErr_Occurred() will be false.
2626 */
Guido van Rossum213c7a62001-04-23 14:08:49 +00002627PyObject *
2628PyIter_Next(PyObject *iter)
2629{
Tim Petersf4848da2001-05-05 00:14:56 +00002630 PyObject *result;
Raymond Hettinger8049dde2003-03-01 01:44:32 +00002631 assert(PyIter_Check(iter));
Tim Petersf4848da2001-05-05 00:14:56 +00002632 result = (*iter->ob_type->tp_iternext)(iter);
2633 if (result == NULL &&
2634 PyErr_Occurred() &&
2635 PyErr_ExceptionMatches(PyExc_StopIteration))
2636 PyErr_Clear();
2637 return result;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002638}