blob: 75c1a10473576c523fabe54064f00e78a4b2c5d1 [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 }
Benjamin Peterson7d8a2e42012-07-14 17:53:55 -0700129 rv = PyNumber_Check(ro) ? PyInt_AsSsize_t(ro) : defaultvalue;
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000130 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
Raymond Hettinger7d1483c2011-11-20 10:38:53 -0800159 return type_error("'%.200s' object has no attribute '__getitem__'", 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,
Raymond Hettinger9c90e252015-10-08 21:14:15 -0400262 "expected a string or other character buffer object");
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000263 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
Stefan Krah5606cd92015-01-30 20:11:10 +0100502 /* view->ndim <= 64 */
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000503 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--) {
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000524 ptr = PyBuffer_GetPointer(view, indices);
525 memcpy(dest, ptr, view->itemsize);
526 dest += view->itemsize;
Stefan Krah5606cd92015-01-30 20:11:10 +0100527 addone(view->ndim, indices, view->shape);
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000528 }
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
Stefan Krah0a7fc532015-02-01 16:10:35 +0100553 /* view->ndim <= 64 */
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000554 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--) {
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000575 ptr = PyBuffer_GetPointer(view, indices);
576 memcpy(ptr, src, view->itemsize);
577 src += view->itemsize;
Stefan Krah0a7fc532015-02-01 16:10:35 +0100578 addone(view->ndim, indices, view->shape);
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000579 }
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();
Serhiy Storchaka48c8bf22018-07-31 09:09:36 +03001495 if (_PyAnyInt_Check(item)) {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001496 Py_INCREF(item);
1497 return item;
1498 }
1499 if (PyIndex_Check(item)) {
1500 result = item->ob_type->tp_as_number->nb_index(item);
Serhiy Storchaka48c8bf22018-07-31 09:09:36 +03001501 if (result && !_PyAnyInt_Check(result)) {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001502 PyErr_Format(PyExc_TypeError,
1503 "__index__ returned non-(int,long) " \
1504 "(type %.200s)",
1505 result->ob_type->tp_name);
1506 Py_DECREF(result);
1507 return NULL;
1508 }
1509 }
1510 else {
1511 PyErr_Format(PyExc_TypeError,
1512 "'%.200s' object cannot be interpreted "
1513 "as an index", item->ob_type->tp_name);
1514 }
1515 return result;
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001516}
1517
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00001518/* Return an error on Overflow only if err is not NULL*/
1519
1520Py_ssize_t
1521PyNumber_AsSsize_t(PyObject *item, PyObject *err)
1522{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001523 Py_ssize_t result;
1524 PyObject *runerr;
1525 PyObject *value = PyNumber_Index(item);
1526 if (value == NULL)
1527 return -1;
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00001528
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001529 /* We're done if PyInt_AsSsize_t() returns without error. */
1530 result = PyInt_AsSsize_t(value);
1531 if (result != -1 || !(runerr = PyErr_Occurred()))
1532 goto finish;
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00001533
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001534 /* Error handling code -- only manage OverflowError differently */
1535 if (!PyErr_GivenExceptionMatches(runerr, PyExc_OverflowError))
1536 goto finish;
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00001537
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001538 PyErr_Clear();
1539 /* If no error-handling desired then the default clipping
1540 is sufficient.
1541 */
1542 if (!err) {
1543 assert(PyLong_Check(value));
1544 /* Whether or not it is less than or equal to
1545 zero is determined by the sign of ob_size
1546 */
1547 if (_PyLong_Sign(value) < 0)
1548 result = PY_SSIZE_T_MIN;
1549 else
1550 result = PY_SSIZE_T_MAX;
1551 }
1552 else {
1553 /* Otherwise replace the error with caller's error object. */
1554 PyErr_Format(err,
1555 "cannot fit '%.200s' into an index-sized integer",
1556 item->ob_type->tp_name);
1557 }
1558
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00001559 finish:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001560 Py_DECREF(value);
1561 return result;
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00001562}
1563
1564
Guido van Rossume15dee51995-07-18 14:12:02 +00001565PyObject *
Jeffrey Yasskina26cf9b2008-02-04 01:04:35 +00001566_PyNumber_ConvertIntegralToInt(PyObject *integral, const char* error_format)
1567{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001568 const char *type_name;
1569 static PyObject *int_name = NULL;
1570 if (int_name == NULL) {
1571 int_name = PyString_InternFromString("__int__");
1572 if (int_name == NULL)
1573 return NULL;
1574 }
Jeffrey Yasskina26cf9b2008-02-04 01:04:35 +00001575
Serhiy Storchaka48c8bf22018-07-31 09:09:36 +03001576 if (integral && !_PyAnyInt_Check(integral)) {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001577 /* Don't go through tp_as_number->nb_int to avoid
1578 hitting the classic class fallback to __trunc__. */
1579 PyObject *int_func = PyObject_GetAttr(integral, int_name);
1580 if (int_func == NULL) {
1581 PyErr_Clear(); /* Raise a different error. */
1582 goto non_integral_error;
1583 }
1584 Py_DECREF(integral);
1585 integral = PyEval_CallObject(int_func, NULL);
1586 Py_DECREF(int_func);
Serhiy Storchaka48c8bf22018-07-31 09:09:36 +03001587 if (integral && !_PyAnyInt_Check(integral)) {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001588 goto non_integral_error;
1589 }
1590 }
1591 return integral;
Jeffrey Yasskina26cf9b2008-02-04 01:04:35 +00001592
1593non_integral_error:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001594 if (PyInstance_Check(integral)) {
1595 type_name = PyString_AS_STRING(((PyInstanceObject *)integral)
1596 ->in_class->cl_name);
1597 }
1598 else {
1599 type_name = integral->ob_type->tp_name;
1600 }
1601 PyErr_Format(PyExc_TypeError, error_format, type_name);
1602 Py_DECREF(integral);
1603 return NULL;
Jeffrey Yasskina26cf9b2008-02-04 01:04:35 +00001604}
1605
1606
1607PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001608PyNumber_Int(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001609{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001610 PyNumberMethods *m;
1611 static PyObject *trunc_name = NULL;
1612 PyObject *trunc_func;
1613 const char *buffer;
1614 Py_ssize_t buffer_len;
Guido van Rossume15dee51995-07-18 14:12:02 +00001615
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001616 if (trunc_name == NULL) {
1617 trunc_name = PyString_InternFromString("__trunc__");
1618 if (trunc_name == NULL)
1619 return NULL;
1620 }
Jeffrey Yasskina26cf9b2008-02-04 01:04:35 +00001621
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001622 if (o == NULL)
1623 return null_error();
1624 if (PyInt_CheckExact(o)) {
1625 Py_INCREF(o);
1626 return o;
1627 }
1628 m = o->ob_type->tp_as_number;
1629 if (m && m->nb_int) { /* This should include subclasses of int */
1630 /* Classic classes always take this branch. */
1631 PyObject *res = m->nb_int(o);
Serhiy Storchaka48c8bf22018-07-31 09:09:36 +03001632 if (res && !_PyAnyInt_Check(res)) {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001633 PyErr_Format(PyExc_TypeError,
1634 "__int__ returned non-int (type %.200s)",
1635 res->ob_type->tp_name);
1636 Py_DECREF(res);
1637 return NULL;
1638 }
1639 return res;
1640 }
Martin Panterb362f752015-11-02 03:37:02 +00001641 if (PyInt_Check(o)) { /* An int subclass without nb_int */
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001642 PyIntObject *io = (PyIntObject*)o;
1643 return PyInt_FromLong(io->ob_ival);
1644 }
1645 trunc_func = PyObject_GetAttr(o, trunc_name);
1646 if (trunc_func) {
1647 PyObject *truncated = PyEval_CallObject(trunc_func, NULL);
1648 Py_DECREF(trunc_func);
1649 /* __trunc__ is specified to return an Integral type, but
1650 int() needs to return an int. */
1651 return _PyNumber_ConvertIntegralToInt(
1652 truncated,
1653 "__trunc__ returned non-Integral (type %.200s)");
1654 }
1655 PyErr_Clear(); /* It's not an error if o.__trunc__ doesn't exist. */
Jeffrey Yasskina26cf9b2008-02-04 01:04:35 +00001656
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001657 if (PyString_Check(o))
1658 return int_from_string(PyString_AS_STRING(o),
1659 PyString_GET_SIZE(o));
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001660#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001661 if (PyUnicode_Check(o))
1662 return PyInt_FromUnicode(PyUnicode_AS_UNICODE(o),
1663 PyUnicode_GET_SIZE(o),
1664 10);
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001665#endif
Serhiy Storchaka61565602015-11-20 21:56:21 +02001666 if (!PyObject_AsCharBuffer(o, &buffer, &buffer_len)) {
1667 PyObject *result, *str;
1668
1669 /* Copy to NUL-terminated buffer. */
1670 str = PyString_FromStringAndSize((const char *)buffer, buffer_len);
1671 if (str == NULL)
1672 return NULL;
1673 result = int_from_string(PyString_AS_STRING(str), buffer_len);
1674 Py_DECREF(str);
1675 return result;
1676 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001677
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001678 return type_error("int() argument must be a string or a "
1679 "number, not '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001680}
1681
Guido van Rossum9e896b32000-04-05 20:11:21 +00001682/* Add a check for embedded NULL-bytes in the argument. */
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001683static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001684long_from_string(const char *s, Py_ssize_t len)
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001685{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001686 char *end;
1687 PyObject *x;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001688
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001689 x = PyLong_FromString((char*)s, &end, 10);
1690 if (x == NULL)
1691 return NULL;
1692 if (end != s + len) {
1693 PyErr_SetString(PyExc_ValueError,
1694 "null byte in argument for long()");
1695 Py_DECREF(x);
1696 return NULL;
1697 }
1698 return x;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001699}
1700
Guido van Rossume15dee51995-07-18 14:12:02 +00001701PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001702PyNumber_Long(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001703{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001704 PyNumberMethods *m;
1705 static PyObject *trunc_name = NULL;
1706 PyObject *trunc_func;
1707 const char *buffer;
1708 Py_ssize_t buffer_len;
Guido van Rossume15dee51995-07-18 14:12:02 +00001709
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001710 if (trunc_name == NULL) {
1711 trunc_name = PyString_InternFromString("__trunc__");
1712 if (trunc_name == NULL)
1713 return NULL;
1714 }
Jeffrey Yasskina26cf9b2008-02-04 01:04:35 +00001715
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001716 if (o == NULL)
1717 return null_error();
1718 m = o->ob_type->tp_as_number;
1719 if (m && m->nb_long) { /* This should include subclasses of long */
1720 /* Classic classes always take this branch. */
1721 PyObject *res = m->nb_long(o);
Mark Dickinsoncb61e5d2010-09-26 10:37:12 +00001722 if (res == NULL)
1723 return NULL;
1724 if (PyInt_Check(res)) {
1725 long value = PyInt_AS_LONG(res);
1726 Py_DECREF(res);
1727 return PyLong_FromLong(value);
1728 }
1729 else if (!PyLong_Check(res)) {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001730 PyErr_Format(PyExc_TypeError,
1731 "__long__ returned non-long (type %.200s)",
1732 res->ob_type->tp_name);
1733 Py_DECREF(res);
1734 return NULL;
1735 }
1736 return res;
1737 }
1738 if (PyLong_Check(o)) /* A long subclass without nb_long */
1739 return _PyLong_Copy((PyLongObject *)o);
1740 trunc_func = PyObject_GetAttr(o, trunc_name);
1741 if (trunc_func) {
1742 PyObject *truncated = PyEval_CallObject(trunc_func, NULL);
1743 PyObject *int_instance;
1744 Py_DECREF(trunc_func);
1745 /* __trunc__ is specified to return an Integral type,
1746 but long() needs to return a long. */
1747 int_instance = _PyNumber_ConvertIntegralToInt(
1748 truncated,
1749 "__trunc__ returned non-Integral (type %.200s)");
1750 if (int_instance && PyInt_Check(int_instance)) {
1751 /* Make sure that long() returns a long instance. */
1752 long value = PyInt_AS_LONG(int_instance);
1753 Py_DECREF(int_instance);
1754 return PyLong_FromLong(value);
1755 }
1756 return int_instance;
1757 }
1758 PyErr_Clear(); /* It's not an error if o.__trunc__ doesn't exist. */
Jeffrey Yasskina26cf9b2008-02-04 01:04:35 +00001759
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001760 if (PyString_Check(o))
1761 /* need to do extra error checking that PyLong_FromString()
1762 * doesn't do. In particular long('9.5') must raise an
1763 * exception, not truncate the float.
1764 */
1765 return long_from_string(PyString_AS_STRING(o),
1766 PyString_GET_SIZE(o));
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001767#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001768 if (PyUnicode_Check(o))
1769 /* The above check is done in PyLong_FromUnicode(). */
1770 return PyLong_FromUnicode(PyUnicode_AS_UNICODE(o),
1771 PyUnicode_GET_SIZE(o),
1772 10);
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001773#endif
Serhiy Storchaka61565602015-11-20 21:56:21 +02001774 if (!PyObject_AsCharBuffer(o, &buffer, &buffer_len)) {
1775 PyObject *result, *str;
Guido van Rossume15dee51995-07-18 14:12:02 +00001776
Serhiy Storchaka61565602015-11-20 21:56:21 +02001777 /* Copy to NUL-terminated buffer. */
1778 str = PyString_FromStringAndSize((const char *)buffer, buffer_len);
1779 if (str == NULL)
1780 return NULL;
1781 result = long_from_string(PyString_AS_STRING(str), buffer_len);
1782 Py_DECREF(str);
1783 return result;
1784 }
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001785 return type_error("long() argument must be a string or a "
1786 "number, not '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001787}
1788
1789PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001790PyNumber_Float(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001791{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001792 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001793
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001794 if (o == NULL)
1795 return null_error();
1796 m = o->ob_type->tp_as_number;
1797 if (m && m->nb_float) { /* This should include subclasses of float */
1798 PyObject *res = m->nb_float(o);
1799 if (res && !PyFloat_Check(res)) {
1800 PyErr_Format(PyExc_TypeError,
1801 "__float__ returned non-float (type %.200s)",
1802 res->ob_type->tp_name);
1803 Py_DECREF(res);
1804 return NULL;
1805 }
1806 return res;
1807 }
1808 if (PyFloat_Check(o)) { /* A float subclass with nb_float == NULL */
1809 PyFloatObject *po = (PyFloatObject *)o;
1810 return PyFloat_FromDouble(po->ob_fval);
1811 }
1812 return PyFloat_FromString(o, NULL);
Guido van Rossume15dee51995-07-18 14:12:02 +00001813}
1814
Eric Smith5e527eb2008-02-10 01:36:53 +00001815PyObject *
1816PyNumber_ToBase(PyObject *n, int base)
1817{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001818 PyObject *res = NULL;
1819 PyObject *index = PyNumber_Index(n);
Eric Smith5e527eb2008-02-10 01:36:53 +00001820
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001821 if (!index)
1822 return NULL;
1823 if (PyLong_Check(index))
1824 res = _PyLong_Format(index, base, 0, 1);
1825 else if (PyInt_Check(index))
1826 res = _PyInt_Format((PyIntObject*)index, base, 1);
1827 else
1828 /* It should not be possible to get here, as
1829 PyNumber_Index already has a check for the same
1830 condition */
1831 PyErr_SetString(PyExc_ValueError, "PyNumber_ToBase: index not "
1832 "int or long");
1833 Py_DECREF(index);
1834 return res;
Eric Smith5e527eb2008-02-10 01:36:53 +00001835}
1836
1837
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001838/* Operations on sequences */
Guido van Rossume15dee51995-07-18 14:12:02 +00001839
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001840int
Fred Drake79912472000-07-09 04:06:11 +00001841PySequence_Check(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001842{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001843 if (s == NULL)
1844 return 0;
1845 if (PyInstance_Check(s))
1846 return PyObject_HasAttrString(s, "__getitem__");
1847 if (PyDict_Check(s))
1848 return 0;
1849 return s->ob_type->tp_as_sequence &&
1850 s->ob_type->tp_as_sequence->sq_item != NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001851}
1852
Martin v. Löwis18e16552006-02-15 17:27:45 +00001853Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001854PySequence_Size(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001855{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001856 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001857
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001858 if (s == NULL) {
1859 null_error();
1860 return -1;
1861 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001862
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001863 m = s->ob_type->tp_as_sequence;
1864 if (m && m->sq_length)
1865 return m->sq_length(s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001866
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001867 type_error("object of type '%.200s' has no len()", s);
1868 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001869}
1870
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001871#undef PySequence_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001872Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001873PySequence_Length(PyObject *s)
1874{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001875 return PySequence_Size(s);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001876}
1877#define PySequence_Length PySequence_Size
1878
Guido van Rossume15dee51995-07-18 14:12:02 +00001879PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001880PySequence_Concat(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001881{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001882 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001883
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001884 if (s == NULL || o == NULL)
1885 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001886
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001887 m = s->ob_type->tp_as_sequence;
1888 if (m && m->sq_concat)
1889 return m->sq_concat(s, o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001890
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001891 /* Instances of user classes defining an __add__() method only
1892 have an nb_add slot, not an sq_concat slot. So we fall back
1893 to nb_add if both arguments appear to be sequences. */
1894 if (PySequence_Check(s) && PySequence_Check(o)) {
1895 PyObject *result = binary_op1(s, o, NB_SLOT(nb_add));
1896 if (result != Py_NotImplemented)
1897 return result;
1898 Py_DECREF(result);
1899 }
1900 return type_error("'%.200s' object can't be concatenated", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001901}
1902
1903PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001904PySequence_Repeat(PyObject *o, Py_ssize_t count)
Guido van Rossume15dee51995-07-18 14:12:02 +00001905{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001906 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001907
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001908 if (o == NULL)
1909 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001910
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001911 m = o->ob_type->tp_as_sequence;
1912 if (m && m->sq_repeat)
1913 return m->sq_repeat(o, count);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001914
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001915 /* Instances of user classes defining a __mul__() method only
1916 have an nb_multiply slot, not an sq_repeat slot. so we fall back
1917 to nb_multiply if o appears to be a sequence. */
1918 if (PySequence_Check(o)) {
1919 PyObject *n, *result;
1920 n = PyInt_FromSsize_t(count);
1921 if (n == NULL)
1922 return NULL;
1923 result = binary_op1(o, n, NB_SLOT(nb_multiply));
1924 Py_DECREF(n);
1925 if (result != Py_NotImplemented)
1926 return result;
1927 Py_DECREF(result);
1928 }
1929 return type_error("'%.200s' object can't be repeated", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001930}
1931
1932PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001933PySequence_InPlaceConcat(PyObject *s, PyObject *o)
1934{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001935 PySequenceMethods *m;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001936
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001937 if (s == NULL || o == NULL)
1938 return null_error();
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001939
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001940 m = s->ob_type->tp_as_sequence;
1941 if (m && HASINPLACE(s) && m->sq_inplace_concat)
1942 return m->sq_inplace_concat(s, o);
1943 if (m && m->sq_concat)
1944 return m->sq_concat(s, o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001945
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001946 if (PySequence_Check(s) && PySequence_Check(o)) {
1947 PyObject *result = binary_iop1(s, o, NB_SLOT(nb_inplace_add),
1948 NB_SLOT(nb_add));
1949 if (result != Py_NotImplemented)
1950 return result;
1951 Py_DECREF(result);
1952 }
1953 return type_error("'%.200s' object can't be concatenated", s);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001954}
1955
1956PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001957PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001958{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001959 PySequenceMethods *m;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001960
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001961 if (o == NULL)
1962 return null_error();
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001963
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001964 m = o->ob_type->tp_as_sequence;
1965 if (m && HASINPLACE(o) && m->sq_inplace_repeat)
1966 return m->sq_inplace_repeat(o, count);
1967 if (m && m->sq_repeat)
1968 return m->sq_repeat(o, count);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001969
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001970 if (PySequence_Check(o)) {
1971 PyObject *n, *result;
1972 n = PyInt_FromSsize_t(count);
1973 if (n == NULL)
1974 return NULL;
1975 result = binary_iop1(o, n, NB_SLOT(nb_inplace_multiply),
1976 NB_SLOT(nb_multiply));
1977 Py_DECREF(n);
1978 if (result != Py_NotImplemented)
1979 return result;
1980 Py_DECREF(result);
1981 }
1982 return type_error("'%.200s' object can't be repeated", o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001983}
1984
1985PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001986PySequence_GetItem(PyObject *s, Py_ssize_t i)
Guido van Rossume15dee51995-07-18 14:12:02 +00001987{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001988 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001989
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001990 if (s == NULL)
1991 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001992
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001993 m = s->ob_type->tp_as_sequence;
1994 if (m && m->sq_item) {
1995 if (i < 0) {
1996 if (m->sq_length) {
1997 Py_ssize_t l = (*m->sq_length)(s);
1998 if (l < 0)
1999 return NULL;
2000 i += l;
2001 }
2002 }
2003 return m->sq_item(s, i);
2004 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002005
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002006 return type_error("'%.200s' object does not support indexing", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00002007}
2008
2009PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00002010PySequence_GetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossume15dee51995-07-18 14:12:02 +00002011{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002012 PySequenceMethods *m;
2013 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00002014
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002015 if (!s) return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002016
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002017 m = s->ob_type->tp_as_sequence;
2018 if (m && m->sq_slice) {
2019 if (i1 < 0 || i2 < 0) {
2020 if (m->sq_length) {
2021 Py_ssize_t l = (*m->sq_length)(s);
2022 if (l < 0)
2023 return NULL;
2024 if (i1 < 0)
2025 i1 += l;
2026 if (i2 < 0)
2027 i2 += l;
2028 }
2029 }
2030 return m->sq_slice(s, i1, i2);
2031 } else if ((mp = s->ob_type->tp_as_mapping) && mp->mp_subscript) {
2032 PyObject *res;
2033 PyObject *slice = _PySlice_FromIndices(i1, i2);
2034 if (!slice)
2035 return NULL;
2036 res = mp->mp_subscript(s, slice);
2037 Py_DECREF(slice);
2038 return res;
2039 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002040
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002041 return type_error("'%.200s' object is unsliceable", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00002042}
2043
2044int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002045PySequence_SetItem(PyObject *s, Py_ssize_t i, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002046{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002047 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00002048
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002049 if (s == NULL) {
2050 null_error();
2051 return -1;
2052 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002053
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002054 m = s->ob_type->tp_as_sequence;
2055 if (m && m->sq_ass_item) {
2056 if (i < 0) {
2057 if (m->sq_length) {
2058 Py_ssize_t l = (*m->sq_length)(s);
2059 if (l < 0)
2060 return -1;
2061 i += l;
2062 }
2063 }
2064 return m->sq_ass_item(s, i, o);
2065 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002066
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002067 type_error("'%.200s' object does not support item assignment", s);
2068 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00002069}
2070
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00002071int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002072PySequence_DelItem(PyObject *s, Py_ssize_t i)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00002073{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002074 PySequenceMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00002075
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002076 if (s == NULL) {
2077 null_error();
2078 return -1;
2079 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00002080
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002081 m = s->ob_type->tp_as_sequence;
2082 if (m && m->sq_ass_item) {
2083 if (i < 0) {
2084 if (m->sq_length) {
2085 Py_ssize_t l = (*m->sq_length)(s);
2086 if (l < 0)
2087 return -1;
2088 i += l;
2089 }
2090 }
2091 return m->sq_ass_item(s, i, (PyObject *)NULL);
2092 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002093
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002094 type_error("'%.200s' object doesn't support item deletion", s);
2095 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00002096}
2097
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002098int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002099PySequence_SetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002100{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002101 PySequenceMethods *m;
2102 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00002103
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002104 if (s == NULL) {
2105 null_error();
2106 return -1;
2107 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002108
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002109 m = s->ob_type->tp_as_sequence;
2110 if (m && m->sq_ass_slice) {
2111 if (i1 < 0 || i2 < 0) {
2112 if (m->sq_length) {
2113 Py_ssize_t l = (*m->sq_length)(s);
2114 if (l < 0)
2115 return -1;
2116 if (i1 < 0)
2117 i1 += l;
2118 if (i2 < 0)
2119 i2 += l;
2120 }
2121 }
2122 return m->sq_ass_slice(s, i1, i2, o);
2123 } else if ((mp = s->ob_type->tp_as_mapping) && mp->mp_ass_subscript) {
2124 int res;
2125 PyObject *slice = _PySlice_FromIndices(i1, i2);
2126 if (!slice)
2127 return -1;
2128 res = mp->mp_ass_subscript(s, slice, o);
2129 Py_DECREF(slice);
2130 return res;
2131 }
Thomas Wouters1d75a792000-08-17 22:37:32 +00002132
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002133 type_error("'%.200s' object doesn't support slice assignment", s);
2134 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00002135}
2136
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002137int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002138PySequence_DelSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00002139{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002140 PySequenceMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00002141
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002142 if (s == NULL) {
2143 null_error();
2144 return -1;
2145 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00002146
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002147 m = s->ob_type->tp_as_sequence;
2148 if (m && m->sq_ass_slice) {
2149 if (i1 < 0 || i2 < 0) {
2150 if (m->sq_length) {
2151 Py_ssize_t l = (*m->sq_length)(s);
2152 if (l < 0)
2153 return -1;
2154 if (i1 < 0)
2155 i1 += l;
2156 if (i2 < 0)
2157 i2 += l;
2158 }
2159 }
2160 return m->sq_ass_slice(s, i1, i2, (PyObject *)NULL);
2161 }
2162 type_error("'%.200s' object doesn't support slice deletion", s);
2163 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00002164}
2165
Guido van Rossume15dee51995-07-18 14:12:02 +00002166PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002167PySequence_Tuple(PyObject *v)
Guido van Rossume15dee51995-07-18 14:12:02 +00002168{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002169 PyObject *it; /* iter(v) */
2170 Py_ssize_t n; /* guess for result tuple size */
2171 PyObject *result = NULL;
2172 Py_ssize_t j;
Guido van Rossume15dee51995-07-18 14:12:02 +00002173
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002174 if (v == NULL)
2175 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002176
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002177 /* Special-case the common tuple and list cases, for efficiency. */
2178 if (PyTuple_CheckExact(v)) {
2179 /* Note that we can't know whether it's safe to return
2180 a tuple *subclass* instance as-is, hence the restriction
2181 to exact tuples here. In contrast, lists always make
2182 a copy, so there's no need for exactness below. */
2183 Py_INCREF(v);
2184 return v;
2185 }
Raymond Hettinger51dbc9a2015-05-17 14:37:39 -07002186 if (PyList_CheckExact(v))
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002187 return PyList_AsTuple(v);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002188
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002189 /* Get iterator. */
2190 it = PyObject_GetIter(v);
2191 if (it == NULL)
2192 return NULL;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002193
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002194 /* Guess result size and allocate space. */
2195 n = _PyObject_LengthHint(v, 10);
2196 if (n == -1)
2197 goto Fail;
2198 result = PyTuple_New(n);
2199 if (result == NULL)
2200 goto Fail;
Tim Peters6912d4d2001-05-05 03:56:37 +00002201
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002202 /* Fill the tuple. */
2203 for (j = 0; ; ++j) {
2204 PyObject *item = PyIter_Next(it);
2205 if (item == NULL) {
2206 if (PyErr_Occurred())
2207 goto Fail;
2208 break;
2209 }
2210 if (j >= n) {
Martin Panter2a0438d2016-07-25 02:30:05 +00002211 size_t newn = (size_t)n;
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002212 /* The over-allocation strategy can grow a bit faster
2213 than for lists because unlike lists the
2214 over-allocation isn't permanent -- we reclaim
2215 the excess before the end of this routine.
2216 So, grow by ten and then add 25%.
2217 */
Martin Panter2a0438d2016-07-25 02:30:05 +00002218 newn += 10u;
2219 newn += newn >> 2;
2220 if (newn > PY_SSIZE_T_MAX) {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002221 /* Check for overflow */
2222 PyErr_NoMemory();
2223 Py_DECREF(item);
2224 goto Fail;
2225 }
Martin Panter2a0438d2016-07-25 02:30:05 +00002226 n = (Py_ssize_t)newn;
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002227 if (_PyTuple_Resize(&result, n) != 0) {
2228 Py_DECREF(item);
2229 goto Fail;
2230 }
2231 }
2232 PyTuple_SET_ITEM(result, j, item);
2233 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002234
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002235 /* Cut tuple back if guess was too large. */
2236 if (j < n &&
2237 _PyTuple_Resize(&result, j) != 0)
2238 goto Fail;
Tim Peters6912d4d2001-05-05 03:56:37 +00002239
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002240 Py_DECREF(it);
2241 return result;
Tim Peters6912d4d2001-05-05 03:56:37 +00002242
2243Fail:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002244 Py_XDECREF(result);
2245 Py_DECREF(it);
2246 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002247}
2248
Guido van Rossum3c5936a1996-12-05 21:51:24 +00002249PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002250PySequence_List(PyObject *v)
Guido van Rossum3c5936a1996-12-05 21:51:24 +00002251{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002252 PyObject *result; /* result list */
2253 PyObject *rv; /* return value from PyList_Extend */
Guido van Rossum4669fb41997-04-02 05:31:09 +00002254
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002255 if (v == NULL)
2256 return null_error();
Guido van Rossum5dba9e81998-07-10 18:03:50 +00002257
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002258 result = PyList_New(0);
2259 if (result == NULL)
2260 return NULL;
Tim Petersf553f892001-05-01 20:45:31 +00002261
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002262 rv = _PyList_Extend((PyListObject *)result, v);
2263 if (rv == NULL) {
2264 Py_DECREF(result);
2265 return NULL;
2266 }
2267 Py_DECREF(rv);
2268 return result;
Guido van Rossum3c5936a1996-12-05 21:51:24 +00002269}
2270
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00002271PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002272PySequence_Fast(PyObject *v, const char *m)
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00002273{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002274 PyObject *it;
Raymond Hettinger2fb70292004-01-11 23:26:51 +00002275
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002276 if (v == NULL)
2277 return null_error();
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00002278
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002279 if (PyList_CheckExact(v) || PyTuple_CheckExact(v)) {
2280 Py_INCREF(v);
2281 return v;
2282 }
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00002283
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002284 it = PyObject_GetIter(v);
2285 if (it == NULL) {
2286 if (PyErr_ExceptionMatches(PyExc_TypeError))
2287 PyErr_SetString(PyExc_TypeError, m);
2288 return NULL;
2289 }
Raymond Hettinger2fb70292004-01-11 23:26:51 +00002290
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002291 v = PySequence_List(it);
2292 Py_DECREF(it);
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00002293
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002294 return v;
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00002295}
2296
Tim Peters16a77ad2001-09-08 04:00:12 +00002297/* Iterate over seq. Result depends on the operation:
2298 PY_ITERSEARCH_COUNT: -1 if error, else # of times obj appears in seq.
Mark Dickinson3e4caeb2009-02-21 20:27:01 +00002299 PY_ITERSEARCH_INDEX: 0-based index of first occurrence of obj in seq;
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002300 set ValueError and return -1 if none found; also return -1 on error.
Tim Peters16a77ad2001-09-08 04:00:12 +00002301 Py_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on error.
2302*/
Neal Norwitz1fc4b772006-03-04 18:49:58 +00002303Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00002304_PySequence_IterSearch(PyObject *seq, PyObject *obj, int operation)
Guido van Rossume15dee51995-07-18 14:12:02 +00002305{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002306 Py_ssize_t n;
2307 int wrapped; /* for PY_ITERSEARCH_INDEX, true iff n wrapped around */
2308 PyObject *it; /* iter(seq) */
Guido van Rossume15dee51995-07-18 14:12:02 +00002309
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002310 if (seq == NULL || obj == NULL) {
2311 null_error();
2312 return -1;
2313 }
Tim Peters75f8e352001-05-05 11:33:43 +00002314
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002315 it = PyObject_GetIter(seq);
2316 if (it == NULL) {
2317 type_error("argument of type '%.200s' is not iterable", seq);
2318 return -1;
2319 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002320
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002321 n = wrapped = 0;
2322 for (;;) {
2323 int cmp;
2324 PyObject *item = PyIter_Next(it);
2325 if (item == NULL) {
2326 if (PyErr_Occurred())
2327 goto Fail;
2328 break;
2329 }
Tim Peters16a77ad2001-09-08 04:00:12 +00002330
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002331 cmp = PyObject_RichCompareBool(obj, item, Py_EQ);
2332 Py_DECREF(item);
2333 if (cmp < 0)
2334 goto Fail;
2335 if (cmp > 0) {
2336 switch (operation) {
2337 case PY_ITERSEARCH_COUNT:
2338 if (n == PY_SSIZE_T_MAX) {
2339 PyErr_SetString(PyExc_OverflowError,
2340 "count exceeds C integer size");
2341 goto Fail;
2342 }
2343 ++n;
2344 break;
Tim Peters16a77ad2001-09-08 04:00:12 +00002345
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002346 case PY_ITERSEARCH_INDEX:
2347 if (wrapped) {
2348 PyErr_SetString(PyExc_OverflowError,
2349 "index exceeds C integer size");
2350 goto Fail;
2351 }
2352 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00002353
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002354 case PY_ITERSEARCH_CONTAINS:
2355 n = 1;
2356 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00002357
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002358 default:
2359 assert(!"unknown operation");
2360 }
2361 }
Tim Peters16a77ad2001-09-08 04:00:12 +00002362
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002363 if (operation == PY_ITERSEARCH_INDEX) {
2364 if (n == PY_SSIZE_T_MAX)
2365 wrapped = 1;
2366 ++n;
2367 }
2368 }
Tim Peters16a77ad2001-09-08 04:00:12 +00002369
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002370 if (operation != PY_ITERSEARCH_INDEX)
2371 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00002372
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002373 PyErr_SetString(PyExc_ValueError,
2374 "sequence.index(x): x not in sequence");
2375 /* fall into failure code */
Tim Peters16a77ad2001-09-08 04:00:12 +00002376Fail:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002377 n = -1;
2378 /* fall through */
Tim Peters16a77ad2001-09-08 04:00:12 +00002379Done:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002380 Py_DECREF(it);
2381 return n;
Tim Peters75f8e352001-05-05 11:33:43 +00002382
Guido van Rossume15dee51995-07-18 14:12:02 +00002383}
2384
Tim Peters16a77ad2001-09-08 04:00:12 +00002385/* Return # of times o appears in s. */
Neal Norwitz1fc4b772006-03-04 18:49:58 +00002386Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00002387PySequence_Count(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002388{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002389 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_COUNT);
Guido van Rossume15dee51995-07-18 14:12:02 +00002390}
2391
Tim Peterscb8d3682001-05-05 21:05:01 +00002392/* Return -1 if error; 1 if ob in seq; 0 if ob not in seq.
Tim Peters16a77ad2001-09-08 04:00:12 +00002393 * Use sq_contains if possible, else defer to _PySequence_IterSearch().
Tim Peterscb8d3682001-05-05 21:05:01 +00002394 */
2395int
2396PySequence_Contains(PyObject *seq, PyObject *ob)
2397{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002398 Py_ssize_t result;
2399 if (PyType_HasFeature(seq->ob_type, Py_TPFLAGS_HAVE_SEQUENCE_IN)) {
2400 PySequenceMethods *sqm = seq->ob_type->tp_as_sequence;
2401 if (sqm != NULL && sqm->sq_contains != NULL)
2402 return (*sqm->sq_contains)(seq, ob);
2403 }
2404 result = _PySequence_IterSearch(seq, ob, PY_ITERSEARCH_CONTAINS);
2405 return Py_SAFE_DOWNCAST(result, Py_ssize_t, int);
Tim Peterscb8d3682001-05-05 21:05:01 +00002406}
2407
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002408/* Backwards compatibility */
2409#undef PySequence_In
2410int
Fred Drake79912472000-07-09 04:06:11 +00002411PySequence_In(PyObject *w, PyObject *v)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002412{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002413 return PySequence_Contains(w, v);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002414}
2415
Neal Norwitz1fc4b772006-03-04 18:49:58 +00002416Py_ssize_t
Fred Drake79912472000-07-09 04:06:11 +00002417PySequence_Index(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002418{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002419 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_INDEX);
Guido van Rossume15dee51995-07-18 14:12:02 +00002420}
2421
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002422/* Operations on mappings */
2423
2424int
Fred Drake79912472000-07-09 04:06:11 +00002425PyMapping_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002426{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002427 if (o && PyInstance_Check(o))
2428 return PyObject_HasAttrString(o, "__getitem__");
Raymond Hettingere2eda602004-04-04 08:51:41 +00002429
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002430 return o && o->ob_type->tp_as_mapping &&
2431 o->ob_type->tp_as_mapping->mp_subscript &&
2432 !(o->ob_type->tp_as_sequence &&
2433 o->ob_type->tp_as_sequence->sq_slice);
Guido van Rossume15dee51995-07-18 14:12:02 +00002434}
2435
Martin v. Löwis18e16552006-02-15 17:27:45 +00002436Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00002437PyMapping_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002438{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002439 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00002440
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002441 if (o == NULL) {
2442 null_error();
2443 return -1;
2444 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002445
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002446 m = o->ob_type->tp_as_mapping;
2447 if (m && m->mp_length)
2448 return m->mp_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00002449
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002450 type_error("object of type '%.200s' has no len()", o);
2451 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00002452}
2453
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002454#undef PyMapping_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00002455Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002456PyMapping_Length(PyObject *o)
2457{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002458 return PyMapping_Size(o);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002459}
2460#define PyMapping_Length PyMapping_Size
2461
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002462PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002463PyMapping_GetItemString(PyObject *o, char *key)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002464{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002465 PyObject *okey, *r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002466
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002467 if (key == NULL)
2468 return null_error();
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002469
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002470 okey = PyString_FromString(key);
2471 if (okey == NULL)
2472 return NULL;
2473 r = PyObject_GetItem(o, okey);
2474 Py_DECREF(okey);
2475 return r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002476}
2477
2478int
Fred Drake79912472000-07-09 04:06:11 +00002479PyMapping_SetItemString(PyObject *o, char *key, PyObject *value)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002480{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002481 PyObject *okey;
2482 int r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002483
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002484 if (key == NULL) {
2485 null_error();
2486 return -1;
2487 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002488
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002489 okey = PyString_FromString(key);
2490 if (okey == NULL)
2491 return -1;
2492 r = PyObject_SetItem(o, okey, value);
2493 Py_DECREF(okey);
2494 return r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002495}
2496
2497int
Fred Drake79912472000-07-09 04:06:11 +00002498PyMapping_HasKeyString(PyObject *o, char *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002499{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002500 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002501
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002502 v = PyMapping_GetItemString(o, key);
2503 if (v) {
2504 Py_DECREF(v);
2505 return 1;
2506 }
2507 PyErr_Clear();
2508 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002509}
2510
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002511int
Fred Drake79912472000-07-09 04:06:11 +00002512PyMapping_HasKey(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002513{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002514 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002515
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002516 v = PyObject_GetItem(o, key);
2517 if (v) {
2518 Py_DECREF(v);
2519 return 1;
2520 }
2521 PyErr_Clear();
2522 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002523}
2524
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002525/* Operations on callable objects */
2526
2527/* XXX PyCallable_Check() is in object.c */
2528
Guido van Rossume15dee51995-07-18 14:12:02 +00002529PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002530PyObject_CallObject(PyObject *o, PyObject *a)
Guido van Rossume15dee51995-07-18 14:12:02 +00002531{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002532 return PyEval_CallObjectWithKeywords(o, a, NULL);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002533}
Guido van Rossume15dee51995-07-18 14:12:02 +00002534
2535PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00002536PyObject_Call(PyObject *func, PyObject *arg, PyObject *kw)
2537{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002538 ternaryfunc call;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002539
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002540 if ((call = func->ob_type->tp_call) != NULL) {
2541 PyObject *result;
2542 if (Py_EnterRecursiveCall(" while calling a Python object"))
2543 return NULL;
2544 result = (*call)(func, arg, kw);
2545 Py_LeaveRecursiveCall();
2546 if (result == NULL && !PyErr_Occurred())
2547 PyErr_SetString(
2548 PyExc_SystemError,
2549 "NULL result without error in PyObject_Call");
2550 return result;
2551 }
2552 PyErr_Format(PyExc_TypeError, "'%.200s' object is not callable",
2553 func->ob_type->tp_name);
2554 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002555}
2556
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002557static PyObject*
2558call_function_tail(PyObject *callable, PyObject *args)
2559{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002560 PyObject *retval;
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002561
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002562 if (args == NULL)
2563 return NULL;
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002564
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002565 if (!PyTuple_Check(args)) {
2566 PyObject *a;
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002567
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002568 a = PyTuple_New(1);
2569 if (a == NULL) {
2570 Py_DECREF(args);
2571 return NULL;
2572 }
2573 PyTuple_SET_ITEM(a, 0, args);
2574 args = a;
2575 }
2576 retval = PyObject_Call(callable, args, NULL);
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002577
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002578 Py_DECREF(args);
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002579
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002580 return retval;
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002581}
2582
Tim Peters6d6c1a32001-08-02 04:15:00 +00002583PyObject *
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002584PyObject_CallFunction(PyObject *callable, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002585{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002586 va_list va;
2587 PyObject *args;
Guido van Rossume15dee51995-07-18 14:12:02 +00002588
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002589 if (callable == NULL)
2590 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002591
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002592 if (format && *format) {
2593 va_start(va, format);
2594 args = Py_VaBuildValue(format, va);
2595 va_end(va);
2596 }
2597 else
2598 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002599
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002600 return call_function_tail(callable, args);
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002601}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002602
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002603PyObject *
2604_PyObject_CallFunction_SizeT(PyObject *callable, char *format, ...)
2605{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002606 va_list va;
2607 PyObject *args;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002608
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002609 if (callable == NULL)
2610 return null_error();
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002611
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002612 if (format && *format) {
2613 va_start(va, format);
2614 args = _Py_VaBuildValue_SizeT(format, va);
2615 va_end(va);
2616 }
2617 else
2618 args = PyTuple_New(0);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002619
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002620 return call_function_tail(callable, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002621}
2622
2623PyObject *
Guido van Rossume15dee51995-07-18 14:12:02 +00002624PyObject_CallMethod(PyObject *o, char *name, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002625{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002626 va_list va;
2627 PyObject *args;
2628 PyObject *func = NULL;
2629 PyObject *retval = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002630
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002631 if (o == NULL || name == NULL)
2632 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002633
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002634 func = PyObject_GetAttrString(o, name);
Benjamin Petersondf71dcb2014-06-26 23:27:41 -07002635 if (func == NULL)
2636 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002637
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002638 if (!PyCallable_Check(func)) {
2639 type_error("attribute of type '%.200s' is not callable", func);
2640 goto exit;
2641 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002642
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002643 if (format && *format) {
2644 va_start(va, format);
2645 args = Py_VaBuildValue(format, va);
2646 va_end(va);
2647 }
2648 else
2649 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002650
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002651 retval = call_function_tail(func, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002652
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002653 exit:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002654 /* args gets consumed in call_function_tail */
2655 Py_XDECREF(func);
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002656
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002657 return retval;
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002658}
2659
2660PyObject *
2661_PyObject_CallMethod_SizeT(PyObject *o, char *name, char *format, ...)
2662{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002663 va_list va;
2664 PyObject *args;
2665 PyObject *func = NULL;
2666 PyObject *retval = NULL;
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002667
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002668 if (o == NULL || name == NULL)
2669 return null_error();
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002670
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002671 func = PyObject_GetAttrString(o, name);
Benjamin Petersondf71dcb2014-06-26 23:27:41 -07002672 if (func == NULL)
2673 return NULL;
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002674
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002675 if (!PyCallable_Check(func)) {
2676 type_error("attribute of type '%.200s' is not callable", func);
2677 goto exit;
2678 }
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002679
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002680 if (format && *format) {
2681 va_start(va, format);
2682 args = _Py_VaBuildValue_SizeT(format, va);
2683 va_end(va);
2684 }
2685 else
2686 args = PyTuple_New(0);
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002687
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002688 retval = call_function_tail(func, args);
Martin v. Löwis5cb69362006-04-14 09:08:42 +00002689
2690 exit:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002691 /* args gets consumed in call_function_tail */
2692 Py_XDECREF(func);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002693
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002694 return retval;
Guido van Rossume15dee51995-07-18 14:12:02 +00002695}
Guido van Rossum823649d2001-03-21 18:40:58 +00002696
2697
Fred Drakeb421b8c2001-10-26 16:21:32 +00002698static PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002699objargs_mktuple(va_list va)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002700{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002701 int i, n = 0;
2702 va_list countva;
2703 PyObject *result, *tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002704
2705#ifdef VA_LIST_IS_ARRAY
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002706 memcpy(countva, va, sizeof(va_list));
Fred Drakeb421b8c2001-10-26 16:21:32 +00002707#else
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002708#ifdef __va_copy
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002709 __va_copy(countva, va);
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002710#else
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002711 countva = va;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002712#endif
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002713#endif
Fred Drakeb421b8c2001-10-26 16:21:32 +00002714
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002715 while (((PyObject *)va_arg(countva, PyObject *)) != NULL)
2716 ++n;
2717 result = PyTuple_New(n);
2718 if (result != NULL && n > 0) {
2719 for (i = 0; i < n; ++i) {
2720 tmp = (PyObject *)va_arg(va, PyObject *);
2721 PyTuple_SET_ITEM(result, i, tmp);
2722 Py_INCREF(tmp);
2723 }
2724 }
2725 return result;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002726}
2727
2728PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002729PyObject_CallMethodObjArgs(PyObject *callable, PyObject *name, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002730{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002731 PyObject *args, *tmp;
2732 va_list vargs;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002733
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002734 if (callable == NULL || name == NULL)
2735 return null_error();
Fred Drakeb421b8c2001-10-26 16:21:32 +00002736
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002737 callable = PyObject_GetAttr(callable, name);
2738 if (callable == NULL)
2739 return NULL;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002740
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002741 /* count the args */
2742 va_start(vargs, name);
2743 args = objargs_mktuple(vargs);
2744 va_end(vargs);
2745 if (args == NULL) {
2746 Py_DECREF(callable);
2747 return NULL;
2748 }
2749 tmp = PyObject_Call(callable, args, NULL);
2750 Py_DECREF(args);
2751 Py_DECREF(callable);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002752
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002753 return tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002754}
2755
2756PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002757PyObject_CallFunctionObjArgs(PyObject *callable, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002758{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002759 PyObject *args, *tmp;
2760 va_list vargs;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002761
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002762 if (callable == NULL)
2763 return null_error();
Fred Drakeb421b8c2001-10-26 16:21:32 +00002764
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002765 /* count the args */
2766 va_start(vargs, callable);
2767 args = objargs_mktuple(vargs);
2768 va_end(vargs);
2769 if (args == NULL)
2770 return NULL;
2771 tmp = PyObject_Call(callable, args, NULL);
2772 Py_DECREF(args);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002773
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002774 return tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002775}
2776
2777
Guido van Rossum823649d2001-03-21 18:40:58 +00002778/* isinstance(), issubclass() */
2779
Barry Warsawf16951c2002-04-23 22:45:44 +00002780/* abstract_get_bases() has logically 4 return states, with a sort of 0th
2781 * state that will almost never happen.
2782 *
2783 * 0. creating the __bases__ static string could get a MemoryError
2784 * 1. getattr(cls, '__bases__') could raise an AttributeError
2785 * 2. getattr(cls, '__bases__') could raise some other exception
2786 * 3. getattr(cls, '__bases__') could return a tuple
2787 * 4. getattr(cls, '__bases__') could return something other than a tuple
2788 *
2789 * Only state #3 is a non-error state and only it returns a non-NULL object
2790 * (it returns the retrieved tuple).
2791 *
2792 * Any raised AttributeErrors are masked by clearing the exception and
2793 * returning NULL. If an object other than a tuple comes out of __bases__,
2794 * then again, the return value is NULL. So yes, these two situations
2795 * produce exactly the same results: NULL is returned and no error is set.
2796 *
2797 * If some exception other than AttributeError is raised, then NULL is also
2798 * returned, but the exception is not cleared. That's because we want the
2799 * exception to be propagated along.
2800 *
2801 * Callers are expected to test for PyErr_Occurred() when the return value
2802 * is NULL to decide whether a valid exception should be propagated or not.
2803 * When there's no exception to propagate, it's customary for the caller to
2804 * set a TypeError.
2805 */
Neil Schemenauer6b471292001-10-18 03:18:43 +00002806static PyObject *
2807abstract_get_bases(PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002808{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002809 static PyObject *__bases__ = NULL;
2810 PyObject *bases;
Guido van Rossum823649d2001-03-21 18:40:58 +00002811
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002812 if (__bases__ == NULL) {
2813 __bases__ = PyString_InternFromString("__bases__");
2814 if (__bases__ == NULL)
2815 return NULL;
2816 }
2817 bases = PyObject_GetAttr(cls, __bases__);
2818 if (bases == NULL) {
2819 if (PyErr_ExceptionMatches(PyExc_AttributeError))
2820 PyErr_Clear();
2821 return NULL;
2822 }
2823 if (!PyTuple_Check(bases)) {
2824 Py_DECREF(bases);
2825 return NULL;
2826 }
2827 return bases;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002828}
2829
2830
2831static int
2832abstract_issubclass(PyObject *derived, PyObject *cls)
2833{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002834 PyObject *bases = NULL;
2835 Py_ssize_t i, n;
2836 int r = 0;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002837
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002838 while (1) {
2839 if (derived == cls)
2840 return 1;
2841 bases = abstract_get_bases(derived);
2842 if (bases == NULL) {
2843 if (PyErr_Occurred())
2844 return -1;
2845 return 0;
2846 }
2847 n = PyTuple_GET_SIZE(bases);
2848 if (n == 0) {
2849 Py_DECREF(bases);
2850 return 0;
2851 }
2852 /* Avoid recursivity in the single inheritance case */
2853 if (n == 1) {
2854 derived = PyTuple_GET_ITEM(bases, 0);
2855 Py_DECREF(bases);
2856 continue;
2857 }
2858 for (i = 0; i < n; i++) {
2859 r = abstract_issubclass(PyTuple_GET_ITEM(bases, i), cls);
2860 if (r != 0)
2861 break;
2862 }
2863 Py_DECREF(bases);
2864 return r;
2865 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002866}
2867
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002868static int
2869check_class(PyObject *cls, const char *error)
2870{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002871 PyObject *bases = abstract_get_bases(cls);
2872 if (bases == NULL) {
2873 /* Do not mask errors. */
2874 if (!PyErr_Occurred())
2875 PyErr_SetString(PyExc_TypeError, error);
2876 return 0;
2877 }
2878 Py_DECREF(bases);
2879 return -1;
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002880}
2881
Brett Cannon4f653312004-03-20 22:52:14 +00002882static int
Antoine Pitrou0668c622008-08-26 22:42:08 +00002883recursive_isinstance(PyObject *inst, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002884{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002885 PyObject *icls;
2886 static PyObject *__class__ = NULL;
2887 int retval = 0;
Guido van Rossum823649d2001-03-21 18:40:58 +00002888
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002889 if (__class__ == NULL) {
2890 __class__ = PyString_InternFromString("__class__");
2891 if (__class__ == NULL)
2892 return -1;
2893 }
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002894
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002895 if (PyClass_Check(cls) && PyInstance_Check(inst)) {
2896 PyObject *inclass =
2897 (PyObject*)((PyInstanceObject*)inst)->in_class;
2898 retval = PyClass_IsSubclass(inclass, cls);
2899 }
2900 else if (PyType_Check(cls)) {
2901 retval = PyObject_TypeCheck(inst, (PyTypeObject *)cls);
2902 if (retval == 0) {
2903 PyObject *c = PyObject_GetAttr(inst, __class__);
2904 if (c == NULL) {
2905 PyErr_Clear();
2906 }
2907 else {
2908 if (c != (PyObject *)(inst->ob_type) &&
2909 PyType_Check(c))
2910 retval = PyType_IsSubtype(
2911 (PyTypeObject *)c,
2912 (PyTypeObject *)cls);
2913 Py_DECREF(c);
2914 }
2915 }
2916 }
2917 else {
2918 if (!check_class(cls,
2919 "isinstance() arg 2 must be a class, type,"
2920 " or tuple of classes and types"))
2921 return -1;
2922 icls = PyObject_GetAttr(inst, __class__);
2923 if (icls == NULL) {
2924 PyErr_Clear();
2925 retval = 0;
2926 }
2927 else {
2928 retval = abstract_issubclass(icls, cls);
2929 Py_DECREF(icls);
2930 }
2931 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002932
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002933 return retval;
Guido van Rossum823649d2001-03-21 18:40:58 +00002934}
2935
2936int
Brett Cannon4f653312004-03-20 22:52:14 +00002937PyObject_IsInstance(PyObject *inst, PyObject *cls)
2938{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002939 static PyObject *name = NULL;
Raymond Hettinger9a47e622008-03-18 23:22:29 +00002940
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002941 /* Quick test for an exact match */
2942 if (Py_TYPE(inst) == (PyTypeObject *)cls)
2943 return 1;
Raymond Hettinger9a47e622008-03-18 23:22:29 +00002944
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002945 if (PyTuple_Check(cls)) {
2946 Py_ssize_t i;
2947 Py_ssize_t n;
2948 int r = 0;
Antoine Pitrou0668c622008-08-26 22:42:08 +00002949
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002950 if (Py_EnterRecursiveCall(" in __instancecheck__"))
2951 return -1;
2952 n = PyTuple_GET_SIZE(cls);
2953 for (i = 0; i < n; ++i) {
2954 PyObject *item = PyTuple_GET_ITEM(cls, i);
2955 r = PyObject_IsInstance(inst, item);
2956 if (r != 0)
2957 /* either found it, or got an error */
2958 break;
2959 }
2960 Py_LeaveRecursiveCall();
2961 return r;
2962 }
Benjamin Petersonfb6fb062009-05-16 21:44:25 +00002963
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002964 if (!(PyClass_Check(cls) || PyInstance_Check(cls))) {
2965 PyObject *checker;
2966 checker = _PyObject_LookupSpecial(cls, "__instancecheck__", &name);
2967 if (checker != NULL) {
2968 PyObject *res;
2969 int ok = -1;
2970 if (Py_EnterRecursiveCall(" in __instancecheck__")) {
2971 Py_DECREF(checker);
2972 return ok;
2973 }
2974 res = PyObject_CallFunctionObjArgs(checker, inst, NULL);
2975 Py_LeaveRecursiveCall();
2976 Py_DECREF(checker);
2977 if (res != NULL) {
2978 ok = PyObject_IsTrue(res);
2979 Py_DECREF(res);
2980 }
2981 return ok;
2982 }
2983 else if (PyErr_Occurred())
2984 return -1;
2985 }
2986 return recursive_isinstance(inst, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002987}
2988
2989static int
Antoine Pitrou0668c622008-08-26 22:42:08 +00002990recursive_issubclass(PyObject *derived, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002991{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002992 int retval;
Guido van Rossum823649d2001-03-21 18:40:58 +00002993
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002994 if (PyType_Check(cls) && PyType_Check(derived)) {
2995 /* Fast path (non-recursive) */
2996 return PyType_IsSubtype(
2997 (PyTypeObject *)derived, (PyTypeObject *)cls);
2998 }
2999 if (!PyClass_Check(derived) || !PyClass_Check(cls)) {
3000 if (!check_class(derived,
3001 "issubclass() arg 1 must be a class"))
3002 return -1;
Neil Schemenauer6b471292001-10-18 03:18:43 +00003003
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003004 if (!check_class(cls,
3005 "issubclass() arg 2 must be a class"
3006 " or tuple of classes"))
3007 return -1;
3008 retval = abstract_issubclass(derived, cls);
3009 }
3010 else {
3011 /* shortcut */
3012 if (!(retval = (derived == cls)))
3013 retval = PyClass_IsSubclass(derived, cls);
3014 }
Guido van Rossum823649d2001-03-21 18:40:58 +00003015
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003016 return retval;
Guido van Rossum823649d2001-03-21 18:40:58 +00003017}
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00003018
Brett Cannon4f653312004-03-20 22:52:14 +00003019int
3020PyObject_IsSubclass(PyObject *derived, PyObject *cls)
3021{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003022 static PyObject *name = NULL;
3023
3024 if (PyTuple_Check(cls)) {
3025 Py_ssize_t i;
3026 Py_ssize_t n;
3027 int r = 0;
3028
3029 if (Py_EnterRecursiveCall(" in __subclasscheck__"))
3030 return -1;
3031 n = PyTuple_GET_SIZE(cls);
3032 for (i = 0; i < n; ++i) {
3033 PyObject *item = PyTuple_GET_ITEM(cls, i);
3034 r = PyObject_IsSubclass(derived, item);
3035 if (r != 0)
3036 /* either found it, or got an error */
3037 break;
3038 }
3039 Py_LeaveRecursiveCall();
3040 return r;
3041 }
3042 if (!(PyClass_Check(cls) || PyInstance_Check(cls))) {
3043 PyObject *checker;
3044 checker = _PyObject_LookupSpecial(cls, "__subclasscheck__", &name);
3045 if (checker != NULL) {
3046 PyObject *res;
3047 int ok = -1;
3048 if (Py_EnterRecursiveCall(" in __subclasscheck__")) {
3049 Py_DECREF(checker);
3050 return ok;
3051 }
3052 res = PyObject_CallFunctionObjArgs(checker, derived, NULL);
3053 Py_LeaveRecursiveCall();
3054 Py_DECREF(checker);
3055 if (res != NULL) {
3056 ok = PyObject_IsTrue(res);
3057 Py_DECREF(res);
3058 }
3059 return ok;
3060 }
3061 else if (PyErr_Occurred()) {
3062 return -1;
3063 }
3064 }
3065 return recursive_issubclass(derived, cls);
Antoine Pitrou0668c622008-08-26 22:42:08 +00003066}
3067
3068int
3069_PyObject_RealIsInstance(PyObject *inst, PyObject *cls)
3070{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003071 return recursive_isinstance(inst, cls);
Antoine Pitrou0668c622008-08-26 22:42:08 +00003072}
3073
3074int
3075_PyObject_RealIsSubclass(PyObject *derived, PyObject *cls)
3076{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003077 return recursive_issubclass(derived, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00003078}
3079
3080
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00003081PyObject *
3082PyObject_GetIter(PyObject *o)
3083{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003084 PyTypeObject *t = o->ob_type;
3085 getiterfunc f = NULL;
3086 if (PyType_HasFeature(t, Py_TPFLAGS_HAVE_ITER))
3087 f = t->tp_iter;
3088 if (f == NULL) {
3089 if (PySequence_Check(o))
3090 return PySeqIter_New(o);
3091 return type_error("'%.200s' object is not iterable", o);
3092 }
3093 else {
3094 PyObject *res = (*f)(o);
3095 if (res != NULL && !PyIter_Check(res)) {
3096 PyErr_Format(PyExc_TypeError,
3097 "iter() returned non-iterator "
3098 "of type '%.100s'",
3099 res->ob_type->tp_name);
3100 Py_DECREF(res);
3101 res = NULL;
3102 }
3103 return res;
3104 }
Guido van Rossum213c7a62001-04-23 14:08:49 +00003105}
3106
Tim Petersf4848da2001-05-05 00:14:56 +00003107/* Return next item.
3108 * If an error occurs, return NULL. PyErr_Occurred() will be true.
3109 * If the iteration terminates normally, return NULL and clear the
3110 * PyExc_StopIteration exception (if it was set). PyErr_Occurred()
3111 * will be false.
3112 * Else return the next object. PyErr_Occurred() will be false.
3113 */
Guido van Rossum213c7a62001-04-23 14:08:49 +00003114PyObject *
3115PyIter_Next(PyObject *iter)
3116{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003117 PyObject *result;
3118 result = (*iter->ob_type->tp_iternext)(iter);
3119 if (result == NULL &&
3120 PyErr_Occurred() &&
3121 PyErr_ExceptionMatches(PyExc_StopIteration))
3122 PyErr_Clear();
3123 return result;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00003124}