blob: 75de1aa047a66b246e591ba9baf59cf48cc917bd [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
8#define NEW_STYLE_NUMBER(o) PyType_HasFeature((o)->ob_type, \
Antoine Pitrouc83ea132010-05-09 14:46:46 +00009 Py_TPFLAGS_CHECKTYPES)
Guido van Rossume15dee51995-07-18 14:12:02 +000010
Martin v. Löwis5cb69362006-04-14 09:08:42 +000011
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000012/* Shorthands to return certain errors */
Guido van Rossume15dee51995-07-18 14:12:02 +000013
14static PyObject *
Georg Brandlccff7852006-06-18 22:17:29 +000015type_error(const char *msg, PyObject *obj)
Guido van Rossume15dee51995-07-18 14:12:02 +000016{
Antoine Pitrouc83ea132010-05-09 14:46:46 +000017 PyErr_Format(PyExc_TypeError, msg, obj->ob_type->tp_name);
18 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +000019}
20
Guido van Rossum052b7e11996-11-11 15:08:19 +000021static PyObject *
Fred Drake79912472000-07-09 04:06:11 +000022null_error(void)
Guido van Rossume15dee51995-07-18 14:12:02 +000023{
Antoine Pitrouc83ea132010-05-09 14:46:46 +000024 if (!PyErr_Occurred())
25 PyErr_SetString(PyExc_SystemError,
26 "null argument to internal routine");
27 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +000028}
29
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000030/* Operations on any object */
31
32int
Fred Drake79912472000-07-09 04:06:11 +000033PyObject_Cmp(PyObject *o1, PyObject *o2, int *result)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000034{
Antoine Pitrouc83ea132010-05-09 14:46:46 +000035 int r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000036
Antoine Pitrouc83ea132010-05-09 14:46:46 +000037 if (o1 == NULL || o2 == NULL) {
38 null_error();
39 return -1;
40 }
41 r = PyObject_Compare(o1, o2);
42 if (PyErr_Occurred())
43 return -1;
44 *result = r;
45 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +000046}
Guido van Rossume15dee51995-07-18 14:12:02 +000047
48PyObject *
Fred Drake79912472000-07-09 04:06:11 +000049PyObject_Type(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +000050{
Antoine Pitrouc83ea132010-05-09 14:46:46 +000051 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +000052
Antoine Pitrouc83ea132010-05-09 14:46:46 +000053 if (o == NULL)
54 return null_error();
55 v = (PyObject *)o->ob_type;
56 Py_INCREF(v);
57 return v;
Guido van Rossume15dee51995-07-18 14:12:02 +000058}
59
Martin v. Löwis18e16552006-02-15 17:27:45 +000060Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +000061PyObject_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +000062{
Antoine Pitrouc83ea132010-05-09 14:46:46 +000063 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +000064
Antoine Pitrouc83ea132010-05-09 14:46:46 +000065 if (o == NULL) {
66 null_error();
67 return -1;
68 }
Guido van Rossume15dee51995-07-18 14:12:02 +000069
Antoine Pitrouc83ea132010-05-09 14:46:46 +000070 m = o->ob_type->tp_as_sequence;
71 if (m && m->sq_length)
72 return m->sq_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +000073
Antoine Pitrouc83ea132010-05-09 14:46:46 +000074 return PyMapping_Size(o);
Guido van Rossume15dee51995-07-18 14:12:02 +000075}
76
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000077#undef PyObject_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +000078Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000079PyObject_Length(PyObject *o)
80{
Antoine Pitrouc83ea132010-05-09 14:46:46 +000081 return PyObject_Size(o);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000082}
83#define PyObject_Length PyObject_Size
84
Raymond Hettinger6b27cda2005-09-24 21:23:05 +000085
Raymond Hettinger4e2f7142007-12-06 00:56:53 +000086/* The length hint function returns a non-negative value from o.__len__()
87 or o.__length_hint__(). If those methods aren't found or return a negative
Raymond Hettingerb5163702009-02-02 21:50:13 +000088 value, then the defaultvalue is returned. If one of the calls fails,
89 this function returns -1.
Raymond Hettinger4e2f7142007-12-06 00:56:53 +000090*/
91
92Py_ssize_t
93_PyObject_LengthHint(PyObject *o, Py_ssize_t defaultvalue)
94{
Antoine Pitrouc83ea132010-05-09 14:46:46 +000095 static PyObject *hintstrobj = NULL;
96 PyObject *ro, *hintmeth;
97 Py_ssize_t rv;
Raymond Hettinger4e2f7142007-12-06 00:56:53 +000098
Antoine Pitrouc83ea132010-05-09 14:46:46 +000099 /* try o.__len__() */
100 rv = PyObject_Size(o);
101 if (rv >= 0)
102 return rv;
103 if (PyErr_Occurred()) {
104 if (!PyErr_ExceptionMatches(PyExc_TypeError) &&
105 !PyErr_ExceptionMatches(PyExc_AttributeError))
106 return -1;
107 PyErr_Clear();
108 }
Raymond Hettinger4e2f7142007-12-06 00:56:53 +0000109
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000110 if (PyInstance_Check(o))
111 return defaultvalue;
112 /* try o.__length_hint__() */
113 hintmeth = _PyObject_LookupSpecial(o, "__length_hint__", &hintstrobj);
114 if (hintmeth == NULL) {
115 if (PyErr_Occurred())
116 return -1;
117 else
118 return defaultvalue;
119 }
120 ro = PyObject_CallFunctionObjArgs(hintmeth, NULL);
121 Py_DECREF(hintmeth);
122 if (ro == NULL) {
123 if (!PyErr_ExceptionMatches(PyExc_TypeError) &&
124 !PyErr_ExceptionMatches(PyExc_AttributeError))
125 return -1;
126 PyErr_Clear();
127 return defaultvalue;
128 }
129 rv = PyLong_Check(ro) ? PyLong_AsSsize_t(ro) : defaultvalue;
130 Py_DECREF(ro);
131 return rv;
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000132}
133
Guido van Rossume15dee51995-07-18 14:12:02 +0000134PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000135PyObject_GetItem(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +0000136{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000137 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +0000138
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000139 if (o == NULL || key == NULL)
140 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +0000141
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000142 m = o->ob_type->tp_as_mapping;
143 if (m && m->mp_subscript)
144 return m->mp_subscript(o, key);
Guido van Rossume15dee51995-07-18 14:12:02 +0000145
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000146 if (o->ob_type->tp_as_sequence) {
147 if (PyIndex_Check(key)) {
148 Py_ssize_t key_value;
149 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
150 if (key_value == -1 && PyErr_Occurred())
151 return NULL;
152 return PySequence_GetItem(o, key_value);
153 }
154 else if (o->ob_type->tp_as_sequence->sq_item)
155 return type_error("sequence index must "
156 "be integer, not '%.200s'", key);
157 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000158
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000159 return type_error("'%.200s' object is not subscriptable", o);
Guido van Rossume15dee51995-07-18 14:12:02 +0000160}
161
162int
Fred Drake79912472000-07-09 04:06:11 +0000163PyObject_SetItem(PyObject *o, PyObject *key, PyObject *value)
Guido van Rossume15dee51995-07-18 14:12:02 +0000164{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000165 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +0000166
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000167 if (o == NULL || key == NULL || value == NULL) {
168 null_error();
169 return -1;
170 }
171 m = o->ob_type->tp_as_mapping;
172 if (m && m->mp_ass_subscript)
173 return m->mp_ass_subscript(o, key, value);
Guido van Rossume15dee51995-07-18 14:12:02 +0000174
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000175 if (o->ob_type->tp_as_sequence) {
176 if (PyIndex_Check(key)) {
177 Py_ssize_t key_value;
178 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
179 if (key_value == -1 && PyErr_Occurred())
180 return -1;
181 return PySequence_SetItem(o, key_value, value);
182 }
183 else if (o->ob_type->tp_as_sequence->sq_ass_item) {
184 type_error("sequence index must be "
185 "integer, not '%.200s'", key);
186 return -1;
187 }
188 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000189
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000190 type_error("'%.200s' object does not support item assignment", o);
191 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +0000192}
193
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000194int
Fred Drake79912472000-07-09 04:06:11 +0000195PyObject_DelItem(PyObject *o, PyObject *key)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000196{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000197 PyMappingMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000198
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000199 if (o == NULL || key == NULL) {
200 null_error();
201 return -1;
202 }
203 m = o->ob_type->tp_as_mapping;
204 if (m && m->mp_ass_subscript)
205 return m->mp_ass_subscript(o, key, (PyObject*)NULL);
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000206
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000207 if (o->ob_type->tp_as_sequence) {
208 if (PyIndex_Check(key)) {
209 Py_ssize_t key_value;
210 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
211 if (key_value == -1 && PyErr_Occurred())
212 return -1;
213 return PySequence_DelItem(o, key_value);
214 }
215 else if (o->ob_type->tp_as_sequence->sq_ass_item) {
216 type_error("sequence index must be "
217 "integer, not '%.200s'", key);
218 return -1;
219 }
220 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000221
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000222 type_error("'%.200s' object does not support item deletion", o);
223 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000224}
225
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000226int
227PyObject_DelItemString(PyObject *o, char *key)
228{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000229 PyObject *okey;
230 int ret;
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000231
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000232 if (o == NULL || key == NULL) {
233 null_error();
234 return -1;
235 }
236 okey = PyString_FromString(key);
237 if (okey == NULL)
238 return -1;
239 ret = PyObject_DelItem(o, okey);
240 Py_DECREF(okey);
241 return ret;
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000242}
243
Brett Cannonea229bd2006-06-06 18:08:16 +0000244int
245PyObject_AsCharBuffer(PyObject *obj,
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000246 const char **buffer,
247 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000248{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000249 PyBufferProcs *pb;
250 char *pp;
251 Py_ssize_t len;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000252
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000253 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
254 null_error();
255 return -1;
256 }
257 pb = obj->ob_type->tp_as_buffer;
258 if (pb == NULL ||
259 pb->bf_getcharbuffer == NULL ||
260 pb->bf_getsegcount == NULL) {
261 PyErr_SetString(PyExc_TypeError,
262 "expected a character buffer object");
263 return -1;
264 }
265 if ((*pb->bf_getsegcount)(obj,NULL) != 1) {
266 PyErr_SetString(PyExc_TypeError,
267 "expected a single-segment buffer object");
268 return -1;
269 }
270 len = (*pb->bf_getcharbuffer)(obj, 0, &pp);
271 if (len < 0)
272 return -1;
273 *buffer = pp;
274 *buffer_len = len;
275 return 0;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000276}
Guido van Rossum4c08d552000-03-10 22:55:18 +0000277
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000278int
279PyObject_CheckReadBuffer(PyObject *obj)
280{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000281 PyBufferProcs *pb = obj->ob_type->tp_as_buffer;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000282
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000283 if (pb == NULL ||
284 pb->bf_getreadbuffer == NULL ||
285 pb->bf_getsegcount == NULL ||
286 (*pb->bf_getsegcount)(obj, NULL) != 1)
287 return 0;
288 return 1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000289}
290
291int PyObject_AsReadBuffer(PyObject *obj,
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000292 const void **buffer,
293 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000294{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000295 PyBufferProcs *pb;
296 void *pp;
297 Py_ssize_t len;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000298
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000299 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
300 null_error();
301 return -1;
302 }
303 pb = obj->ob_type->tp_as_buffer;
304 if (pb == NULL ||
305 pb->bf_getreadbuffer == NULL ||
306 pb->bf_getsegcount == NULL) {
307 PyErr_SetString(PyExc_TypeError,
308 "expected a readable buffer object");
309 return -1;
310 }
311 if ((*pb->bf_getsegcount)(obj, NULL) != 1) {
312 PyErr_SetString(PyExc_TypeError,
313 "expected a single-segment buffer object");
314 return -1;
315 }
316 len = (*pb->bf_getreadbuffer)(obj, 0, &pp);
317 if (len < 0)
318 return -1;
319 *buffer = pp;
320 *buffer_len = len;
321 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000322}
323
324int PyObject_AsWriteBuffer(PyObject *obj,
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000325 void **buffer,
326 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000327{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000328 PyBufferProcs *pb;
329 void*pp;
330 Py_ssize_t len;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000331
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000332 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
333 null_error();
334 return -1;
335 }
336 pb = obj->ob_type->tp_as_buffer;
337 if (pb == NULL ||
338 pb->bf_getwritebuffer == NULL ||
339 pb->bf_getsegcount == NULL) {
340 PyErr_SetString(PyExc_TypeError,
341 "expected a writeable buffer object");
342 return -1;
343 }
344 if ((*pb->bf_getsegcount)(obj, NULL) != 1) {
345 PyErr_SetString(PyExc_TypeError,
346 "expected a single-segment buffer object");
347 return -1;
348 }
349 len = (*pb->bf_getwritebuffer)(obj,0,&pp);
350 if (len < 0)
351 return -1;
352 *buffer = pp;
353 *buffer_len = len;
354 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000355}
356
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000357/* Buffer C-API for Python 3.0 */
358
359int
360PyObject_GetBuffer(PyObject *obj, Py_buffer *view, int flags)
361{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000362 if (!PyObject_CheckBuffer(obj)) {
363 PyErr_Format(PyExc_TypeError,
364 "'%100s' does not have the buffer interface",
365 Py_TYPE(obj)->tp_name);
366 return -1;
367 }
368 return (*(obj->ob_type->tp_as_buffer->bf_getbuffer))(obj, view, flags);
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000369}
370
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000371static int
372_IsFortranContiguous(Py_buffer *view)
373{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000374 Py_ssize_t sd, dim;
375 int i;
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000376
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000377 if (view->ndim == 0) return 1;
378 if (view->strides == NULL) return (view->ndim == 1);
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000379
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000380 sd = view->itemsize;
381 if (view->ndim == 1) return (view->shape[0] == 1 ||
382 sd == view->strides[0]);
383 for (i=0; i<view->ndim; i++) {
384 dim = view->shape[i];
385 if (dim == 0) return 1;
386 if (view->strides[i] != sd) return 0;
387 sd *= dim;
388 }
389 return 1;
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000390}
391
392static int
393_IsCContiguous(Py_buffer *view)
394{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000395 Py_ssize_t sd, dim;
396 int i;
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000397
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000398 if (view->ndim == 0) return 1;
399 if (view->strides == NULL) return 1;
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000400
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000401 sd = view->itemsize;
402 if (view->ndim == 1) return (view->shape[0] == 1 ||
403 sd == view->strides[0]);
404 for (i=view->ndim-1; i>=0; i--) {
405 dim = view->shape[i];
406 if (dim == 0) return 1;
407 if (view->strides[i] != sd) return 0;
408 sd *= dim;
409 }
410 return 1;
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000411}
412
413int
414PyBuffer_IsContiguous(Py_buffer *view, char fort)
415{
416
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000417 if (view->suboffsets != NULL) return 0;
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000418
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000419 if (fort == 'C')
420 return _IsCContiguous(view);
421 else if (fort == 'F')
422 return _IsFortranContiguous(view);
423 else if (fort == 'A')
424 return (_IsCContiguous(view) || _IsFortranContiguous(view));
425 return 0;
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000426}
427
428
429void*
430PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices)
431{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000432 char* pointer;
433 int i;
434 pointer = (char *)view->buf;
435 for (i = 0; i < view->ndim; i++) {
436 pointer += view->strides[i]*indices[i];
437 if ((view->suboffsets != NULL) && (view->suboffsets[i] >= 0)) {
438 pointer = *((char**)pointer) + view->suboffsets[i];
439 }
440 }
441 return (void*)pointer;
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000442}
443
444
Antoine Pitrou789be0c2009-04-02 21:18:34 +0000445void
Antoine Pitrou1fcdba82010-09-01 13:02:50 +0000446_Py_add_one_to_index_F(int nd, Py_ssize_t *index, const Py_ssize_t *shape)
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000447{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000448 int k;
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000449
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000450 for (k=0; k<nd; k++) {
451 if (index[k] < shape[k]-1) {
452 index[k]++;
453 break;
454 }
455 else {
456 index[k] = 0;
457 }
458 }
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000459}
460
Antoine Pitrou789be0c2009-04-02 21:18:34 +0000461void
Antoine Pitrou1fcdba82010-09-01 13:02:50 +0000462_Py_add_one_to_index_C(int nd, Py_ssize_t *index, const Py_ssize_t *shape)
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000463{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000464 int k;
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000465
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000466 for (k=nd-1; k>=0; k--) {
467 if (index[k] < shape[k]-1) {
468 index[k]++;
469 break;
470 }
471 else {
472 index[k] = 0;
473 }
474 }
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000475}
476
477 /* view is not checked for consistency in either of these. It is
478 assumed that the size of the buffer is view->len in
479 view->len / view->itemsize elements.
480 */
481
482int
483PyBuffer_ToContiguous(void *buf, Py_buffer *view, Py_ssize_t len, char fort)
484{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000485 int k;
Antoine Pitrou1fcdba82010-09-01 13:02:50 +0000486 void (*addone)(int, Py_ssize_t *, const Py_ssize_t *);
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000487 Py_ssize_t *indices, elements;
488 char *dest, *ptr;
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000489
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000490 if (len > view->len) {
491 len = view->len;
492 }
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000493
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000494 if (PyBuffer_IsContiguous(view, fort)) {
495 /* simplest copy is all that is needed */
496 memcpy(buf, view->buf, len);
497 return 0;
498 }
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000499
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000500 /* Otherwise a more elaborate scheme is needed */
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000501
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000502 /* XXX(nnorwitz): need to check for overflow! */
503 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
504 if (indices == NULL) {
505 PyErr_NoMemory();
506 return -1;
507 }
508 for (k=0; k<view->ndim;k++) {
509 indices[k] = 0;
510 }
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000511
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000512 if (fort == 'F') {
Antoine Pitrou1fcdba82010-09-01 13:02:50 +0000513 addone = _Py_add_one_to_index_F;
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000514 }
515 else {
Antoine Pitrou1fcdba82010-09-01 13:02:50 +0000516 addone = _Py_add_one_to_index_C;
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000517 }
518 dest = buf;
519 /* XXX : This is not going to be the fastest code in the world
520 several optimizations are possible.
521 */
522 elements = len / view->itemsize;
523 while (elements--) {
524 addone(view->ndim, indices, view->shape);
525 ptr = PyBuffer_GetPointer(view, indices);
526 memcpy(dest, ptr, view->itemsize);
527 dest += view->itemsize;
528 }
529 PyMem_Free(indices);
530 return 0;
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000531}
532
533int
534PyBuffer_FromContiguous(Py_buffer *view, void *buf, Py_ssize_t len, char fort)
535{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000536 int k;
Antoine Pitrou1fcdba82010-09-01 13:02:50 +0000537 void (*addone)(int, Py_ssize_t *, const Py_ssize_t *);
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000538 Py_ssize_t *indices, elements;
539 char *src, *ptr;
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000540
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000541 if (len > view->len) {
542 len = view->len;
543 }
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000544
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000545 if (PyBuffer_IsContiguous(view, fort)) {
546 /* simplest copy is all that is needed */
547 memcpy(view->buf, buf, len);
548 return 0;
549 }
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000550
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000551 /* Otherwise a more elaborate scheme is needed */
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000552
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000553 /* XXX(nnorwitz): need to check for overflow! */
554 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
555 if (indices == NULL) {
556 PyErr_NoMemory();
557 return -1;
558 }
559 for (k=0; k<view->ndim;k++) {
560 indices[k] = 0;
561 }
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000562
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000563 if (fort == 'F') {
Antoine Pitrou1fcdba82010-09-01 13:02:50 +0000564 addone = _Py_add_one_to_index_F;
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000565 }
566 else {
Antoine Pitrou1fcdba82010-09-01 13:02:50 +0000567 addone = _Py_add_one_to_index_C;
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000568 }
569 src = buf;
570 /* XXX : This is not going to be the fastest code in the world
571 several optimizations are possible.
572 */
573 elements = len / view->itemsize;
574 while (elements--) {
575 addone(view->ndim, indices, view->shape);
576 ptr = PyBuffer_GetPointer(view, indices);
577 memcpy(ptr, src, view->itemsize);
578 src += view->itemsize;
579 }
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000580
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000581 PyMem_Free(indices);
582 return 0;
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000583}
584
585int PyObject_CopyData(PyObject *dest, PyObject *src)
586{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000587 Py_buffer view_dest, view_src;
588 int k;
589 Py_ssize_t *indices, elements;
590 char *dptr, *sptr;
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000591
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000592 if (!PyObject_CheckBuffer(dest) ||
593 !PyObject_CheckBuffer(src)) {
594 PyErr_SetString(PyExc_TypeError,
595 "both destination and source must have the "\
596 "buffer interface");
597 return -1;
598 }
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000599
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000600 if (PyObject_GetBuffer(dest, &view_dest, PyBUF_FULL) != 0) return -1;
601 if (PyObject_GetBuffer(src, &view_src, PyBUF_FULL_RO) != 0) {
602 PyBuffer_Release(&view_dest);
603 return -1;
604 }
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000605
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000606 if (view_dest.len < view_src.len) {
607 PyErr_SetString(PyExc_BufferError,
608 "destination is too small to receive data from source");
609 PyBuffer_Release(&view_dest);
610 PyBuffer_Release(&view_src);
611 return -1;
612 }
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000613
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000614 if ((PyBuffer_IsContiguous(&view_dest, 'C') &&
615 PyBuffer_IsContiguous(&view_src, 'C')) ||
616 (PyBuffer_IsContiguous(&view_dest, 'F') &&
617 PyBuffer_IsContiguous(&view_src, 'F'))) {
618 /* simplest copy is all that is needed */
619 memcpy(view_dest.buf, view_src.buf, view_src.len);
620 PyBuffer_Release(&view_dest);
621 PyBuffer_Release(&view_src);
622 return 0;
623 }
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000624
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000625 /* Otherwise a more elaborate copy scheme is needed */
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000626
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000627 /* XXX(nnorwitz): need to check for overflow! */
628 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*view_src.ndim);
629 if (indices == NULL) {
630 PyErr_NoMemory();
631 PyBuffer_Release(&view_dest);
632 PyBuffer_Release(&view_src);
633 return -1;
634 }
635 for (k=0; k<view_src.ndim;k++) {
636 indices[k] = 0;
637 }
638 elements = 1;
639 for (k=0; k<view_src.ndim; k++) {
640 /* XXX(nnorwitz): can this overflow? */
641 elements *= view_src.shape[k];
642 }
643 while (elements--) {
Antoine Pitrou1fcdba82010-09-01 13:02:50 +0000644 _Py_add_one_to_index_C(view_src.ndim, indices, view_src.shape);
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000645 dptr = PyBuffer_GetPointer(&view_dest, indices);
646 sptr = PyBuffer_GetPointer(&view_src, indices);
647 memcpy(dptr, sptr, view_src.itemsize);
648 }
649 PyMem_Free(indices);
650 PyBuffer_Release(&view_dest);
651 PyBuffer_Release(&view_src);
652 return 0;
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000653}
654
655void
656PyBuffer_FillContiguousStrides(int nd, Py_ssize_t *shape,
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000657 Py_ssize_t *strides, int itemsize,
658 char fort)
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000659{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000660 int k;
661 Py_ssize_t sd;
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000662
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000663 sd = itemsize;
664 if (fort == 'F') {
665 for (k=0; k<nd; k++) {
666 strides[k] = sd;
667 sd *= shape[k];
668 }
669 }
670 else {
671 for (k=nd-1; k>=0; k--) {
672 strides[k] = sd;
673 sd *= shape[k];
674 }
675 }
676 return;
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000677}
678
679int
Martin v. Löwisf91d46a2008-08-12 14:49:50 +0000680PyBuffer_FillInfo(Py_buffer *view, PyObject *obj, void *buf, Py_ssize_t len,
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000681 int readonly, int flags)
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000682{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000683 if (view == NULL) return 0;
684 if (((flags & PyBUF_WRITABLE) == PyBUF_WRITABLE) &&
685 (readonly == 1)) {
686 PyErr_SetString(PyExc_BufferError,
687 "Object is not writable.");
688 return -1;
689 }
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000690
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000691 view->obj = obj;
692 if (obj)
693 Py_INCREF(obj);
694 view->buf = buf;
695 view->len = len;
696 view->readonly = readonly;
697 view->itemsize = 1;
698 view->format = NULL;
699 if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT)
700 view->format = "B";
701 view->ndim = 1;
702 view->shape = NULL;
703 if ((flags & PyBUF_ND) == PyBUF_ND)
704 view->shape = &(view->len);
705 view->strides = NULL;
706 if ((flags & PyBUF_STRIDES) == PyBUF_STRIDES)
707 view->strides = &(view->itemsize);
708 view->suboffsets = NULL;
709 view->internal = NULL;
710 return 0;
Travis E. Oliphant3781aef2008-03-18 04:44:57 +0000711}
712
Martin v. Löwisf91d46a2008-08-12 14:49:50 +0000713void
714PyBuffer_Release(Py_buffer *view)
715{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000716 PyObject *obj = view->obj;
717 if (obj && Py_TYPE(obj)->tp_as_buffer && Py_TYPE(obj)->tp_as_buffer->bf_releasebuffer)
718 Py_TYPE(obj)->tp_as_buffer->bf_releasebuffer(obj, view);
719 Py_XDECREF(obj);
720 view->obj = NULL;
Martin v. Löwisf91d46a2008-08-12 14:49:50 +0000721}
722
Eric Smitha9f7d622008-02-17 19:46:49 +0000723PyObject *
724PyObject_Format(PyObject* obj, PyObject *format_spec)
725{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000726 PyObject *empty = NULL;
727 PyObject *result = NULL;
Benjamin Peterson78821dd2009-01-25 17:15:10 +0000728#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000729 int spec_is_unicode;
730 int result_is_unicode;
Benjamin Peterson78821dd2009-01-25 17:15:10 +0000731#endif
Eric Smitha9f7d622008-02-17 19:46:49 +0000732
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000733 /* If no format_spec is provided, use an empty string */
734 if (format_spec == NULL) {
735 empty = PyString_FromStringAndSize(NULL, 0);
736 format_spec = empty;
737 }
Eric Smitha9f7d622008-02-17 19:46:49 +0000738
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000739 /* Check the format_spec type, and make sure it's str or unicode */
Hirokazu Yamamoto1e234e82009-01-25 17:46:48 +0000740#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000741 if (PyUnicode_Check(format_spec))
742 spec_is_unicode = 1;
743 else if (PyString_Check(format_spec))
744 spec_is_unicode = 0;
745 else {
Benjamin Peterson78821dd2009-01-25 17:15:10 +0000746#else
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000747 if (!PyString_Check(format_spec)) {
Benjamin Peterson78821dd2009-01-25 17:15:10 +0000748#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000749 PyErr_Format(PyExc_TypeError,
750 "format expects arg 2 to be string "
751 "or unicode, not %.100s", Py_TYPE(format_spec)->tp_name);
752 goto done;
753 }
Eric Smitha9f7d622008-02-17 19:46:49 +0000754
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000755 /* Check for a __format__ method and call it. */
756 if (PyInstance_Check(obj)) {
757 /* We're an instance of a classic class */
Benjamin Peterson2aa6c382010-06-05 00:32:50 +0000758 PyObject *bound_method = PyObject_GetAttrString(obj, "__format__");
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000759 if (bound_method != NULL) {
760 result = PyObject_CallFunctionObjArgs(bound_method,
761 format_spec,
762 NULL);
763 Py_DECREF(bound_method);
764 } else {
765 PyObject *self_as_str = NULL;
766 PyObject *format_method = NULL;
767 Py_ssize_t format_len;
Eric Smitha9f7d622008-02-17 19:46:49 +0000768
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000769 PyErr_Clear();
770 /* Per the PEP, convert to str (or unicode,
771 depending on the type of the format
772 specifier). For new-style classes, this
773 logic is done by object.__format__(). */
Benjamin Peterson78821dd2009-01-25 17:15:10 +0000774#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000775 if (spec_is_unicode) {
776 format_len = PyUnicode_GET_SIZE(format_spec);
777 self_as_str = PyObject_Unicode(obj);
778 } else
Benjamin Peterson78821dd2009-01-25 17:15:10 +0000779#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000780 {
781 format_len = PyString_GET_SIZE(format_spec);
782 self_as_str = PyObject_Str(obj);
783 }
784 if (self_as_str == NULL)
785 goto done1;
Eric Smithd44b2fc2010-04-02 12:30:56 +0000786
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000787 if (format_len > 0) {
788 /* See the almost identical code in
789 typeobject.c for new-style
790 classes. */
791 if (PyErr_WarnEx(
792 PyExc_PendingDeprecationWarning,
793 "object.__format__ with a non-empty "
794 "format string is deprecated", 1)
795 < 0) {
796 goto done1;
797 }
798 /* Eventually this will become an
799 error:
800 PyErr_Format(PyExc_TypeError,
801 "non-empty format string passed to "
802 "object.__format__");
803 goto done1;
804 */
805 }
Eric Smitha9f7d622008-02-17 19:46:49 +0000806
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000807 /* Then call str.__format__ on that result */
Benjamin Peterson2aa6c382010-06-05 00:32:50 +0000808 format_method = PyObject_GetAttrString(self_as_str, "__format__");
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000809 if (format_method == NULL) {
810 goto done1;
811 }
812 result = PyObject_CallFunctionObjArgs(format_method,
813 format_spec,
814 NULL);
Eric Smithd44b2fc2010-04-02 12:30:56 +0000815done1:
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000816 Py_XDECREF(self_as_str);
817 Py_XDECREF(format_method);
818 if (result == NULL)
819 goto done;
820 }
821 } else {
822 /* Not an instance of a classic class, use the code
823 from py3k */
Benjamin Peterson3a2acb52010-06-05 00:38:22 +0000824 static PyObject *format_cache = NULL;
Eric Smitha9f7d622008-02-17 19:46:49 +0000825
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000826 /* Find the (unbound!) __format__ method (a borrowed
827 reference) */
Benjamin Peterson2aa6c382010-06-05 00:32:50 +0000828 PyObject *method = _PyObject_LookupSpecial(obj, "__format__",
829 &format_cache);
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000830 if (method == NULL) {
Benjamin Peterson2aa6c382010-06-05 00:32:50 +0000831 if (!PyErr_Occurred())
832 PyErr_Format(PyExc_TypeError,
833 "Type %.100s doesn't define __format__",
834 Py_TYPE(obj)->tp_name);
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000835 goto done;
836 }
Benjamin Peterson2aa6c382010-06-05 00:32:50 +0000837 /* And call it. */
838 result = PyObject_CallFunctionObjArgs(method, format_spec, NULL);
Benjamin Petersond5adb5d2010-06-05 02:07:01 +0000839 Py_DECREF(method);
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000840 }
Eric Smitha9f7d622008-02-17 19:46:49 +0000841
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000842 if (result == NULL)
843 goto done;
Eric Smitha9f7d622008-02-17 19:46:49 +0000844
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000845 /* Check the result type, and make sure it's str or unicode */
Benjamin Peterson78821dd2009-01-25 17:15:10 +0000846#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000847 if (PyUnicode_Check(result))
848 result_is_unicode = 1;
849 else if (PyString_Check(result))
850 result_is_unicode = 0;
851 else {
Benjamin Peterson78821dd2009-01-25 17:15:10 +0000852#else
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000853 if (!PyString_Check(result)) {
Benjamin Peterson78821dd2009-01-25 17:15:10 +0000854#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000855 PyErr_Format(PyExc_TypeError,
856 "%.100s.__format__ must return string or "
857 "unicode, not %.100s", Py_TYPE(obj)->tp_name,
858 Py_TYPE(result)->tp_name);
859 Py_DECREF(result);
860 result = NULL;
861 goto done;
862 }
Eric Smitha9f7d622008-02-17 19:46:49 +0000863
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000864 /* Convert to unicode, if needed. Required if spec is unicode
865 and result is str */
Benjamin Peterson78821dd2009-01-25 17:15:10 +0000866#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000867 if (spec_is_unicode && !result_is_unicode) {
868 PyObject *tmp = PyObject_Unicode(result);
869 /* This logic works whether or not tmp is NULL */
870 Py_DECREF(result);
871 result = tmp;
872 }
Benjamin Peterson78821dd2009-01-25 17:15:10 +0000873#endif
Eric Smitha9f7d622008-02-17 19:46:49 +0000874
875done:
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000876 Py_XDECREF(empty);
877 return result;
Eric Smitha9f7d622008-02-17 19:46:49 +0000878}
879
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000880/* Operations on numbers */
881
882int
Fred Drake79912472000-07-09 04:06:11 +0000883PyNumber_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +0000884{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000885 return o && o->ob_type->tp_as_number &&
886 (o->ob_type->tp_as_number->nb_int ||
887 o->ob_type->tp_as_number->nb_float);
Guido van Rossume15dee51995-07-18 14:12:02 +0000888}
889
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000890/* Binary operators */
Guido van Rossume15dee51995-07-18 14:12:02 +0000891
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000892/* New style number protocol support */
Guido van Rossume15dee51995-07-18 14:12:02 +0000893
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000894#define NB_SLOT(x) offsetof(PyNumberMethods, x)
895#define NB_BINOP(nb_methods, slot) \
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000896 (*(binaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000897#define NB_TERNOP(nb_methods, slot) \
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000898 (*(ternaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000899
900/*
901 Calling scheme used for binary operations:
902
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000903 v w Action
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000904 -------------------------------------------------------------------
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000905 new new w.op(v,w)[*], v.op(v,w), w.op(v,w)
906 new old v.op(v,w), coerce(v,w), v.op(v,w)
907 old new w.op(v,w), coerce(v,w), v.op(v,w)
908 old old coerce(v,w), v.op(v,w)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000909
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000910 [*] only when v->ob_type != w->ob_type && w->ob_type is a subclass of
911 v->ob_type
912
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000913 Legend:
914 -------
915 * new == new style number
916 * old == old style number
917 * Action indicates the order in which operations are tried until either
918 a valid result is produced or an error occurs.
919
920 */
921
922static PyObject *
923binary_op1(PyObject *v, PyObject *w, const int op_slot)
Guido van Rossume15dee51995-07-18 14:12:02 +0000924{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000925 PyObject *x;
926 binaryfunc slotv = NULL;
927 binaryfunc slotw = NULL;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000928
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000929 if (v->ob_type->tp_as_number != NULL && NEW_STYLE_NUMBER(v))
930 slotv = NB_BINOP(v->ob_type->tp_as_number, op_slot);
931 if (w->ob_type != v->ob_type &&
932 w->ob_type->tp_as_number != NULL && NEW_STYLE_NUMBER(w)) {
933 slotw = NB_BINOP(w->ob_type->tp_as_number, op_slot);
934 if (slotw == slotv)
935 slotw = NULL;
936 }
937 if (slotv) {
938 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
939 x = slotw(v, w);
940 if (x != Py_NotImplemented)
941 return x;
942 Py_DECREF(x); /* can't do it */
943 slotw = NULL;
944 }
945 x = slotv(v, w);
946 if (x != Py_NotImplemented)
947 return x;
948 Py_DECREF(x); /* can't do it */
949 }
950 if (slotw) {
951 x = slotw(v, w);
952 if (x != Py_NotImplemented)
953 return x;
954 Py_DECREF(x); /* can't do it */
955 }
956 if (!NEW_STYLE_NUMBER(v) || !NEW_STYLE_NUMBER(w)) {
957 int err = PyNumber_CoerceEx(&v, &w);
958 if (err < 0) {
959 return NULL;
960 }
961 if (err == 0) {
962 PyNumberMethods *mv = v->ob_type->tp_as_number;
963 if (mv) {
964 binaryfunc slot;
965 slot = NB_BINOP(mv, op_slot);
966 if (slot) {
967 x = slot(v, w);
968 Py_DECREF(v);
969 Py_DECREF(w);
970 return x;
971 }
972 }
973 /* CoerceEx incremented the reference counts */
974 Py_DECREF(v);
975 Py_DECREF(w);
976 }
977 }
978 Py_INCREF(Py_NotImplemented);
979 return Py_NotImplemented;
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000980}
Guido van Rossum77660912002-04-16 16:32:50 +0000981
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000982static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000983binop_type_error(PyObject *v, PyObject *w, const char *op_name)
984{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000985 PyErr_Format(PyExc_TypeError,
986 "unsupported operand type(s) for %.100s: "
987 "'%.100s' and '%.100s'",
988 op_name,
989 v->ob_type->tp_name,
990 w->ob_type->tp_name);
991 return NULL;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000992}
993
994static PyObject *
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000995binary_op(PyObject *v, PyObject *w, const int op_slot, const char *op_name)
996{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000997 PyObject *result = binary_op1(v, w, op_slot);
998 if (result == Py_NotImplemented) {
999 Py_DECREF(result);
1000 return binop_type_error(v, w, op_name);
1001 }
1002 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +00001003}
1004
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001005
1006/*
1007 Calling scheme used for ternary operations:
1008
Guido van Rossum84675ac2001-09-29 01:05:03 +00001009 *** In some cases, w.op is called before v.op; see binary_op1. ***
1010
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001011 v w z Action
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001012 -------------------------------------------------------------------
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001013 new new new v.op(v,w,z), w.op(v,w,z), z.op(v,w,z)
1014 new old new v.op(v,w,z), z.op(v,w,z), coerce(v,w,z), v.op(v,w,z)
1015 old new new w.op(v,w,z), z.op(v,w,z), coerce(v,w,z), v.op(v,w,z)
1016 old old new z.op(v,w,z), coerce(v,w,z), v.op(v,w,z)
1017 new new old v.op(v,w,z), w.op(v,w,z), coerce(v,w,z), v.op(v,w,z)
1018 new old old v.op(v,w,z), coerce(v,w,z), v.op(v,w,z)
1019 old new old w.op(v,w,z), coerce(v,w,z), v.op(v,w,z)
1020 old old old coerce(v,w,z), v.op(v,w,z)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001021
1022 Legend:
1023 -------
1024 * new == new style number
1025 * old == old style number
1026 * Action indicates the order in which operations are tried until either
1027 a valid result is produced or an error occurs.
1028 * coerce(v,w,z) actually does: coerce(v,w), coerce(v,z), coerce(w,z) and
1029 only if z != Py_None; if z == Py_None, then it is treated as absent
1030 variable and only coerce(v,w) is tried.
1031
1032 */
1033
1034static PyObject *
1035ternary_op(PyObject *v,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001036 PyObject *w,
1037 PyObject *z,
1038 const int op_slot,
1039 const char *op_name)
Guido van Rossume15dee51995-07-18 14:12:02 +00001040{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001041 PyNumberMethods *mv, *mw, *mz;
1042 PyObject *x = NULL;
1043 ternaryfunc slotv = NULL;
1044 ternaryfunc slotw = NULL;
1045 ternaryfunc slotz = NULL;
Guido van Rossum77660912002-04-16 16:32:50 +00001046
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001047 mv = v->ob_type->tp_as_number;
1048 mw = w->ob_type->tp_as_number;
1049 if (mv != NULL && NEW_STYLE_NUMBER(v))
1050 slotv = NB_TERNOP(mv, op_slot);
1051 if (w->ob_type != v->ob_type &&
1052 mw != NULL && NEW_STYLE_NUMBER(w)) {
1053 slotw = NB_TERNOP(mw, op_slot);
1054 if (slotw == slotv)
1055 slotw = NULL;
1056 }
1057 if (slotv) {
1058 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
1059 x = slotw(v, w, z);
1060 if (x != Py_NotImplemented)
1061 return x;
1062 Py_DECREF(x); /* can't do it */
1063 slotw = NULL;
1064 }
1065 x = slotv(v, w, z);
1066 if (x != Py_NotImplemented)
1067 return x;
1068 Py_DECREF(x); /* can't do it */
1069 }
1070 if (slotw) {
1071 x = slotw(v, w, z);
1072 if (x != Py_NotImplemented)
1073 return x;
1074 Py_DECREF(x); /* can't do it */
1075 }
1076 mz = z->ob_type->tp_as_number;
1077 if (mz != NULL && NEW_STYLE_NUMBER(z)) {
1078 slotz = NB_TERNOP(mz, op_slot);
1079 if (slotz == slotv || slotz == slotw)
1080 slotz = NULL;
1081 if (slotz) {
1082 x = slotz(v, w, z);
1083 if (x != Py_NotImplemented)
1084 return x;
1085 Py_DECREF(x); /* can't do it */
1086 }
1087 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001088
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001089 if (!NEW_STYLE_NUMBER(v) || !NEW_STYLE_NUMBER(w) ||
1090 (z != Py_None && !NEW_STYLE_NUMBER(z))) {
1091 /* we have an old style operand, coerce */
1092 PyObject *v1, *z1, *w2, *z2;
1093 int c;
Guido van Rossum77660912002-04-16 16:32:50 +00001094
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001095 c = PyNumber_Coerce(&v, &w);
1096 if (c != 0)
1097 goto error3;
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001098
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001099 /* Special case: if the third argument is None, it is
1100 treated as absent argument and not coerced. */
1101 if (z == Py_None) {
1102 if (v->ob_type->tp_as_number) {
1103 slotz = NB_TERNOP(v->ob_type->tp_as_number,
1104 op_slot);
1105 if (slotz)
1106 x = slotz(v, w, z);
1107 else
1108 c = -1;
1109 }
1110 else
1111 c = -1;
1112 goto error2;
1113 }
1114 v1 = v;
1115 z1 = z;
1116 c = PyNumber_Coerce(&v1, &z1);
1117 if (c != 0)
1118 goto error2;
1119 w2 = w;
1120 z2 = z1;
1121 c = PyNumber_Coerce(&w2, &z2);
1122 if (c != 0)
1123 goto error1;
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001124
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001125 if (v1->ob_type->tp_as_number != NULL) {
1126 slotv = NB_TERNOP(v1->ob_type->tp_as_number,
1127 op_slot);
1128 if (slotv)
1129 x = slotv(v1, w2, z2);
1130 else
1131 c = -1;
1132 }
1133 else
1134 c = -1;
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001135
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001136 Py_DECREF(w2);
1137 Py_DECREF(z2);
1138 error1:
1139 Py_DECREF(v1);
1140 Py_DECREF(z1);
1141 error2:
1142 Py_DECREF(v);
1143 Py_DECREF(w);
1144 error3:
1145 if (c >= 0)
1146 return x;
1147 }
Guido van Rossum5c66a262001-10-22 04:12:44 +00001148
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001149 if (z == Py_None)
1150 PyErr_Format(
1151 PyExc_TypeError,
1152 "unsupported operand type(s) for ** or pow(): "
1153 "'%.100s' and '%.100s'",
1154 v->ob_type->tp_name,
1155 w->ob_type->tp_name);
1156 else
1157 PyErr_Format(
1158 PyExc_TypeError,
1159 "unsupported operand type(s) for pow(): "
1160 "'%.100s', '%.100s', '%.100s'",
1161 v->ob_type->tp_name,
1162 w->ob_type->tp_name,
1163 z->ob_type->tp_name);
1164 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001165}
1166
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001167#define BINARY_FUNC(func, op, op_name) \
1168 PyObject * \
1169 func(PyObject *v, PyObject *w) { \
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001170 return binary_op(v, w, NB_SLOT(op), op_name); \
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001171 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001172
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001173BINARY_FUNC(PyNumber_Or, nb_or, "|")
1174BINARY_FUNC(PyNumber_Xor, nb_xor, "^")
1175BINARY_FUNC(PyNumber_And, nb_and, "&")
1176BINARY_FUNC(PyNumber_Lshift, nb_lshift, "<<")
1177BINARY_FUNC(PyNumber_Rshift, nb_rshift, ">>")
1178BINARY_FUNC(PyNumber_Subtract, nb_subtract, "-")
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001179BINARY_FUNC(PyNumber_Divide, nb_divide, "/")
1180BINARY_FUNC(PyNumber_Divmod, nb_divmod, "divmod()")
Guido van Rossume15dee51995-07-18 14:12:02 +00001181
1182PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001183PyNumber_Add(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +00001184{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001185 PyObject *result = binary_op1(v, w, NB_SLOT(nb_add));
1186 if (result == Py_NotImplemented) {
1187 PySequenceMethods *m = v->ob_type->tp_as_sequence;
1188 Py_DECREF(result);
1189 if (m && m->sq_concat) {
1190 return (*m->sq_concat)(v, w);
1191 }
1192 result = binop_type_error(v, w, "+");
1193 }
1194 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +00001195}
1196
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001197static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001198sequence_repeat(ssizeargfunc repeatfunc, PyObject *seq, PyObject *n)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001199{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001200 Py_ssize_t count;
1201 if (PyIndex_Check(n)) {
1202 count = PyNumber_AsSsize_t(n, PyExc_OverflowError);
1203 if (count == -1 && PyErr_Occurred())
1204 return NULL;
1205 }
1206 else {
1207 return type_error("can't multiply sequence by "
1208 "non-int of type '%.200s'", n);
1209 }
1210 return (*repeatfunc)(seq, count);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001211}
1212
1213PyObject *
1214PyNumber_Multiply(PyObject *v, PyObject *w)
1215{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001216 PyObject *result = binary_op1(v, w, NB_SLOT(nb_multiply));
1217 if (result == Py_NotImplemented) {
1218 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
1219 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
1220 Py_DECREF(result);
1221 if (mv && mv->sq_repeat) {
1222 return sequence_repeat(mv->sq_repeat, v, w);
1223 }
1224 else if (mw && mw->sq_repeat) {
1225 return sequence_repeat(mw->sq_repeat, w, v);
1226 }
1227 result = binop_type_error(v, w, "*");
1228 }
1229 return result;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001230}
1231
Guido van Rossume15dee51995-07-18 14:12:02 +00001232PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +00001233PyNumber_FloorDivide(PyObject *v, PyObject *w)
1234{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001235 /* XXX tp_flags test */
1236 return binary_op(v, w, NB_SLOT(nb_floor_divide), "//");
Guido van Rossum4668b002001-08-08 05:00:18 +00001237}
1238
1239PyObject *
1240PyNumber_TrueDivide(PyObject *v, PyObject *w)
1241{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001242 /* XXX tp_flags test */
1243 return binary_op(v, w, NB_SLOT(nb_true_divide), "/");
Guido van Rossum4668b002001-08-08 05:00:18 +00001244}
1245
1246PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001247PyNumber_Remainder(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +00001248{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001249 return binary_op(v, w, NB_SLOT(nb_remainder), "%");
Guido van Rossume15dee51995-07-18 14:12:02 +00001250}
1251
1252PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001253PyNumber_Power(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossume15dee51995-07-18 14:12:02 +00001254{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001255 return ternary_op(v, w, z, NB_SLOT(nb_power), "** or pow()");
Guido van Rossume15dee51995-07-18 14:12:02 +00001256}
1257
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001258/* Binary in-place operators */
1259
1260/* The in-place operators are defined to fall back to the 'normal',
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001261 non in-place operations, if the in-place methods are not in place.
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001262
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001263 - If the left hand object has the appropriate struct members, and
1264 they are filled, call the appropriate function and return the
1265 result. No coercion is done on the arguments; the left-hand object
1266 is the one the operation is performed on, and it's up to the
1267 function to deal with the right-hand object.
Guido van Rossum77660912002-04-16 16:32:50 +00001268
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001269 - Otherwise, in-place modification is not supported. Handle it exactly as
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001270 a non in-place operation of the same kind.
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001271
1272 */
1273
Guido van Rossum77660912002-04-16 16:32:50 +00001274#define HASINPLACE(t) \
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001275 PyType_HasFeature((t)->ob_type, Py_TPFLAGS_HAVE_INPLACEOPS)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001276
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001277static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001278binary_iop1(PyObject *v, PyObject *w, const int iop_slot, const int op_slot)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001279{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001280 PyNumberMethods *mv = v->ob_type->tp_as_number;
1281 if (mv != NULL && HASINPLACE(v)) {
1282 binaryfunc slot = NB_BINOP(mv, iop_slot);
1283 if (slot) {
1284 PyObject *x = (slot)(v, w);
1285 if (x != Py_NotImplemented) {
1286 return x;
1287 }
1288 Py_DECREF(x);
1289 }
1290 }
1291 return binary_op1(v, w, op_slot);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001292}
1293
1294static PyObject *
1295binary_iop(PyObject *v, PyObject *w, const int iop_slot, const int op_slot,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001296 const char *op_name)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001297{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001298 PyObject *result = binary_iop1(v, w, iop_slot, op_slot);
1299 if (result == Py_NotImplemented) {
1300 Py_DECREF(result);
1301 return binop_type_error(v, w, op_name);
1302 }
1303 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001304}
1305
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001306#define INPLACE_BINOP(func, iop, op, op_name) \
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001307 PyObject * \
1308 func(PyObject *v, PyObject *w) { \
1309 return binary_iop(v, w, NB_SLOT(iop), NB_SLOT(op), op_name); \
1310 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001311
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001312INPLACE_BINOP(PyNumber_InPlaceOr, nb_inplace_or, nb_or, "|=")
1313INPLACE_BINOP(PyNumber_InPlaceXor, nb_inplace_xor, nb_xor, "^=")
1314INPLACE_BINOP(PyNumber_InPlaceAnd, nb_inplace_and, nb_and, "&=")
1315INPLACE_BINOP(PyNumber_InPlaceLshift, nb_inplace_lshift, nb_lshift, "<<=")
1316INPLACE_BINOP(PyNumber_InPlaceRshift, nb_inplace_rshift, nb_rshift, ">>=")
1317INPLACE_BINOP(PyNumber_InPlaceSubtract, nb_inplace_subtract, nb_subtract, "-=")
1318INPLACE_BINOP(PyNumber_InPlaceDivide, nb_inplace_divide, nb_divide, "/=")
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001319
1320PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +00001321PyNumber_InPlaceFloorDivide(PyObject *v, PyObject *w)
1322{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001323 /* XXX tp_flags test */
1324 return binary_iop(v, w, NB_SLOT(nb_inplace_floor_divide),
1325 NB_SLOT(nb_floor_divide), "//=");
Guido van Rossum4668b002001-08-08 05:00:18 +00001326}
1327
1328PyObject *
1329PyNumber_InPlaceTrueDivide(PyObject *v, PyObject *w)
1330{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001331 /* XXX tp_flags test */
1332 return binary_iop(v, w, NB_SLOT(nb_inplace_true_divide),
1333 NB_SLOT(nb_true_divide), "/=");
Guido van Rossum4668b002001-08-08 05:00:18 +00001334}
1335
1336PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001337PyNumber_InPlaceAdd(PyObject *v, PyObject *w)
1338{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001339 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_add),
1340 NB_SLOT(nb_add));
1341 if (result == Py_NotImplemented) {
1342 PySequenceMethods *m = v->ob_type->tp_as_sequence;
1343 Py_DECREF(result);
1344 if (m != NULL) {
1345 binaryfunc f = NULL;
1346 if (HASINPLACE(v))
1347 f = m->sq_inplace_concat;
1348 if (f == NULL)
1349 f = m->sq_concat;
1350 if (f != NULL)
1351 return (*f)(v, w);
1352 }
1353 result = binop_type_error(v, w, "+=");
1354 }
1355 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001356}
1357
1358PyObject *
1359PyNumber_InPlaceMultiply(PyObject *v, PyObject *w)
1360{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001361 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_multiply),
1362 NB_SLOT(nb_multiply));
1363 if (result == Py_NotImplemented) {
1364 ssizeargfunc f = NULL;
1365 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
1366 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
1367 Py_DECREF(result);
1368 if (mv != NULL) {
1369 if (HASINPLACE(v))
1370 f = mv->sq_inplace_repeat;
1371 if (f == NULL)
1372 f = mv->sq_repeat;
1373 if (f != NULL)
1374 return sequence_repeat(f, v, w);
1375 }
1376 else if (mw != NULL) {
1377 /* Note that the right hand operand should not be
1378 * mutated in this case so sq_inplace_repeat is not
1379 * used. */
1380 if (mw->sq_repeat)
1381 return sequence_repeat(mw->sq_repeat, w, v);
1382 }
1383 result = binop_type_error(v, w, "*=");
1384 }
1385 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001386}
1387
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001388PyObject *
1389PyNumber_InPlaceRemainder(PyObject *v, PyObject *w)
1390{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001391 return binary_iop(v, w, NB_SLOT(nb_inplace_remainder),
1392 NB_SLOT(nb_remainder), "%=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001393}
1394
1395PyObject *
1396PyNumber_InPlacePower(PyObject *v, PyObject *w, PyObject *z)
1397{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001398 if (HASINPLACE(v) && v->ob_type->tp_as_number &&
1399 v->ob_type->tp_as_number->nb_inplace_power != NULL) {
1400 return ternary_op(v, w, z, NB_SLOT(nb_inplace_power), "**=");
1401 }
1402 else {
1403 return ternary_op(v, w, z, NB_SLOT(nb_power), "**=");
1404 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001405}
1406
1407
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001408/* Unary operators and functions */
Guido van Rossume15dee51995-07-18 14:12:02 +00001409
1410PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001411PyNumber_Negative(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001412{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001413 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001414
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001415 if (o == NULL)
1416 return null_error();
1417 m = o->ob_type->tp_as_number;
1418 if (m && m->nb_negative)
1419 return (*m->nb_negative)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001420
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001421 return type_error("bad operand type for unary -: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001422}
1423
1424PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001425PyNumber_Positive(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001426{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001427 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001428
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001429 if (o == NULL)
1430 return null_error();
1431 m = o->ob_type->tp_as_number;
1432 if (m && m->nb_positive)
1433 return (*m->nb_positive)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001434
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001435 return type_error("bad operand type for unary +: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001436}
1437
1438PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001439PyNumber_Invert(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001440{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001441 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001442
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001443 if (o == NULL)
1444 return null_error();
1445 m = o->ob_type->tp_as_number;
1446 if (m && m->nb_invert)
1447 return (*m->nb_invert)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001448
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001449 return type_error("bad operand type for unary ~: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001450}
1451
1452PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001453PyNumber_Absolute(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001454{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001455 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001456
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001457 if (o == NULL)
1458 return null_error();
1459 m = o->ob_type->tp_as_number;
1460 if (m && m->nb_absolute)
1461 return m->nb_absolute(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001462
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001463 return type_error("bad operand type for abs(): '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001464}
1465
Guido van Rossum9e896b32000-04-05 20:11:21 +00001466/* Add a check for embedded NULL-bytes in the argument. */
1467static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001468int_from_string(const char *s, Py_ssize_t len)
Guido van Rossum9e896b32000-04-05 20:11:21 +00001469{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001470 char *end;
1471 PyObject *x;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001472
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001473 x = PyInt_FromString((char*)s, &end, 10);
1474 if (x == NULL)
1475 return NULL;
1476 if (end != s + len) {
1477 PyErr_SetString(PyExc_ValueError,
1478 "null byte in argument for int()");
1479 Py_DECREF(x);
1480 return NULL;
1481 }
1482 return x;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001483}
1484
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001485/* Return a Python Int or Long from the object item
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00001486 Raise TypeError if the result is not an int-or-long
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001487 or if the object cannot be interpreted as an index.
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00001488*/
1489PyObject *
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001490PyNumber_Index(PyObject *item)
1491{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001492 PyObject *result = NULL;
1493 if (item == NULL)
1494 return null_error();
1495 if (PyInt_Check(item) || PyLong_Check(item)) {
1496 Py_INCREF(item);
1497 return item;
1498 }
1499 if (PyIndex_Check(item)) {
1500 result = item->ob_type->tp_as_number->nb_index(item);
1501 if (result &&
1502 !PyInt_Check(result) && !PyLong_Check(result)) {
1503 PyErr_Format(PyExc_TypeError,
1504 "__index__ returned non-(int,long) " \
1505 "(type %.200s)",
1506 result->ob_type->tp_name);
1507 Py_DECREF(result);
1508 return NULL;
1509 }
1510 }
1511 else {
1512 PyErr_Format(PyExc_TypeError,
1513 "'%.200s' object cannot be interpreted "
1514 "as an index", item->ob_type->tp_name);
1515 }
1516 return result;
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001517}
1518
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00001519/* Return an error on Overflow only if err is not NULL*/
1520
1521Py_ssize_t
1522PyNumber_AsSsize_t(PyObject *item, PyObject *err)
1523{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001524 Py_ssize_t result;
1525 PyObject *runerr;
1526 PyObject *value = PyNumber_Index(item);
1527 if (value == NULL)
1528 return -1;
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00001529
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001530 /* We're done if PyInt_AsSsize_t() returns without error. */
1531 result = PyInt_AsSsize_t(value);
1532 if (result != -1 || !(runerr = PyErr_Occurred()))
1533 goto finish;
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00001534
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001535 /* Error handling code -- only manage OverflowError differently */
1536 if (!PyErr_GivenExceptionMatches(runerr, PyExc_OverflowError))
1537 goto finish;
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00001538
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001539 PyErr_Clear();
1540 /* If no error-handling desired then the default clipping
1541 is sufficient.
1542 */
1543 if (!err) {
1544 assert(PyLong_Check(value));
1545 /* Whether or not it is less than or equal to
1546 zero is determined by the sign of ob_size
1547 */
1548 if (_PyLong_Sign(value) < 0)
1549 result = PY_SSIZE_T_MIN;
1550 else
1551 result = PY_SSIZE_T_MAX;
1552 }
1553 else {
1554 /* Otherwise replace the error with caller's error object. */
1555 PyErr_Format(err,
1556 "cannot fit '%.200s' into an index-sized integer",
1557 item->ob_type->tp_name);
1558 }
1559
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00001560 finish:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001561 Py_DECREF(value);
1562 return result;
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00001563}
1564
1565
Guido van Rossume15dee51995-07-18 14:12:02 +00001566PyObject *
Jeffrey Yasskina26cf9b2008-02-04 01:04:35 +00001567_PyNumber_ConvertIntegralToInt(PyObject *integral, const char* error_format)
1568{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001569 const char *type_name;
1570 static PyObject *int_name = NULL;
1571 if (int_name == NULL) {
1572 int_name = PyString_InternFromString("__int__");
1573 if (int_name == NULL)
1574 return NULL;
1575 }
Jeffrey Yasskina26cf9b2008-02-04 01:04:35 +00001576
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001577 if (integral && (!PyInt_Check(integral) &&
1578 !PyLong_Check(integral))) {
1579 /* Don't go through tp_as_number->nb_int to avoid
1580 hitting the classic class fallback to __trunc__. */
1581 PyObject *int_func = PyObject_GetAttr(integral, int_name);
1582 if (int_func == NULL) {
1583 PyErr_Clear(); /* Raise a different error. */
1584 goto non_integral_error;
1585 }
1586 Py_DECREF(integral);
1587 integral = PyEval_CallObject(int_func, NULL);
1588 Py_DECREF(int_func);
1589 if (integral && (!PyInt_Check(integral) &&
1590 !PyLong_Check(integral))) {
1591 goto non_integral_error;
1592 }
1593 }
1594 return integral;
Jeffrey Yasskina26cf9b2008-02-04 01:04:35 +00001595
1596non_integral_error:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001597 if (PyInstance_Check(integral)) {
1598 type_name = PyString_AS_STRING(((PyInstanceObject *)integral)
1599 ->in_class->cl_name);
1600 }
1601 else {
1602 type_name = integral->ob_type->tp_name;
1603 }
1604 PyErr_Format(PyExc_TypeError, error_format, type_name);
1605 Py_DECREF(integral);
1606 return NULL;
Jeffrey Yasskina26cf9b2008-02-04 01:04:35 +00001607}
1608
1609
1610PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001611PyNumber_Int(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001612{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001613 PyNumberMethods *m;
1614 static PyObject *trunc_name = NULL;
1615 PyObject *trunc_func;
1616 const char *buffer;
1617 Py_ssize_t buffer_len;
Guido van Rossume15dee51995-07-18 14:12:02 +00001618
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001619 if (trunc_name == NULL) {
1620 trunc_name = PyString_InternFromString("__trunc__");
1621 if (trunc_name == NULL)
1622 return NULL;
1623 }
Jeffrey Yasskina26cf9b2008-02-04 01:04:35 +00001624
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001625 if (o == NULL)
1626 return null_error();
1627 if (PyInt_CheckExact(o)) {
1628 Py_INCREF(o);
1629 return o;
1630 }
1631 m = o->ob_type->tp_as_number;
1632 if (m && m->nb_int) { /* This should include subclasses of int */
1633 /* Classic classes always take this branch. */
1634 PyObject *res = m->nb_int(o);
1635 if (res && (!PyInt_Check(res) && !PyLong_Check(res))) {
1636 PyErr_Format(PyExc_TypeError,
1637 "__int__ returned non-int (type %.200s)",
1638 res->ob_type->tp_name);
1639 Py_DECREF(res);
1640 return NULL;
1641 }
1642 return res;
1643 }
1644 if (PyInt_Check(o)) { /* A int subclass without nb_int */
1645 PyIntObject *io = (PyIntObject*)o;
1646 return PyInt_FromLong(io->ob_ival);
1647 }
1648 trunc_func = PyObject_GetAttr(o, trunc_name);
1649 if (trunc_func) {
1650 PyObject *truncated = PyEval_CallObject(trunc_func, NULL);
1651 Py_DECREF(trunc_func);
1652 /* __trunc__ is specified to return an Integral type, but
1653 int() needs to return an int. */
1654 return _PyNumber_ConvertIntegralToInt(
1655 truncated,
1656 "__trunc__ returned non-Integral (type %.200s)");
1657 }
1658 PyErr_Clear(); /* It's not an error if o.__trunc__ doesn't exist. */
Jeffrey Yasskina26cf9b2008-02-04 01:04:35 +00001659
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001660 if (PyString_Check(o))
1661 return int_from_string(PyString_AS_STRING(o),
1662 PyString_GET_SIZE(o));
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001663#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001664 if (PyUnicode_Check(o))
1665 return PyInt_FromUnicode(PyUnicode_AS_UNICODE(o),
1666 PyUnicode_GET_SIZE(o),
1667 10);
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001668#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001669 if (!PyObject_AsCharBuffer(o, &buffer, &buffer_len))
1670 return int_from_string((char*)buffer, buffer_len);
Guido van Rossume15dee51995-07-18 14:12:02 +00001671
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001672 return type_error("int() argument must be a string or a "
1673 "number, not '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001674}
1675
Guido van Rossum9e896b32000-04-05 20:11:21 +00001676/* Add a check for embedded NULL-bytes in the argument. */
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001677static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001678long_from_string(const char *s, Py_ssize_t len)
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001679{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001680 char *end;
1681 PyObject *x;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001682
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001683 x = PyLong_FromString((char*)s, &end, 10);
1684 if (x == NULL)
1685 return NULL;
1686 if (end != s + len) {
1687 PyErr_SetString(PyExc_ValueError,
1688 "null byte in argument for long()");
1689 Py_DECREF(x);
1690 return NULL;
1691 }
1692 return x;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001693}
1694
Guido van Rossume15dee51995-07-18 14:12:02 +00001695PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001696PyNumber_Long(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001697{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001698 PyNumberMethods *m;
1699 static PyObject *trunc_name = NULL;
1700 PyObject *trunc_func;
1701 const char *buffer;
1702 Py_ssize_t buffer_len;
Guido van Rossume15dee51995-07-18 14:12:02 +00001703
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001704 if (trunc_name == NULL) {
1705 trunc_name = PyString_InternFromString("__trunc__");
1706 if (trunc_name == NULL)
1707 return NULL;
1708 }
Jeffrey Yasskina26cf9b2008-02-04 01:04:35 +00001709
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001710 if (o == NULL)
1711 return null_error();
1712 m = o->ob_type->tp_as_number;
1713 if (m && m->nb_long) { /* This should include subclasses of long */
1714 /* Classic classes always take this branch. */
1715 PyObject *res = m->nb_long(o);
1716 if (res && (!PyInt_Check(res) && !PyLong_Check(res))) {
1717 PyErr_Format(PyExc_TypeError,
1718 "__long__ returned non-long (type %.200s)",
1719 res->ob_type->tp_name);
1720 Py_DECREF(res);
1721 return NULL;
1722 }
1723 return res;
1724 }
1725 if (PyLong_Check(o)) /* A long subclass without nb_long */
1726 return _PyLong_Copy((PyLongObject *)o);
1727 trunc_func = PyObject_GetAttr(o, trunc_name);
1728 if (trunc_func) {
1729 PyObject *truncated = PyEval_CallObject(trunc_func, NULL);
1730 PyObject *int_instance;
1731 Py_DECREF(trunc_func);
1732 /* __trunc__ is specified to return an Integral type,
1733 but long() needs to return a long. */
1734 int_instance = _PyNumber_ConvertIntegralToInt(
1735 truncated,
1736 "__trunc__ returned non-Integral (type %.200s)");
1737 if (int_instance && PyInt_Check(int_instance)) {
1738 /* Make sure that long() returns a long instance. */
1739 long value = PyInt_AS_LONG(int_instance);
1740 Py_DECREF(int_instance);
1741 return PyLong_FromLong(value);
1742 }
1743 return int_instance;
1744 }
1745 PyErr_Clear(); /* It's not an error if o.__trunc__ doesn't exist. */
Jeffrey Yasskina26cf9b2008-02-04 01:04:35 +00001746
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001747 if (PyString_Check(o))
1748 /* need to do extra error checking that PyLong_FromString()
1749 * doesn't do. In particular long('9.5') must raise an
1750 * exception, not truncate the float.
1751 */
1752 return long_from_string(PyString_AS_STRING(o),
1753 PyString_GET_SIZE(o));
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001754#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001755 if (PyUnicode_Check(o))
1756 /* The above check is done in PyLong_FromUnicode(). */
1757 return PyLong_FromUnicode(PyUnicode_AS_UNICODE(o),
1758 PyUnicode_GET_SIZE(o),
1759 10);
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001760#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001761 if (!PyObject_AsCharBuffer(o, &buffer, &buffer_len))
1762 return long_from_string(buffer, buffer_len);
Guido van Rossume15dee51995-07-18 14:12:02 +00001763
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001764 return type_error("long() argument must be a string or a "
1765 "number, not '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001766}
1767
1768PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001769PyNumber_Float(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001770{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001771 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001772
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001773 if (o == NULL)
1774 return null_error();
1775 m = o->ob_type->tp_as_number;
1776 if (m && m->nb_float) { /* This should include subclasses of float */
1777 PyObject *res = m->nb_float(o);
1778 if (res && !PyFloat_Check(res)) {
1779 PyErr_Format(PyExc_TypeError,
1780 "__float__ returned non-float (type %.200s)",
1781 res->ob_type->tp_name);
1782 Py_DECREF(res);
1783 return NULL;
1784 }
1785 return res;
1786 }
1787 if (PyFloat_Check(o)) { /* A float subclass with nb_float == NULL */
1788 PyFloatObject *po = (PyFloatObject *)o;
1789 return PyFloat_FromDouble(po->ob_fval);
1790 }
1791 return PyFloat_FromString(o, NULL);
Guido van Rossume15dee51995-07-18 14:12:02 +00001792}
1793
Eric Smith5e527eb2008-02-10 01:36:53 +00001794PyObject *
1795PyNumber_ToBase(PyObject *n, int base)
1796{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001797 PyObject *res = NULL;
1798 PyObject *index = PyNumber_Index(n);
Eric Smith5e527eb2008-02-10 01:36:53 +00001799
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001800 if (!index)
1801 return NULL;
1802 if (PyLong_Check(index))
1803 res = _PyLong_Format(index, base, 0, 1);
1804 else if (PyInt_Check(index))
1805 res = _PyInt_Format((PyIntObject*)index, base, 1);
1806 else
1807 /* It should not be possible to get here, as
1808 PyNumber_Index already has a check for the same
1809 condition */
1810 PyErr_SetString(PyExc_ValueError, "PyNumber_ToBase: index not "
1811 "int or long");
1812 Py_DECREF(index);
1813 return res;
Eric Smith5e527eb2008-02-10 01:36:53 +00001814}
1815
1816
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001817/* Operations on sequences */
Guido van Rossume15dee51995-07-18 14:12:02 +00001818
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001819int
Fred Drake79912472000-07-09 04:06:11 +00001820PySequence_Check(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001821{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001822 if (s == NULL)
1823 return 0;
1824 if (PyInstance_Check(s))
1825 return PyObject_HasAttrString(s, "__getitem__");
1826 if (PyDict_Check(s))
1827 return 0;
1828 return s->ob_type->tp_as_sequence &&
1829 s->ob_type->tp_as_sequence->sq_item != NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001830}
1831
Martin v. Löwis18e16552006-02-15 17:27:45 +00001832Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001833PySequence_Size(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001834{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001835 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001836
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001837 if (s == NULL) {
1838 null_error();
1839 return -1;
1840 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001841
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001842 m = s->ob_type->tp_as_sequence;
1843 if (m && m->sq_length)
1844 return m->sq_length(s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001845
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001846 type_error("object of type '%.200s' has no len()", s);
1847 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001848}
1849
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001850#undef PySequence_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001851Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001852PySequence_Length(PyObject *s)
1853{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001854 return PySequence_Size(s);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001855}
1856#define PySequence_Length PySequence_Size
1857
Guido van Rossume15dee51995-07-18 14:12:02 +00001858PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001859PySequence_Concat(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001860{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001861 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001862
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001863 if (s == NULL || o == NULL)
1864 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001865
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001866 m = s->ob_type->tp_as_sequence;
1867 if (m && m->sq_concat)
1868 return m->sq_concat(s, o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001869
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001870 /* Instances of user classes defining an __add__() method only
1871 have an nb_add slot, not an sq_concat slot. So we fall back
1872 to nb_add if both arguments appear to be sequences. */
1873 if (PySequence_Check(s) && PySequence_Check(o)) {
1874 PyObject *result = binary_op1(s, o, NB_SLOT(nb_add));
1875 if (result != Py_NotImplemented)
1876 return result;
1877 Py_DECREF(result);
1878 }
1879 return type_error("'%.200s' object can't be concatenated", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001880}
1881
1882PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001883PySequence_Repeat(PyObject *o, Py_ssize_t count)
Guido van Rossume15dee51995-07-18 14:12:02 +00001884{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001885 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001886
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001887 if (o == NULL)
1888 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001889
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001890 m = o->ob_type->tp_as_sequence;
1891 if (m && m->sq_repeat)
1892 return m->sq_repeat(o, count);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001893
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001894 /* Instances of user classes defining a __mul__() method only
1895 have an nb_multiply slot, not an sq_repeat slot. so we fall back
1896 to nb_multiply if o appears to be a sequence. */
1897 if (PySequence_Check(o)) {
1898 PyObject *n, *result;
1899 n = PyInt_FromSsize_t(count);
1900 if (n == NULL)
1901 return NULL;
1902 result = binary_op1(o, n, NB_SLOT(nb_multiply));
1903 Py_DECREF(n);
1904 if (result != Py_NotImplemented)
1905 return result;
1906 Py_DECREF(result);
1907 }
1908 return type_error("'%.200s' object can't be repeated", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001909}
1910
1911PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001912PySequence_InPlaceConcat(PyObject *s, PyObject *o)
1913{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001914 PySequenceMethods *m;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001915
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001916 if (s == NULL || o == NULL)
1917 return null_error();
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001918
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001919 m = s->ob_type->tp_as_sequence;
1920 if (m && HASINPLACE(s) && m->sq_inplace_concat)
1921 return m->sq_inplace_concat(s, o);
1922 if (m && m->sq_concat)
1923 return m->sq_concat(s, o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001924
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001925 if (PySequence_Check(s) && PySequence_Check(o)) {
1926 PyObject *result = binary_iop1(s, o, NB_SLOT(nb_inplace_add),
1927 NB_SLOT(nb_add));
1928 if (result != Py_NotImplemented)
1929 return result;
1930 Py_DECREF(result);
1931 }
1932 return type_error("'%.200s' object can't be concatenated", s);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001933}
1934
1935PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001936PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001937{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001938 PySequenceMethods *m;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001939
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001940 if (o == NULL)
1941 return null_error();
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001942
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001943 m = o->ob_type->tp_as_sequence;
1944 if (m && HASINPLACE(o) && m->sq_inplace_repeat)
1945 return m->sq_inplace_repeat(o, count);
1946 if (m && m->sq_repeat)
1947 return m->sq_repeat(o, count);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001948
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001949 if (PySequence_Check(o)) {
1950 PyObject *n, *result;
1951 n = PyInt_FromSsize_t(count);
1952 if (n == NULL)
1953 return NULL;
1954 result = binary_iop1(o, n, NB_SLOT(nb_inplace_multiply),
1955 NB_SLOT(nb_multiply));
1956 Py_DECREF(n);
1957 if (result != Py_NotImplemented)
1958 return result;
1959 Py_DECREF(result);
1960 }
1961 return type_error("'%.200s' object can't be repeated", o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001962}
1963
1964PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001965PySequence_GetItem(PyObject *s, Py_ssize_t i)
Guido van Rossume15dee51995-07-18 14:12:02 +00001966{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001967 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001968
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001969 if (s == NULL)
1970 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001971
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001972 m = s->ob_type->tp_as_sequence;
1973 if (m && m->sq_item) {
1974 if (i < 0) {
1975 if (m->sq_length) {
1976 Py_ssize_t l = (*m->sq_length)(s);
1977 if (l < 0)
1978 return NULL;
1979 i += l;
1980 }
1981 }
1982 return m->sq_item(s, i);
1983 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001984
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001985 return type_error("'%.200s' object does not support indexing", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001986}
1987
1988PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001989PySequence_GetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossume15dee51995-07-18 14:12:02 +00001990{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001991 PySequenceMethods *m;
1992 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001993
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001994 if (!s) return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001995
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001996 m = s->ob_type->tp_as_sequence;
1997 if (m && m->sq_slice) {
1998 if (i1 < 0 || i2 < 0) {
1999 if (m->sq_length) {
2000 Py_ssize_t l = (*m->sq_length)(s);
2001 if (l < 0)
2002 return NULL;
2003 if (i1 < 0)
2004 i1 += l;
2005 if (i2 < 0)
2006 i2 += l;
2007 }
2008 }
2009 return m->sq_slice(s, i1, i2);
2010 } else if ((mp = s->ob_type->tp_as_mapping) && mp->mp_subscript) {
2011 PyObject *res;
2012 PyObject *slice = _PySlice_FromIndices(i1, i2);
2013 if (!slice)
2014 return NULL;
2015 res = mp->mp_subscript(s, slice);
2016 Py_DECREF(slice);
2017 return res;
2018 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002019
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002020 return type_error("'%.200s' object is unsliceable", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00002021}
2022
2023int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002024PySequence_SetItem(PyObject *s, Py_ssize_t i, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002025{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002026 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00002027
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002028 if (s == NULL) {
2029 null_error();
2030 return -1;
2031 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002032
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002033 m = s->ob_type->tp_as_sequence;
2034 if (m && m->sq_ass_item) {
2035 if (i < 0) {
2036 if (m->sq_length) {
2037 Py_ssize_t l = (*m->sq_length)(s);
2038 if (l < 0)
2039 return -1;
2040 i += l;
2041 }
2042 }
2043 return m->sq_ass_item(s, i, o);
2044 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002045
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002046 type_error("'%.200s' object does not support item assignment", s);
2047 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00002048}
2049
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00002050int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002051PySequence_DelItem(PyObject *s, Py_ssize_t i)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00002052{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002053 PySequenceMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00002054
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002055 if (s == NULL) {
2056 null_error();
2057 return -1;
2058 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00002059
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002060 m = s->ob_type->tp_as_sequence;
2061 if (m && m->sq_ass_item) {
2062 if (i < 0) {
2063 if (m->sq_length) {
2064 Py_ssize_t l = (*m->sq_length)(s);
2065 if (l < 0)
2066 return -1;
2067 i += l;
2068 }
2069 }
2070 return m->sq_ass_item(s, i, (PyObject *)NULL);
2071 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002072
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002073 type_error("'%.200s' object doesn't support item deletion", s);
2074 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00002075}
2076
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002077int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002078PySequence_SetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002079{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002080 PySequenceMethods *m;
2081 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00002082
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002083 if (s == NULL) {
2084 null_error();
2085 return -1;
2086 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002087
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002088 m = s->ob_type->tp_as_sequence;
2089 if (m && m->sq_ass_slice) {
2090 if (i1 < 0 || i2 < 0) {
2091 if (m->sq_length) {
2092 Py_ssize_t l = (*m->sq_length)(s);
2093 if (l < 0)
2094 return -1;
2095 if (i1 < 0)
2096 i1 += l;
2097 if (i2 < 0)
2098 i2 += l;
2099 }
2100 }
2101 return m->sq_ass_slice(s, i1, i2, o);
2102 } else if ((mp = s->ob_type->tp_as_mapping) && mp->mp_ass_subscript) {
2103 int res;
2104 PyObject *slice = _PySlice_FromIndices(i1, i2);
2105 if (!slice)
2106 return -1;
2107 res = mp->mp_ass_subscript(s, slice, o);
2108 Py_DECREF(slice);
2109 return res;
2110 }
Thomas Wouters1d75a792000-08-17 22:37:32 +00002111
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002112 type_error("'%.200s' object doesn't support slice assignment", s);
2113 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00002114}
2115
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002116int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002117PySequence_DelSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00002118{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002119 PySequenceMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00002120
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002121 if (s == NULL) {
2122 null_error();
2123 return -1;
2124 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00002125
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002126 m = s->ob_type->tp_as_sequence;
2127 if (m && m->sq_ass_slice) {
2128 if (i1 < 0 || i2 < 0) {
2129 if (m->sq_length) {
2130 Py_ssize_t l = (*m->sq_length)(s);
2131 if (l < 0)
2132 return -1;
2133 if (i1 < 0)
2134 i1 += l;
2135 if (i2 < 0)
2136 i2 += l;
2137 }
2138 }
2139 return m->sq_ass_slice(s, i1, i2, (PyObject *)NULL);
2140 }
2141 type_error("'%.200s' object doesn't support slice deletion", s);
2142 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00002143}
2144
Guido van Rossume15dee51995-07-18 14:12:02 +00002145PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002146PySequence_Tuple(PyObject *v)
Guido van Rossume15dee51995-07-18 14:12:02 +00002147{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002148 PyObject *it; /* iter(v) */
2149 Py_ssize_t n; /* guess for result tuple size */
2150 PyObject *result = NULL;
2151 Py_ssize_t j;
Guido van Rossume15dee51995-07-18 14:12:02 +00002152
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002153 if (v == NULL)
2154 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002155
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002156 /* Special-case the common tuple and list cases, for efficiency. */
2157 if (PyTuple_CheckExact(v)) {
2158 /* Note that we can't know whether it's safe to return
2159 a tuple *subclass* instance as-is, hence the restriction
2160 to exact tuples here. In contrast, lists always make
2161 a copy, so there's no need for exactness below. */
2162 Py_INCREF(v);
2163 return v;
2164 }
2165 if (PyList_Check(v))
2166 return PyList_AsTuple(v);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002167
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002168 /* Get iterator. */
2169 it = PyObject_GetIter(v);
2170 if (it == NULL)
2171 return NULL;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002172
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002173 /* Guess result size and allocate space. */
2174 n = _PyObject_LengthHint(v, 10);
2175 if (n == -1)
2176 goto Fail;
2177 result = PyTuple_New(n);
2178 if (result == NULL)
2179 goto Fail;
Tim Peters6912d4d2001-05-05 03:56:37 +00002180
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002181 /* Fill the tuple. */
2182 for (j = 0; ; ++j) {
2183 PyObject *item = PyIter_Next(it);
2184 if (item == NULL) {
2185 if (PyErr_Occurred())
2186 goto Fail;
2187 break;
2188 }
2189 if (j >= n) {
2190 Py_ssize_t oldn = n;
2191 /* The over-allocation strategy can grow a bit faster
2192 than for lists because unlike lists the
2193 over-allocation isn't permanent -- we reclaim
2194 the excess before the end of this routine.
2195 So, grow by ten and then add 25%.
2196 */
2197 n += 10;
2198 n += n >> 2;
2199 if (n < oldn) {
2200 /* Check for overflow */
2201 PyErr_NoMemory();
2202 Py_DECREF(item);
2203 goto Fail;
2204 }
2205 if (_PyTuple_Resize(&result, n) != 0) {
2206 Py_DECREF(item);
2207 goto Fail;
2208 }
2209 }
2210 PyTuple_SET_ITEM(result, j, item);
2211 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002212
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002213 /* Cut tuple back if guess was too large. */
2214 if (j < n &&
2215 _PyTuple_Resize(&result, j) != 0)
2216 goto Fail;
Tim Peters6912d4d2001-05-05 03:56:37 +00002217
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002218 Py_DECREF(it);
2219 return result;
Tim Peters6912d4d2001-05-05 03:56:37 +00002220
2221Fail:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002222 Py_XDECREF(result);
2223 Py_DECREF(it);
2224 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002225}
2226
Guido van Rossum3c5936a1996-12-05 21:51:24 +00002227PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002228PySequence_List(PyObject *v)
Guido van Rossum3c5936a1996-12-05 21:51:24 +00002229{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002230 PyObject *result; /* result list */
2231 PyObject *rv; /* return value from PyList_Extend */
Guido van Rossum4669fb41997-04-02 05:31:09 +00002232
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002233 if (v == NULL)
2234 return null_error();
Guido van Rossum5dba9e81998-07-10 18:03:50 +00002235
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002236 result = PyList_New(0);
2237 if (result == NULL)
2238 return NULL;
Tim Petersf553f892001-05-01 20:45:31 +00002239
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002240 rv = _PyList_Extend((PyListObject *)result, v);
2241 if (rv == NULL) {
2242 Py_DECREF(result);
2243 return NULL;
2244 }
2245 Py_DECREF(rv);
2246 return result;
Guido van Rossum3c5936a1996-12-05 21:51:24 +00002247}
2248
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00002249PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002250PySequence_Fast(PyObject *v, const char *m)
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00002251{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002252 PyObject *it;
Raymond Hettinger2fb70292004-01-11 23:26:51 +00002253
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002254 if (v == NULL)
2255 return null_error();
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00002256
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002257 if (PyList_CheckExact(v) || PyTuple_CheckExact(v)) {
2258 Py_INCREF(v);
2259 return v;
2260 }
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00002261
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002262 it = PyObject_GetIter(v);
2263 if (it == NULL) {
2264 if (PyErr_ExceptionMatches(PyExc_TypeError))
2265 PyErr_SetString(PyExc_TypeError, m);
2266 return NULL;
2267 }
Raymond Hettinger2fb70292004-01-11 23:26:51 +00002268
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002269 v = PySequence_List(it);
2270 Py_DECREF(it);
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00002271
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002272 return v;
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00002273}
2274
Tim Peters16a77ad2001-09-08 04:00:12 +00002275/* Iterate over seq. Result depends on the operation:
2276 PY_ITERSEARCH_COUNT: -1 if error, else # of times obj appears in seq.
Mark Dickinson3e4caeb2009-02-21 20:27:01 +00002277 PY_ITERSEARCH_INDEX: 0-based index of first occurrence of obj in seq;
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002278 set ValueError and return -1 if none found; also return -1 on error.
Tim Peters16a77ad2001-09-08 04:00:12 +00002279 Py_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on error.
2280*/
Neal Norwitz1fc4b772006-03-04 18:49:58 +00002281Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00002282_PySequence_IterSearch(PyObject *seq, PyObject *obj, int operation)
Guido van Rossume15dee51995-07-18 14:12:02 +00002283{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002284 Py_ssize_t n;
2285 int wrapped; /* for PY_ITERSEARCH_INDEX, true iff n wrapped around */
2286 PyObject *it; /* iter(seq) */
Guido van Rossume15dee51995-07-18 14:12:02 +00002287
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002288 if (seq == NULL || obj == NULL) {
2289 null_error();
2290 return -1;
2291 }
Tim Peters75f8e352001-05-05 11:33:43 +00002292
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002293 it = PyObject_GetIter(seq);
2294 if (it == NULL) {
2295 type_error("argument of type '%.200s' is not iterable", seq);
2296 return -1;
2297 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002298
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002299 n = wrapped = 0;
2300 for (;;) {
2301 int cmp;
2302 PyObject *item = PyIter_Next(it);
2303 if (item == NULL) {
2304 if (PyErr_Occurred())
2305 goto Fail;
2306 break;
2307 }
Tim Peters16a77ad2001-09-08 04:00:12 +00002308
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002309 cmp = PyObject_RichCompareBool(obj, item, Py_EQ);
2310 Py_DECREF(item);
2311 if (cmp < 0)
2312 goto Fail;
2313 if (cmp > 0) {
2314 switch (operation) {
2315 case PY_ITERSEARCH_COUNT:
2316 if (n == PY_SSIZE_T_MAX) {
2317 PyErr_SetString(PyExc_OverflowError,
2318 "count exceeds C integer size");
2319 goto Fail;
2320 }
2321 ++n;
2322 break;
Tim Peters16a77ad2001-09-08 04:00:12 +00002323
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002324 case PY_ITERSEARCH_INDEX:
2325 if (wrapped) {
2326 PyErr_SetString(PyExc_OverflowError,
2327 "index exceeds C integer size");
2328 goto Fail;
2329 }
2330 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00002331
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002332 case PY_ITERSEARCH_CONTAINS:
2333 n = 1;
2334 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00002335
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002336 default:
2337 assert(!"unknown operation");
2338 }
2339 }
Tim Peters16a77ad2001-09-08 04:00:12 +00002340
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002341 if (operation == PY_ITERSEARCH_INDEX) {
2342 if (n == PY_SSIZE_T_MAX)
2343 wrapped = 1;
2344 ++n;
2345 }
2346 }
Tim Peters16a77ad2001-09-08 04:00:12 +00002347
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002348 if (operation != PY_ITERSEARCH_INDEX)
2349 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00002350
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002351 PyErr_SetString(PyExc_ValueError,
2352 "sequence.index(x): x not in sequence");
2353 /* fall into failure code */
Tim Peters16a77ad2001-09-08 04:00:12 +00002354Fail:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002355 n = -1;
2356 /* fall through */
Tim Peters16a77ad2001-09-08 04:00:12 +00002357Done:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002358 Py_DECREF(it);
2359 return n;
Tim Peters75f8e352001-05-05 11:33:43 +00002360
Guido van Rossume15dee51995-07-18 14:12:02 +00002361}
2362
Tim Peters16a77ad2001-09-08 04:00:12 +00002363/* Return # of times o appears in s. */
Neal Norwitz1fc4b772006-03-04 18:49:58 +00002364Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00002365PySequence_Count(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002366{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002367 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_COUNT);
Guido van Rossume15dee51995-07-18 14:12:02 +00002368}
2369
Tim Peterscb8d3682001-05-05 21:05:01 +00002370/* Return -1 if error; 1 if ob in seq; 0 if ob not in seq.
Tim Peters16a77ad2001-09-08 04:00:12 +00002371 * Use sq_contains if possible, else defer to _PySequence_IterSearch().
Tim Peterscb8d3682001-05-05 21:05:01 +00002372 */
2373int
2374PySequence_Contains(PyObject *seq, PyObject *ob)
2375{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002376 Py_ssize_t result;
2377 if (PyType_HasFeature(seq->ob_type, Py_TPFLAGS_HAVE_SEQUENCE_IN)) {
2378 PySequenceMethods *sqm = seq->ob_type->tp_as_sequence;
2379 if (sqm != NULL && sqm->sq_contains != NULL)
2380 return (*sqm->sq_contains)(seq, ob);
2381 }
2382 result = _PySequence_IterSearch(seq, ob, PY_ITERSEARCH_CONTAINS);
2383 return Py_SAFE_DOWNCAST(result, Py_ssize_t, int);
Tim Peterscb8d3682001-05-05 21:05:01 +00002384}
2385
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002386/* Backwards compatibility */
2387#undef PySequence_In
2388int
Fred Drake79912472000-07-09 04:06:11 +00002389PySequence_In(PyObject *w, PyObject *v)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002390{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002391 return PySequence_Contains(w, v);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002392}
2393
Neal Norwitz1fc4b772006-03-04 18:49:58 +00002394Py_ssize_t
Fred Drake79912472000-07-09 04:06:11 +00002395PySequence_Index(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002396{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002397 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_INDEX);
Guido van Rossume15dee51995-07-18 14:12:02 +00002398}
2399
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002400/* Operations on mappings */
2401
2402int
Fred Drake79912472000-07-09 04:06:11 +00002403PyMapping_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002404{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002405 if (o && PyInstance_Check(o))
2406 return PyObject_HasAttrString(o, "__getitem__");
Raymond Hettingere2eda602004-04-04 08:51:41 +00002407
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002408 return o && o->ob_type->tp_as_mapping &&
2409 o->ob_type->tp_as_mapping->mp_subscript &&
2410 !(o->ob_type->tp_as_sequence &&
2411 o->ob_type->tp_as_sequence->sq_slice);
Guido van Rossume15dee51995-07-18 14:12:02 +00002412}
2413
Martin v. Löwis18e16552006-02-15 17:27:45 +00002414Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00002415PyMapping_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002416{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002417 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00002418
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002419 if (o == NULL) {
2420 null_error();
2421 return -1;
2422 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002423
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002424 m = o->ob_type->tp_as_mapping;
2425 if (m && m->mp_length)
2426 return m->mp_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00002427
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002428 type_error("object of type '%.200s' has no len()", o);
2429 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00002430}
2431
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002432#undef PyMapping_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00002433Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002434PyMapping_Length(PyObject *o)
2435{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002436 return PyMapping_Size(o);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002437}
2438#define PyMapping_Length PyMapping_Size
2439
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002440PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002441PyMapping_GetItemString(PyObject *o, char *key)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002442{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002443 PyObject *okey, *r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002444
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002445 if (key == NULL)
2446 return null_error();
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002447
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002448 okey = PyString_FromString(key);
2449 if (okey == NULL)
2450 return NULL;
2451 r = PyObject_GetItem(o, okey);
2452 Py_DECREF(okey);
2453 return r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002454}
2455
2456int
Fred Drake79912472000-07-09 04:06:11 +00002457PyMapping_SetItemString(PyObject *o, char *key, PyObject *value)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002458{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002459 PyObject *okey;
2460 int r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002461
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002462 if (key == NULL) {
2463 null_error();
2464 return -1;
2465 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002466
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002467 okey = PyString_FromString(key);
2468 if (okey == NULL)
2469 return -1;
2470 r = PyObject_SetItem(o, okey, value);
2471 Py_DECREF(okey);
2472 return r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002473}
2474
2475int
Fred Drake79912472000-07-09 04:06:11 +00002476PyMapping_HasKeyString(PyObject *o, char *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002477{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002478 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002479
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002480 v = PyMapping_GetItemString(o, key);
2481 if (v) {
2482 Py_DECREF(v);
2483 return 1;
2484 }
2485 PyErr_Clear();
2486 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002487}
2488
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002489int
Fred Drake79912472000-07-09 04:06:11 +00002490PyMapping_HasKey(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002491{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002492 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002493
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002494 v = PyObject_GetItem(o, key);
2495 if (v) {
2496 Py_DECREF(v);
2497 return 1;
2498 }
2499 PyErr_Clear();
2500 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002501}
2502
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002503/* Operations on callable objects */
2504
2505/* XXX PyCallable_Check() is in object.c */
2506
Guido van Rossume15dee51995-07-18 14:12:02 +00002507PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002508PyObject_CallObject(PyObject *o, PyObject *a)
Guido van Rossume15dee51995-07-18 14:12:02 +00002509{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002510 return PyEval_CallObjectWithKeywords(o, a, NULL);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002511}
Guido van Rossume15dee51995-07-18 14:12:02 +00002512
2513PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00002514PyObject_Call(PyObject *func, PyObject *arg, PyObject *kw)
2515{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002516 ternaryfunc call;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002517
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002518 if ((call = func->ob_type->tp_call) != NULL) {
2519 PyObject *result;
2520 if (Py_EnterRecursiveCall(" while calling a Python object"))
2521 return NULL;
2522 result = (*call)(func, arg, kw);
2523 Py_LeaveRecursiveCall();
2524 if (result == NULL && !PyErr_Occurred())
2525 PyErr_SetString(
2526 PyExc_SystemError,
2527 "NULL result without error in PyObject_Call");
2528 return result;
2529 }
2530 PyErr_Format(PyExc_TypeError, "'%.200s' object is not callable",
2531 func->ob_type->tp_name);
2532 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002533}
2534
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002535static PyObject*
2536call_function_tail(PyObject *callable, PyObject *args)
2537{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002538 PyObject *retval;
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002539
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002540 if (args == NULL)
2541 return NULL;
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002542
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002543 if (!PyTuple_Check(args)) {
2544 PyObject *a;
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002545
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002546 a = PyTuple_New(1);
2547 if (a == NULL) {
2548 Py_DECREF(args);
2549 return NULL;
2550 }
2551 PyTuple_SET_ITEM(a, 0, args);
2552 args = a;
2553 }
2554 retval = PyObject_Call(callable, args, NULL);
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002555
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002556 Py_DECREF(args);
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002557
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002558 return retval;
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002559}
2560
Tim Peters6d6c1a32001-08-02 04:15:00 +00002561PyObject *
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002562PyObject_CallFunction(PyObject *callable, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002563{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002564 va_list va;
2565 PyObject *args;
Guido van Rossume15dee51995-07-18 14:12:02 +00002566
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002567 if (callable == NULL)
2568 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002569
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002570 if (format && *format) {
2571 va_start(va, format);
2572 args = Py_VaBuildValue(format, va);
2573 va_end(va);
2574 }
2575 else
2576 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002577
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002578 return call_function_tail(callable, args);
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002579}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002580
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002581PyObject *
2582_PyObject_CallFunction_SizeT(PyObject *callable, char *format, ...)
2583{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002584 va_list va;
2585 PyObject *args;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002586
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002587 if (callable == NULL)
2588 return null_error();
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002589
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002590 if (format && *format) {
2591 va_start(va, format);
2592 args = _Py_VaBuildValue_SizeT(format, va);
2593 va_end(va);
2594 }
2595 else
2596 args = PyTuple_New(0);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002597
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002598 return call_function_tail(callable, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002599}
2600
2601PyObject *
Guido van Rossume15dee51995-07-18 14:12:02 +00002602PyObject_CallMethod(PyObject *o, char *name, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002603{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002604 va_list va;
2605 PyObject *args;
2606 PyObject *func = NULL;
2607 PyObject *retval = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002608
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002609 if (o == NULL || name == NULL)
2610 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002611
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002612 func = PyObject_GetAttrString(o, name);
2613 if (func == NULL) {
2614 PyErr_SetString(PyExc_AttributeError, name);
2615 return 0;
2616 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002617
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002618 if (!PyCallable_Check(func)) {
2619 type_error("attribute of type '%.200s' is not callable", func);
2620 goto exit;
2621 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002622
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002623 if (format && *format) {
2624 va_start(va, format);
2625 args = Py_VaBuildValue(format, va);
2626 va_end(va);
2627 }
2628 else
2629 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002630
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002631 retval = call_function_tail(func, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002632
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002633 exit:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002634 /* args gets consumed in call_function_tail */
2635 Py_XDECREF(func);
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002636
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002637 return retval;
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002638}
2639
2640PyObject *
2641_PyObject_CallMethod_SizeT(PyObject *o, char *name, char *format, ...)
2642{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002643 va_list va;
2644 PyObject *args;
2645 PyObject *func = NULL;
2646 PyObject *retval = NULL;
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002647
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002648 if (o == NULL || name == NULL)
2649 return null_error();
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002650
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002651 func = PyObject_GetAttrString(o, name);
2652 if (func == NULL) {
2653 PyErr_SetString(PyExc_AttributeError, name);
2654 return 0;
2655 }
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002656
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002657 if (!PyCallable_Check(func)) {
2658 type_error("attribute of type '%.200s' is not callable", func);
2659 goto exit;
2660 }
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002661
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002662 if (format && *format) {
2663 va_start(va, format);
2664 args = _Py_VaBuildValue_SizeT(format, va);
2665 va_end(va);
2666 }
2667 else
2668 args = PyTuple_New(0);
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002669
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002670 retval = call_function_tail(func, args);
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002671
2672 exit:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002673 /* args gets consumed in call_function_tail */
2674 Py_XDECREF(func);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002675
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002676 return retval;
Guido van Rossume15dee51995-07-18 14:12:02 +00002677}
Guido van Rossum823649d2001-03-21 18:40:58 +00002678
2679
Fred Drakeb421b8c2001-10-26 16:21:32 +00002680static PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002681objargs_mktuple(va_list va)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002682{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002683 int i, n = 0;
2684 va_list countva;
2685 PyObject *result, *tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002686
2687#ifdef VA_LIST_IS_ARRAY
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002688 memcpy(countva, va, sizeof(va_list));
Fred Drakeb421b8c2001-10-26 16:21:32 +00002689#else
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002690#ifdef __va_copy
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002691 __va_copy(countva, va);
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002692#else
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002693 countva = va;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002694#endif
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002695#endif
Fred Drakeb421b8c2001-10-26 16:21:32 +00002696
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002697 while (((PyObject *)va_arg(countva, PyObject *)) != NULL)
2698 ++n;
2699 result = PyTuple_New(n);
2700 if (result != NULL && n > 0) {
2701 for (i = 0; i < n; ++i) {
2702 tmp = (PyObject *)va_arg(va, PyObject *);
2703 PyTuple_SET_ITEM(result, i, tmp);
2704 Py_INCREF(tmp);
2705 }
2706 }
2707 return result;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002708}
2709
2710PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002711PyObject_CallMethodObjArgs(PyObject *callable, PyObject *name, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002712{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002713 PyObject *args, *tmp;
2714 va_list vargs;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002715
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002716 if (callable == NULL || name == NULL)
2717 return null_error();
Fred Drakeb421b8c2001-10-26 16:21:32 +00002718
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002719 callable = PyObject_GetAttr(callable, name);
2720 if (callable == NULL)
2721 return NULL;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002722
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002723 /* count the args */
2724 va_start(vargs, name);
2725 args = objargs_mktuple(vargs);
2726 va_end(vargs);
2727 if (args == NULL) {
2728 Py_DECREF(callable);
2729 return NULL;
2730 }
2731 tmp = PyObject_Call(callable, args, NULL);
2732 Py_DECREF(args);
2733 Py_DECREF(callable);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002734
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002735 return tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002736}
2737
2738PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002739PyObject_CallFunctionObjArgs(PyObject *callable, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002740{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002741 PyObject *args, *tmp;
2742 va_list vargs;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002743
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002744 if (callable == NULL)
2745 return null_error();
Fred Drakeb421b8c2001-10-26 16:21:32 +00002746
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002747 /* count the args */
2748 va_start(vargs, callable);
2749 args = objargs_mktuple(vargs);
2750 va_end(vargs);
2751 if (args == NULL)
2752 return NULL;
2753 tmp = PyObject_Call(callable, args, NULL);
2754 Py_DECREF(args);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002755
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002756 return tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002757}
2758
2759
Guido van Rossum823649d2001-03-21 18:40:58 +00002760/* isinstance(), issubclass() */
2761
Barry Warsawf16951c2002-04-23 22:45:44 +00002762/* abstract_get_bases() has logically 4 return states, with a sort of 0th
2763 * state that will almost never happen.
2764 *
2765 * 0. creating the __bases__ static string could get a MemoryError
2766 * 1. getattr(cls, '__bases__') could raise an AttributeError
2767 * 2. getattr(cls, '__bases__') could raise some other exception
2768 * 3. getattr(cls, '__bases__') could return a tuple
2769 * 4. getattr(cls, '__bases__') could return something other than a tuple
2770 *
2771 * Only state #3 is a non-error state and only it returns a non-NULL object
2772 * (it returns the retrieved tuple).
2773 *
2774 * Any raised AttributeErrors are masked by clearing the exception and
2775 * returning NULL. If an object other than a tuple comes out of __bases__,
2776 * then again, the return value is NULL. So yes, these two situations
2777 * produce exactly the same results: NULL is returned and no error is set.
2778 *
2779 * If some exception other than AttributeError is raised, then NULL is also
2780 * returned, but the exception is not cleared. That's because we want the
2781 * exception to be propagated along.
2782 *
2783 * Callers are expected to test for PyErr_Occurred() when the return value
2784 * is NULL to decide whether a valid exception should be propagated or not.
2785 * When there's no exception to propagate, it's customary for the caller to
2786 * set a TypeError.
2787 */
Neil Schemenauer6b471292001-10-18 03:18:43 +00002788static PyObject *
2789abstract_get_bases(PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002790{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002791 static PyObject *__bases__ = NULL;
2792 PyObject *bases;
Guido van Rossum823649d2001-03-21 18:40:58 +00002793
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002794 if (__bases__ == NULL) {
2795 __bases__ = PyString_InternFromString("__bases__");
2796 if (__bases__ == NULL)
2797 return NULL;
2798 }
2799 bases = PyObject_GetAttr(cls, __bases__);
2800 if (bases == NULL) {
2801 if (PyErr_ExceptionMatches(PyExc_AttributeError))
2802 PyErr_Clear();
2803 return NULL;
2804 }
2805 if (!PyTuple_Check(bases)) {
2806 Py_DECREF(bases);
2807 return NULL;
2808 }
2809 return bases;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002810}
2811
2812
2813static int
2814abstract_issubclass(PyObject *derived, PyObject *cls)
2815{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002816 PyObject *bases = NULL;
2817 Py_ssize_t i, n;
2818 int r = 0;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002819
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002820 while (1) {
2821 if (derived == cls)
2822 return 1;
2823 bases = abstract_get_bases(derived);
2824 if (bases == NULL) {
2825 if (PyErr_Occurred())
2826 return -1;
2827 return 0;
2828 }
2829 n = PyTuple_GET_SIZE(bases);
2830 if (n == 0) {
2831 Py_DECREF(bases);
2832 return 0;
2833 }
2834 /* Avoid recursivity in the single inheritance case */
2835 if (n == 1) {
2836 derived = PyTuple_GET_ITEM(bases, 0);
2837 Py_DECREF(bases);
2838 continue;
2839 }
2840 for (i = 0; i < n; i++) {
2841 r = abstract_issubclass(PyTuple_GET_ITEM(bases, i), cls);
2842 if (r != 0)
2843 break;
2844 }
2845 Py_DECREF(bases);
2846 return r;
2847 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002848}
2849
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002850static int
2851check_class(PyObject *cls, const char *error)
2852{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002853 PyObject *bases = abstract_get_bases(cls);
2854 if (bases == NULL) {
2855 /* Do not mask errors. */
2856 if (!PyErr_Occurred())
2857 PyErr_SetString(PyExc_TypeError, error);
2858 return 0;
2859 }
2860 Py_DECREF(bases);
2861 return -1;
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002862}
2863
Brett Cannon4f653312004-03-20 22:52:14 +00002864static int
Antoine Pitrou0668c622008-08-26 22:42:08 +00002865recursive_isinstance(PyObject *inst, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002866{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002867 PyObject *icls;
2868 static PyObject *__class__ = NULL;
2869 int retval = 0;
Guido van Rossum823649d2001-03-21 18:40:58 +00002870
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002871 if (__class__ == NULL) {
2872 __class__ = PyString_InternFromString("__class__");
2873 if (__class__ == NULL)
2874 return -1;
2875 }
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002876
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002877 if (PyClass_Check(cls) && PyInstance_Check(inst)) {
2878 PyObject *inclass =
2879 (PyObject*)((PyInstanceObject*)inst)->in_class;
2880 retval = PyClass_IsSubclass(inclass, cls);
2881 }
2882 else if (PyType_Check(cls)) {
2883 retval = PyObject_TypeCheck(inst, (PyTypeObject *)cls);
2884 if (retval == 0) {
2885 PyObject *c = PyObject_GetAttr(inst, __class__);
2886 if (c == NULL) {
2887 PyErr_Clear();
2888 }
2889 else {
2890 if (c != (PyObject *)(inst->ob_type) &&
2891 PyType_Check(c))
2892 retval = PyType_IsSubtype(
2893 (PyTypeObject *)c,
2894 (PyTypeObject *)cls);
2895 Py_DECREF(c);
2896 }
2897 }
2898 }
2899 else {
2900 if (!check_class(cls,
2901 "isinstance() arg 2 must be a class, type,"
2902 " or tuple of classes and types"))
2903 return -1;
2904 icls = PyObject_GetAttr(inst, __class__);
2905 if (icls == NULL) {
2906 PyErr_Clear();
2907 retval = 0;
2908 }
2909 else {
2910 retval = abstract_issubclass(icls, cls);
2911 Py_DECREF(icls);
2912 }
2913 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002914
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002915 return retval;
Guido van Rossum823649d2001-03-21 18:40:58 +00002916}
2917
2918int
Brett Cannon4f653312004-03-20 22:52:14 +00002919PyObject_IsInstance(PyObject *inst, PyObject *cls)
2920{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002921 static PyObject *name = NULL;
Raymond Hettinger9a47e622008-03-18 23:22:29 +00002922
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002923 /* Quick test for an exact match */
2924 if (Py_TYPE(inst) == (PyTypeObject *)cls)
2925 return 1;
Raymond Hettinger9a47e622008-03-18 23:22:29 +00002926
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002927 if (PyTuple_Check(cls)) {
2928 Py_ssize_t i;
2929 Py_ssize_t n;
2930 int r = 0;
Antoine Pitrou0668c622008-08-26 22:42:08 +00002931
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002932 if (Py_EnterRecursiveCall(" in __instancecheck__"))
2933 return -1;
2934 n = PyTuple_GET_SIZE(cls);
2935 for (i = 0; i < n; ++i) {
2936 PyObject *item = PyTuple_GET_ITEM(cls, i);
2937 r = PyObject_IsInstance(inst, item);
2938 if (r != 0)
2939 /* either found it, or got an error */
2940 break;
2941 }
2942 Py_LeaveRecursiveCall();
2943 return r;
2944 }
Benjamin Petersonfb6fb062009-05-16 21:44:25 +00002945
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002946 if (!(PyClass_Check(cls) || PyInstance_Check(cls))) {
2947 PyObject *checker;
2948 checker = _PyObject_LookupSpecial(cls, "__instancecheck__", &name);
2949 if (checker != NULL) {
2950 PyObject *res;
2951 int ok = -1;
2952 if (Py_EnterRecursiveCall(" in __instancecheck__")) {
2953 Py_DECREF(checker);
2954 return ok;
2955 }
2956 res = PyObject_CallFunctionObjArgs(checker, inst, NULL);
2957 Py_LeaveRecursiveCall();
2958 Py_DECREF(checker);
2959 if (res != NULL) {
2960 ok = PyObject_IsTrue(res);
2961 Py_DECREF(res);
2962 }
2963 return ok;
2964 }
2965 else if (PyErr_Occurred())
2966 return -1;
2967 }
2968 return recursive_isinstance(inst, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002969}
2970
2971static int
Antoine Pitrou0668c622008-08-26 22:42:08 +00002972recursive_issubclass(PyObject *derived, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002973{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002974 int retval;
Guido van Rossum823649d2001-03-21 18:40:58 +00002975
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002976 if (PyType_Check(cls) && PyType_Check(derived)) {
2977 /* Fast path (non-recursive) */
2978 return PyType_IsSubtype(
2979 (PyTypeObject *)derived, (PyTypeObject *)cls);
2980 }
2981 if (!PyClass_Check(derived) || !PyClass_Check(cls)) {
2982 if (!check_class(derived,
2983 "issubclass() arg 1 must be a class"))
2984 return -1;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002985
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002986 if (!check_class(cls,
2987 "issubclass() arg 2 must be a class"
2988 " or tuple of classes"))
2989 return -1;
2990 retval = abstract_issubclass(derived, cls);
2991 }
2992 else {
2993 /* shortcut */
2994 if (!(retval = (derived == cls)))
2995 retval = PyClass_IsSubclass(derived, cls);
2996 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002997
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002998 return retval;
Guido van Rossum823649d2001-03-21 18:40:58 +00002999}
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00003000
Brett Cannon4f653312004-03-20 22:52:14 +00003001int
3002PyObject_IsSubclass(PyObject *derived, PyObject *cls)
3003{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003004 static PyObject *name = NULL;
3005
3006 if (PyTuple_Check(cls)) {
3007 Py_ssize_t i;
3008 Py_ssize_t n;
3009 int r = 0;
3010
3011 if (Py_EnterRecursiveCall(" in __subclasscheck__"))
3012 return -1;
3013 n = PyTuple_GET_SIZE(cls);
3014 for (i = 0; i < n; ++i) {
3015 PyObject *item = PyTuple_GET_ITEM(cls, i);
3016 r = PyObject_IsSubclass(derived, item);
3017 if (r != 0)
3018 /* either found it, or got an error */
3019 break;
3020 }
3021 Py_LeaveRecursiveCall();
3022 return r;
3023 }
3024 if (!(PyClass_Check(cls) || PyInstance_Check(cls))) {
3025 PyObject *checker;
3026 checker = _PyObject_LookupSpecial(cls, "__subclasscheck__", &name);
3027 if (checker != NULL) {
3028 PyObject *res;
3029 int ok = -1;
3030 if (Py_EnterRecursiveCall(" in __subclasscheck__")) {
3031 Py_DECREF(checker);
3032 return ok;
3033 }
3034 res = PyObject_CallFunctionObjArgs(checker, derived, NULL);
3035 Py_LeaveRecursiveCall();
3036 Py_DECREF(checker);
3037 if (res != NULL) {
3038 ok = PyObject_IsTrue(res);
3039 Py_DECREF(res);
3040 }
3041 return ok;
3042 }
3043 else if (PyErr_Occurred()) {
3044 return -1;
3045 }
3046 }
3047 return recursive_issubclass(derived, cls);
Antoine Pitrou0668c622008-08-26 22:42:08 +00003048}
3049
3050int
3051_PyObject_RealIsInstance(PyObject *inst, PyObject *cls)
3052{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003053 return recursive_isinstance(inst, cls);
Antoine Pitrou0668c622008-08-26 22:42:08 +00003054}
3055
3056int
3057_PyObject_RealIsSubclass(PyObject *derived, PyObject *cls)
3058{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003059 return recursive_issubclass(derived, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00003060}
3061
3062
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00003063PyObject *
3064PyObject_GetIter(PyObject *o)
3065{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003066 PyTypeObject *t = o->ob_type;
3067 getiterfunc f = NULL;
3068 if (PyType_HasFeature(t, Py_TPFLAGS_HAVE_ITER))
3069 f = t->tp_iter;
3070 if (f == NULL) {
3071 if (PySequence_Check(o))
3072 return PySeqIter_New(o);
3073 return type_error("'%.200s' object is not iterable", o);
3074 }
3075 else {
3076 PyObject *res = (*f)(o);
3077 if (res != NULL && !PyIter_Check(res)) {
3078 PyErr_Format(PyExc_TypeError,
3079 "iter() returned non-iterator "
3080 "of type '%.100s'",
3081 res->ob_type->tp_name);
3082 Py_DECREF(res);
3083 res = NULL;
3084 }
3085 return res;
3086 }
Guido van Rossum213c7a62001-04-23 14:08:49 +00003087}
3088
Tim Petersf4848da2001-05-05 00:14:56 +00003089/* Return next item.
3090 * If an error occurs, return NULL. PyErr_Occurred() will be true.
3091 * If the iteration terminates normally, return NULL and clear the
3092 * PyExc_StopIteration exception (if it was set). PyErr_Occurred()
3093 * will be false.
3094 * Else return the next object. PyErr_Occurred() will be false.
3095 */
Guido van Rossum213c7a62001-04-23 14:08:49 +00003096PyObject *
3097PyIter_Next(PyObject *iter)
3098{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003099 PyObject *result;
3100 result = (*iter->ob_type->tp_iternext)(iter);
3101 if (result == NULL &&
3102 PyErr_Occurred() &&
3103 PyErr_ExceptionMatches(PyExc_StopIteration))
3104 PyErr_Clear();
3105 return result;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00003106}