blob: 4737d5434dd92775bb00973cc60d721e75c92bd8 [file] [log] [blame]
Guido van Rossume15dee51995-07-18 14:12:02 +00001/* Abstract Object Interface (many thanks to Jim Fulton) */
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002
Guido van Rossume15dee51995-07-18 14:12:02 +00003#include "Python.h"
Guido van Rossumfa0b6ab1998-05-22 15:23:36 +00004#include <ctype.h>
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00005#include "structmember.h" /* we need the offsetof() macro from there */
Tim Peters64b5ce32001-09-10 20:52:51 +00006#include "longintrepr.h"
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00007
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00008
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00009
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000010/* Shorthands to return certain errors */
Guido van Rossume15dee51995-07-18 14:12:02 +000011
12static PyObject *
Thomas Wouters0e3f5912006-08-11 14:57:12 +000013type_error(const char *msg, PyObject *obj)
Guido van Rossume15dee51995-07-18 14:12:02 +000014{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000015 PyErr_Format(PyExc_TypeError, msg, obj->ob_type->tp_name);
16 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +000017}
18
Guido van Rossum052b7e11996-11-11 15:08:19 +000019static PyObject *
Fred Drake79912472000-07-09 04:06:11 +000020null_error(void)
Guido van Rossume15dee51995-07-18 14:12:02 +000021{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000022 if (!PyErr_Occurred())
23 PyErr_SetString(PyExc_SystemError,
24 "null argument to internal routine");
25 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +000026}
27
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000028/* Operations on any object */
29
Guido van Rossume15dee51995-07-18 14:12:02 +000030PyObject *
Fred Drake79912472000-07-09 04:06:11 +000031PyObject_Type(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +000032{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000033 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +000034
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000035 if (o == NULL)
36 return null_error();
37 v = (PyObject *)o->ob_type;
38 Py_INCREF(v);
39 return v;
Guido van Rossume15dee51995-07-18 14:12:02 +000040}
41
Martin v. Löwis18e16552006-02-15 17:27:45 +000042Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +000043PyObject_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +000044{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000045 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +000046
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000047 if (o == NULL) {
48 null_error();
49 return -1;
50 }
Guido van Rossume15dee51995-07-18 14:12:02 +000051
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000052 m = o->ob_type->tp_as_sequence;
53 if (m && m->sq_length)
54 return m->sq_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +000055
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000056 return PyMapping_Size(o);
Guido van Rossume15dee51995-07-18 14:12:02 +000057}
58
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000059#undef PyObject_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +000060Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000061PyObject_Length(PyObject *o)
62{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000063 return PyObject_Size(o);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000064}
65#define PyObject_Length PyObject_Size
66
Raymond Hettinger6b27cda2005-09-24 21:23:05 +000067
Christian Heimes255f53b2007-12-08 15:33:56 +000068/* The length hint function returns a non-negative value from o.__len__()
69 or o.__length_hint__(). If those methods aren't found or return a negative
Raymond Hettingere8364232009-02-02 22:55:09 +000070 value, then the defaultvalue is returned. If one of the calls fails,
71 this function returns -1.
Christian Heimes255f53b2007-12-08 15:33:56 +000072*/
73
74Py_ssize_t
75_PyObject_LengthHint(PyObject *o, Py_ssize_t defaultvalue)
76{
Benjamin Petersonce798522012-01-22 11:24:29 -050077 _Py_IDENTIFIER(__length_hint__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000078 PyObject *ro, *hintmeth;
79 Py_ssize_t rv;
Christian Heimes255f53b2007-12-08 15:33:56 +000080
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000081 /* try o.__len__() */
82 rv = PyObject_Size(o);
83 if (rv >= 0)
84 return rv;
85 if (PyErr_Occurred()) {
86 if (!PyErr_ExceptionMatches(PyExc_TypeError))
87 return -1;
88 PyErr_Clear();
89 }
Christian Heimes255f53b2007-12-08 15:33:56 +000090
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000091 /* try o.__length_hint__() */
Benjamin Petersonce798522012-01-22 11:24:29 -050092 hintmeth = _PyObject_LookupSpecial(o, &PyId___length_hint__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000093 if (hintmeth == NULL) {
94 if (PyErr_Occurred())
95 return -1;
96 else
97 return defaultvalue;
98 }
99 ro = PyObject_CallFunctionObjArgs(hintmeth, NULL);
100 Py_DECREF(hintmeth);
101 if (ro == NULL) {
102 if (!PyErr_ExceptionMatches(PyExc_TypeError))
103 return -1;
104 PyErr_Clear();
105 return defaultvalue;
106 }
107 rv = PyLong_Check(ro) ? PyLong_AsSsize_t(ro) : defaultvalue;
108 Py_DECREF(ro);
109 return rv;
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000110}
111
Guido van Rossume15dee51995-07-18 14:12:02 +0000112PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000113PyObject_GetItem(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +0000114{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000115 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +0000116
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000117 if (o == NULL || key == NULL)
118 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +0000119
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000120 m = o->ob_type->tp_as_mapping;
121 if (m && m->mp_subscript)
122 return m->mp_subscript(o, key);
Guido van Rossume15dee51995-07-18 14:12:02 +0000123
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000124 if (o->ob_type->tp_as_sequence) {
125 if (PyIndex_Check(key)) {
126 Py_ssize_t key_value;
127 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
128 if (key_value == -1 && PyErr_Occurred())
129 return NULL;
130 return PySequence_GetItem(o, key_value);
131 }
132 else if (o->ob_type->tp_as_sequence->sq_item)
133 return type_error("sequence index must "
134 "be integer, not '%.200s'", key);
135 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000136
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000137 return type_error("'%.200s' object is not subscriptable", o);
Guido van Rossume15dee51995-07-18 14:12:02 +0000138}
139
140int
Fred Drake79912472000-07-09 04:06:11 +0000141PyObject_SetItem(PyObject *o, PyObject *key, PyObject *value)
Guido van Rossume15dee51995-07-18 14:12:02 +0000142{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000143 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +0000144
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000145 if (o == NULL || key == NULL || value == NULL) {
146 null_error();
147 return -1;
148 }
149 m = o->ob_type->tp_as_mapping;
150 if (m && m->mp_ass_subscript)
151 return m->mp_ass_subscript(o, key, value);
Guido van Rossume15dee51995-07-18 14:12:02 +0000152
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000153 if (o->ob_type->tp_as_sequence) {
154 if (PyIndex_Check(key)) {
155 Py_ssize_t key_value;
156 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
157 if (key_value == -1 && PyErr_Occurred())
158 return -1;
159 return PySequence_SetItem(o, key_value, value);
160 }
161 else if (o->ob_type->tp_as_sequence->sq_ass_item) {
162 type_error("sequence index must be "
163 "integer, not '%.200s'", key);
164 return -1;
165 }
166 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000167
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000168 type_error("'%.200s' object does not support item assignment", o);
169 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +0000170}
171
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000172int
Fred Drake79912472000-07-09 04:06:11 +0000173PyObject_DelItem(PyObject *o, PyObject *key)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000174{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000175 PyMappingMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000176
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000177 if (o == NULL || key == NULL) {
178 null_error();
179 return -1;
180 }
181 m = o->ob_type->tp_as_mapping;
182 if (m && m->mp_ass_subscript)
183 return m->mp_ass_subscript(o, key, (PyObject*)NULL);
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000184
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000185 if (o->ob_type->tp_as_sequence) {
186 if (PyIndex_Check(key)) {
187 Py_ssize_t key_value;
188 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
189 if (key_value == -1 && PyErr_Occurred())
190 return -1;
191 return PySequence_DelItem(o, key_value);
192 }
193 else if (o->ob_type->tp_as_sequence->sq_ass_item) {
194 type_error("sequence index must be "
195 "integer, not '%.200s'", key);
196 return -1;
197 }
198 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000199
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000200 type_error("'%.200s' object does not support item deletion", o);
201 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000202}
203
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000204int
205PyObject_DelItemString(PyObject *o, char *key)
206{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000207 PyObject *okey;
208 int ret;
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000209
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000210 if (o == NULL || key == NULL) {
211 null_error();
212 return -1;
213 }
214 okey = PyUnicode_FromString(key);
215 if (okey == NULL)
216 return -1;
217 ret = PyObject_DelItem(o, okey);
218 Py_DECREF(okey);
219 return ret;
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000220}
221
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000222/* We release the buffer right after use of this function which could
Guido van Rossum98297ee2007-11-06 21:34:58 +0000223 cause issues later on. Don't use these functions in new code.
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000224 */
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000225int
226PyObject_AsCharBuffer(PyObject *obj,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000227 const char **buffer,
228 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000229{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000230 PyBufferProcs *pb;
231 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000232
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000233 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
234 null_error();
235 return -1;
236 }
237 pb = obj->ob_type->tp_as_buffer;
238 if (pb == NULL || pb->bf_getbuffer == NULL) {
239 PyErr_SetString(PyExc_TypeError,
Victor Stinnerf2a94212011-05-30 23:21:30 +0200240 "expected bytes, bytearray "
241 "or buffer compatible object");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000242 return -1;
243 }
244 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE)) return -1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000245
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000246 *buffer = view.buf;
247 *buffer_len = view.len;
248 if (pb->bf_releasebuffer != NULL)
249 (*pb->bf_releasebuffer)(obj, &view);
250 Py_XDECREF(view.obj);
251 return 0;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000252}
Guido van Rossum4c08d552000-03-10 22:55:18 +0000253
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000254int
255PyObject_CheckReadBuffer(PyObject *obj)
256{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000257 PyBufferProcs *pb = obj->ob_type->tp_as_buffer;
258 Py_buffer view;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000259
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000260 if (pb == NULL ||
261 pb->bf_getbuffer == NULL)
262 return 0;
263 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE) == -1) {
264 PyErr_Clear();
265 return 0;
266 }
267 PyBuffer_Release(&view);
268 return 1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000269}
270
271int PyObject_AsReadBuffer(PyObject *obj,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000272 const void **buffer,
273 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000274{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000275 PyBufferProcs *pb;
276 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000277
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000278 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
279 null_error();
280 return -1;
281 }
282 pb = obj->ob_type->tp_as_buffer;
283 if (pb == NULL ||
284 pb->bf_getbuffer == NULL) {
285 PyErr_SetString(PyExc_TypeError,
286 "expected an object with a buffer interface");
287 return -1;
288 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000289
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000290 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE)) return -1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000291
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000292 *buffer = view.buf;
293 *buffer_len = view.len;
294 if (pb->bf_releasebuffer != NULL)
295 (*pb->bf_releasebuffer)(obj, &view);
296 Py_XDECREF(view.obj);
297 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000298}
299
300int PyObject_AsWriteBuffer(PyObject *obj,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000301 void **buffer,
302 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000303{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000304 PyBufferProcs *pb;
305 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000306
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000307 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
308 null_error();
309 return -1;
310 }
311 pb = obj->ob_type->tp_as_buffer;
312 if (pb == NULL ||
313 pb->bf_getbuffer == NULL ||
314 ((*pb->bf_getbuffer)(obj, &view, PyBUF_WRITABLE) != 0)) {
315 PyErr_SetString(PyExc_TypeError,
316 "expected an object with a writable buffer interface");
317 return -1;
318 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000319
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000320 *buffer = view.buf;
321 *buffer_len = view.len;
322 if (pb->bf_releasebuffer != NULL)
323 (*pb->bf_releasebuffer)(obj, &view);
324 Py_XDECREF(view.obj);
325 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000326}
327
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000328/* Buffer C-API for Python 3.0 */
329
330int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000331PyObject_GetBuffer(PyObject *obj, Py_buffer *view, int flags)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000332{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000333 if (!PyObject_CheckBuffer(obj)) {
334 PyErr_Format(PyExc_TypeError,
Victor Stinner0a5f65a2011-03-22 01:09:21 +0100335 "'%.100s' does not support the buffer interface",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000336 Py_TYPE(obj)->tp_name);
337 return -1;
338 }
339 return (*(obj->ob_type->tp_as_buffer->bf_getbuffer))(obj, view, flags);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000340}
341
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000342static int
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100343_IsFortranContiguous(const Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000344{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000345 Py_ssize_t sd, dim;
346 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000347
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000348 if (view->ndim == 0) return 1;
349 if (view->strides == NULL) return (view->ndim == 1);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000350
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000351 sd = view->itemsize;
352 if (view->ndim == 1) return (view->shape[0] == 1 ||
353 sd == view->strides[0]);
354 for (i=0; i<view->ndim; i++) {
355 dim = view->shape[i];
356 if (dim == 0) return 1;
357 if (view->strides[i] != sd) return 0;
358 sd *= dim;
359 }
360 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000361}
362
363static int
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100364_IsCContiguous(const Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000365{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000366 Py_ssize_t sd, dim;
367 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000368
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000369 if (view->ndim == 0) return 1;
370 if (view->strides == NULL) return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000371
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000372 sd = view->itemsize;
373 if (view->ndim == 1) return (view->shape[0] == 1 ||
374 sd == view->strides[0]);
375 for (i=view->ndim-1; i>=0; i--) {
376 dim = view->shape[i];
377 if (dim == 0) return 1;
378 if (view->strides[i] != sd) return 0;
379 sd *= dim;
380 }
381 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000382}
383
384int
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100385PyBuffer_IsContiguous(const Py_buffer *view, char order)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000386{
387
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000388 if (view->suboffsets != NULL) return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000389
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100390 if (order == 'C')
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000391 return _IsCContiguous(view);
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100392 else if (order == 'F')
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000393 return _IsFortranContiguous(view);
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100394 else if (order == 'A')
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000395 return (_IsCContiguous(view) || _IsFortranContiguous(view));
396 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000397}
398
399
Guido van Rossum98297ee2007-11-06 21:34:58 +0000400void*
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000401PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000402{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000403 char* pointer;
404 int i;
405 pointer = (char *)view->buf;
406 for (i = 0; i < view->ndim; i++) {
407 pointer += view->strides[i]*indices[i];
408 if ((view->suboffsets != NULL) && (view->suboffsets[i] >= 0)) {
409 pointer = *((char**)pointer) + view->suboffsets[i];
410 }
411 }
412 return (void*)pointer;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000413}
414
415
Guido van Rossum98297ee2007-11-06 21:34:58 +0000416void
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000417_Py_add_one_to_index_F(int nd, Py_ssize_t *index, const Py_ssize_t *shape)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000418{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000419 int k;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000420
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000421 for (k=0; k<nd; k++) {
422 if (index[k] < shape[k]-1) {
423 index[k]++;
424 break;
425 }
426 else {
427 index[k] = 0;
428 }
429 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000430}
431
Guido van Rossum98297ee2007-11-06 21:34:58 +0000432void
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000433_Py_add_one_to_index_C(int nd, Py_ssize_t *index, const Py_ssize_t *shape)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000434{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000435 int k;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000436
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000437 for (k=nd-1; k>=0; k--) {
438 if (index[k] < shape[k]-1) {
439 index[k]++;
440 break;
441 }
442 else {
443 index[k] = 0;
444 }
445 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000446}
447
448 /* view is not checked for consistency in either of these. It is
Guido van Rossum98297ee2007-11-06 21:34:58 +0000449 assumed that the size of the buffer is view->len in
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000450 view->len / view->itemsize elements.
451 */
452
Guido van Rossum98297ee2007-11-06 21:34:58 +0000453int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000454PyBuffer_ToContiguous(void *buf, Py_buffer *view, Py_ssize_t len, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000455{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000456 int k;
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000457 void (*addone)(int, Py_ssize_t *, const Py_ssize_t *);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000458 Py_ssize_t *indices, elements;
459 char *dest, *ptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000460
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000461 if (len > view->len) {
462 len = view->len;
463 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000464
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000465 if (PyBuffer_IsContiguous(view, fort)) {
466 /* simplest copy is all that is needed */
467 memcpy(buf, view->buf, len);
468 return 0;
469 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000470
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000471 /* Otherwise a more elaborate scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000472
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000473 /* XXX(nnorwitz): need to check for overflow! */
474 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
475 if (indices == NULL) {
476 PyErr_NoMemory();
477 return -1;
478 }
479 for (k=0; k<view->ndim;k++) {
480 indices[k] = 0;
481 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000482
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000483 if (fort == 'F') {
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000484 addone = _Py_add_one_to_index_F;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000485 }
486 else {
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000487 addone = _Py_add_one_to_index_C;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000488 }
489 dest = buf;
490 /* XXX : This is not going to be the fastest code in the world
491 several optimizations are possible.
492 */
493 elements = len / view->itemsize;
494 while (elements--) {
495 addone(view->ndim, indices, view->shape);
496 ptr = PyBuffer_GetPointer(view, indices);
497 memcpy(dest, ptr, view->itemsize);
498 dest += view->itemsize;
499 }
500 PyMem_Free(indices);
501 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000502}
503
504int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000505PyBuffer_FromContiguous(Py_buffer *view, void *buf, Py_ssize_t len, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000506{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000507 int k;
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000508 void (*addone)(int, Py_ssize_t *, const Py_ssize_t *);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000509 Py_ssize_t *indices, elements;
510 char *src, *ptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000511
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000512 if (len > view->len) {
513 len = view->len;
514 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000515
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000516 if (PyBuffer_IsContiguous(view, fort)) {
517 /* simplest copy is all that is needed */
518 memcpy(view->buf, buf, len);
519 return 0;
520 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000521
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000522 /* Otherwise a more elaborate scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000523
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000524 /* XXX(nnorwitz): need to check for overflow! */
525 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
526 if (indices == NULL) {
527 PyErr_NoMemory();
528 return -1;
529 }
530 for (k=0; k<view->ndim;k++) {
531 indices[k] = 0;
532 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000533
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000534 if (fort == 'F') {
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000535 addone = _Py_add_one_to_index_F;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000536 }
537 else {
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000538 addone = _Py_add_one_to_index_C;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000539 }
540 src = buf;
541 /* XXX : This is not going to be the fastest code in the world
542 several optimizations are possible.
543 */
544 elements = len / view->itemsize;
545 while (elements--) {
546 addone(view->ndim, indices, view->shape);
547 ptr = PyBuffer_GetPointer(view, indices);
548 memcpy(ptr, src, view->itemsize);
549 src += view->itemsize;
550 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000551
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000552 PyMem_Free(indices);
553 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000554}
555
Guido van Rossum98297ee2007-11-06 21:34:58 +0000556int PyObject_CopyData(PyObject *dest, PyObject *src)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000557{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000558 Py_buffer view_dest, view_src;
559 int k;
560 Py_ssize_t *indices, elements;
561 char *dptr, *sptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000562
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000563 if (!PyObject_CheckBuffer(dest) ||
564 !PyObject_CheckBuffer(src)) {
565 PyErr_SetString(PyExc_TypeError,
566 "both destination and source must have the "\
567 "buffer interface");
568 return -1;
569 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000570
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000571 if (PyObject_GetBuffer(dest, &view_dest, PyBUF_FULL) != 0) return -1;
572 if (PyObject_GetBuffer(src, &view_src, PyBUF_FULL_RO) != 0) {
573 PyBuffer_Release(&view_dest);
574 return -1;
575 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000576
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000577 if (view_dest.len < view_src.len) {
578 PyErr_SetString(PyExc_BufferError,
579 "destination is too small to receive data from source");
580 PyBuffer_Release(&view_dest);
581 PyBuffer_Release(&view_src);
582 return -1;
583 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000584
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000585 if ((PyBuffer_IsContiguous(&view_dest, 'C') &&
586 PyBuffer_IsContiguous(&view_src, 'C')) ||
587 (PyBuffer_IsContiguous(&view_dest, 'F') &&
588 PyBuffer_IsContiguous(&view_src, 'F'))) {
589 /* simplest copy is all that is needed */
590 memcpy(view_dest.buf, view_src.buf, view_src.len);
591 PyBuffer_Release(&view_dest);
592 PyBuffer_Release(&view_src);
593 return 0;
594 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000595
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000596 /* Otherwise a more elaborate copy scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000597
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000598 /* XXX(nnorwitz): need to check for overflow! */
599 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*view_src.ndim);
600 if (indices == NULL) {
601 PyErr_NoMemory();
602 PyBuffer_Release(&view_dest);
603 PyBuffer_Release(&view_src);
604 return -1;
605 }
606 for (k=0; k<view_src.ndim;k++) {
607 indices[k] = 0;
608 }
609 elements = 1;
610 for (k=0; k<view_src.ndim; k++) {
611 /* XXX(nnorwitz): can this overflow? */
612 elements *= view_src.shape[k];
613 }
614 while (elements--) {
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000615 _Py_add_one_to_index_C(view_src.ndim, indices, view_src.shape);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000616 dptr = PyBuffer_GetPointer(&view_dest, indices);
617 sptr = PyBuffer_GetPointer(&view_src, indices);
618 memcpy(dptr, sptr, view_src.itemsize);
619 }
620 PyMem_Free(indices);
621 PyBuffer_Release(&view_dest);
622 PyBuffer_Release(&view_src);
623 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000624}
625
626void
627PyBuffer_FillContiguousStrides(int nd, Py_ssize_t *shape,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000628 Py_ssize_t *strides, int itemsize,
629 char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000630{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000631 int k;
632 Py_ssize_t sd;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000633
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000634 sd = itemsize;
635 if (fort == 'F') {
636 for (k=0; k<nd; k++) {
637 strides[k] = sd;
638 sd *= shape[k];
639 }
640 }
641 else {
642 for (k=nd-1; k>=0; k--) {
643 strides[k] = sd;
644 sd *= shape[k];
645 }
646 }
647 return;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000648}
649
650int
Martin v. Löwis423be952008-08-13 15:53:07 +0000651PyBuffer_FillInfo(Py_buffer *view, PyObject *obj, void *buf, Py_ssize_t len,
Stefan Krah4e141742012-03-06 15:27:31 +0100652 int readonly, int flags)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000653{
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100654 if (view == NULL) return 0; /* XXX why not -1? */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000655 if (((flags & PyBUF_WRITABLE) == PyBUF_WRITABLE) &&
656 (readonly == 1)) {
657 PyErr_SetString(PyExc_BufferError,
658 "Object is not writable.");
659 return -1;
660 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000661
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000662 view->obj = obj;
663 if (obj)
664 Py_INCREF(obj);
665 view->buf = buf;
666 view->len = len;
667 view->readonly = readonly;
668 view->itemsize = 1;
669 view->format = NULL;
670 if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT)
671 view->format = "B";
672 view->ndim = 1;
673 view->shape = NULL;
674 if ((flags & PyBUF_ND) == PyBUF_ND)
675 view->shape = &(view->len);
676 view->strides = NULL;
677 if ((flags & PyBUF_STRIDES) == PyBUF_STRIDES)
678 view->strides = &(view->itemsize);
679 view->suboffsets = NULL;
680 view->internal = NULL;
681 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000682}
683
Martin v. Löwis423be952008-08-13 15:53:07 +0000684void
685PyBuffer_Release(Py_buffer *view)
686{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000687 PyObject *obj = view->obj;
688 if (obj && Py_TYPE(obj)->tp_as_buffer && Py_TYPE(obj)->tp_as_buffer->bf_releasebuffer)
689 Py_TYPE(obj)->tp_as_buffer->bf_releasebuffer(obj, view);
690 Py_XDECREF(obj);
691 view->obj = NULL;
Martin v. Löwis423be952008-08-13 15:53:07 +0000692}
693
Eric Smith8fd3eba2008-02-17 19:48:00 +0000694PyObject *
695PyObject_Format(PyObject *obj, PyObject *format_spec)
696{
Eric Smith8fd3eba2008-02-17 19:48:00 +0000697 PyObject *meth;
698 PyObject *empty = NULL;
699 PyObject *result = NULL;
Benjamin Petersonce798522012-01-22 11:24:29 -0500700 _Py_IDENTIFIER(__format__);
Eric Smith8fd3eba2008-02-17 19:48:00 +0000701
702 /* If no format_spec is provided, use an empty string */
703 if (format_spec == NULL) {
Victor Stinner9d3b93b2011-11-22 02:27:30 +0100704 empty = PyUnicode_New(0, 0);
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000705 format_spec = empty;
Eric Smith8fd3eba2008-02-17 19:48:00 +0000706 }
707
Eric Smith8fd3eba2008-02-17 19:48:00 +0000708 /* Find the (unbound!) __format__ method (a borrowed reference) */
Benjamin Petersonce798522012-01-22 11:24:29 -0500709 meth = _PyObject_LookupSpecial(obj, &PyId___format__);
Eric Smith8fd3eba2008-02-17 19:48:00 +0000710 if (meth == NULL) {
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000711 if (!PyErr_Occurred())
712 PyErr_Format(PyExc_TypeError,
713 "Type %.100s doesn't define __format__",
714 Py_TYPE(obj)->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000715 goto done;
Eric Smith8fd3eba2008-02-17 19:48:00 +0000716 }
717
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000718 /* And call it. */
719 result = PyObject_CallFunctionObjArgs(meth, format_spec, NULL);
Benjamin Peterson6f889ad32010-06-05 02:11:45 +0000720 Py_DECREF(meth);
Eric Smith8fd3eba2008-02-17 19:48:00 +0000721
722 if (result && !PyUnicode_Check(result)) {
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000723 PyErr_SetString(PyExc_TypeError,
724 "__format__ method did not return string");
725 Py_DECREF(result);
726 result = NULL;
727 goto done;
Eric Smith8fd3eba2008-02-17 19:48:00 +0000728 }
729
730done:
731 Py_XDECREF(empty);
732 return result;
733}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000734/* Operations on numbers */
735
736int
Fred Drake79912472000-07-09 04:06:11 +0000737PyNumber_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +0000738{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000739 return o && o->ob_type->tp_as_number &&
740 (o->ob_type->tp_as_number->nb_int ||
741 o->ob_type->tp_as_number->nb_float);
Guido van Rossume15dee51995-07-18 14:12:02 +0000742}
743
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000744/* Binary operators */
Guido van Rossume15dee51995-07-18 14:12:02 +0000745
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000746#define NB_SLOT(x) offsetof(PyNumberMethods, x)
747#define NB_BINOP(nb_methods, slot) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000748 (*(binaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000749#define NB_TERNOP(nb_methods, slot) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000750 (*(ternaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000751
752/*
753 Calling scheme used for binary operations:
754
Neal Norwitz4886cc32006-08-21 17:06:07 +0000755 Order operations are tried until either a valid result or error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000756 w.op(v,w)[*], v.op(v,w), w.op(v,w)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000757
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000758 [*] only when v->ob_type != w->ob_type && w->ob_type is a subclass of
759 v->ob_type
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000760 */
761
762static PyObject *
763binary_op1(PyObject *v, PyObject *w, const int op_slot)
Guido van Rossume15dee51995-07-18 14:12:02 +0000764{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000765 PyObject *x;
766 binaryfunc slotv = NULL;
767 binaryfunc slotw = NULL;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000768
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000769 if (v->ob_type->tp_as_number != NULL)
770 slotv = NB_BINOP(v->ob_type->tp_as_number, op_slot);
771 if (w->ob_type != v->ob_type &&
772 w->ob_type->tp_as_number != NULL) {
773 slotw = NB_BINOP(w->ob_type->tp_as_number, op_slot);
774 if (slotw == slotv)
775 slotw = NULL;
776 }
777 if (slotv) {
778 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
779 x = slotw(v, w);
780 if (x != Py_NotImplemented)
781 return x;
782 Py_DECREF(x); /* can't do it */
783 slotw = NULL;
784 }
785 x = slotv(v, w);
786 if (x != Py_NotImplemented)
787 return x;
788 Py_DECREF(x); /* can't do it */
789 }
790 if (slotw) {
791 x = slotw(v, w);
792 if (x != Py_NotImplemented)
793 return x;
794 Py_DECREF(x); /* can't do it */
795 }
Brian Curtindfc80e32011-08-10 20:28:54 -0500796 Py_RETURN_NOTIMPLEMENTED;
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000797}
Guido van Rossum77660912002-04-16 16:32:50 +0000798
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000799static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000800binop_type_error(PyObject *v, PyObject *w, const char *op_name)
801{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000802 PyErr_Format(PyExc_TypeError,
803 "unsupported operand type(s) for %.100s: "
804 "'%.100s' and '%.100s'",
805 op_name,
806 v->ob_type->tp_name,
807 w->ob_type->tp_name);
808 return NULL;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000809}
810
811static PyObject *
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000812binary_op(PyObject *v, PyObject *w, const int op_slot, const char *op_name)
813{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000814 PyObject *result = binary_op1(v, w, op_slot);
815 if (result == Py_NotImplemented) {
816 Py_DECREF(result);
817 return binop_type_error(v, w, op_name);
818 }
819 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000820}
821
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000822
823/*
824 Calling scheme used for ternary operations:
825
Neal Norwitz4886cc32006-08-21 17:06:07 +0000826 Order operations are tried until either a valid result or error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000827 v.op(v,w,z), w.op(v,w,z), z.op(v,w,z)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000828 */
829
830static PyObject *
831ternary_op(PyObject *v,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000832 PyObject *w,
833 PyObject *z,
834 const int op_slot,
835 const char *op_name)
Guido van Rossume15dee51995-07-18 14:12:02 +0000836{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000837 PyNumberMethods *mv, *mw, *mz;
838 PyObject *x = NULL;
839 ternaryfunc slotv = NULL;
840 ternaryfunc slotw = NULL;
841 ternaryfunc slotz = NULL;
Guido van Rossum77660912002-04-16 16:32:50 +0000842
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000843 mv = v->ob_type->tp_as_number;
844 mw = w->ob_type->tp_as_number;
845 if (mv != NULL)
846 slotv = NB_TERNOP(mv, op_slot);
847 if (w->ob_type != v->ob_type &&
848 mw != NULL) {
849 slotw = NB_TERNOP(mw, op_slot);
850 if (slotw == slotv)
851 slotw = NULL;
852 }
853 if (slotv) {
854 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
855 x = slotw(v, w, z);
856 if (x != Py_NotImplemented)
857 return x;
858 Py_DECREF(x); /* can't do it */
859 slotw = NULL;
860 }
861 x = slotv(v, w, z);
862 if (x != Py_NotImplemented)
863 return x;
864 Py_DECREF(x); /* can't do it */
865 }
866 if (slotw) {
867 x = slotw(v, w, z);
868 if (x != Py_NotImplemented)
869 return x;
870 Py_DECREF(x); /* can't do it */
871 }
872 mz = z->ob_type->tp_as_number;
873 if (mz != NULL) {
874 slotz = NB_TERNOP(mz, op_slot);
875 if (slotz == slotv || slotz == slotw)
876 slotz = NULL;
877 if (slotz) {
878 x = slotz(v, w, z);
879 if (x != Py_NotImplemented)
880 return x;
881 Py_DECREF(x); /* can't do it */
882 }
883 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000884
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000885 if (z == Py_None)
886 PyErr_Format(
887 PyExc_TypeError,
888 "unsupported operand type(s) for ** or pow(): "
889 "'%.100s' and '%.100s'",
890 v->ob_type->tp_name,
891 w->ob_type->tp_name);
892 else
893 PyErr_Format(
894 PyExc_TypeError,
895 "unsupported operand type(s) for pow(): "
896 "'%.100s', '%.100s', '%.100s'",
897 v->ob_type->tp_name,
898 w->ob_type->tp_name,
899 z->ob_type->tp_name);
900 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000901}
902
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000903#define BINARY_FUNC(func, op, op_name) \
904 PyObject * \
905 func(PyObject *v, PyObject *w) { \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000906 return binary_op(v, w, NB_SLOT(op), op_name); \
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000907 }
Guido van Rossume15dee51995-07-18 14:12:02 +0000908
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000909BINARY_FUNC(PyNumber_Or, nb_or, "|")
910BINARY_FUNC(PyNumber_Xor, nb_xor, "^")
911BINARY_FUNC(PyNumber_And, nb_and, "&")
912BINARY_FUNC(PyNumber_Lshift, nb_lshift, "<<")
913BINARY_FUNC(PyNumber_Rshift, nb_rshift, ">>")
914BINARY_FUNC(PyNumber_Subtract, nb_subtract, "-")
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000915BINARY_FUNC(PyNumber_Divmod, nb_divmod, "divmod()")
Guido van Rossume15dee51995-07-18 14:12:02 +0000916
917PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000918PyNumber_Add(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000919{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000920 PyObject *result = binary_op1(v, w, NB_SLOT(nb_add));
921 if (result == Py_NotImplemented) {
922 PySequenceMethods *m = v->ob_type->tp_as_sequence;
923 Py_DECREF(result);
924 if (m && m->sq_concat) {
925 return (*m->sq_concat)(v, w);
926 }
927 result = binop_type_error(v, w, "+");
928 }
929 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000930}
931
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000932static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000933sequence_repeat(ssizeargfunc repeatfunc, PyObject *seq, PyObject *n)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000934{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000935 Py_ssize_t count;
936 if (PyIndex_Check(n)) {
937 count = PyNumber_AsSsize_t(n, PyExc_OverflowError);
938 if (count == -1 && PyErr_Occurred())
939 return NULL;
940 }
941 else {
942 return type_error("can't multiply sequence by "
943 "non-int of type '%.200s'", n);
944 }
945 return (*repeatfunc)(seq, count);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000946}
947
948PyObject *
949PyNumber_Multiply(PyObject *v, PyObject *w)
950{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000951 PyObject *result = binary_op1(v, w, NB_SLOT(nb_multiply));
952 if (result == Py_NotImplemented) {
953 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
954 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
955 Py_DECREF(result);
956 if (mv && mv->sq_repeat) {
957 return sequence_repeat(mv->sq_repeat, v, w);
958 }
959 else if (mw && mw->sq_repeat) {
960 return sequence_repeat(mw->sq_repeat, w, v);
961 }
962 result = binop_type_error(v, w, "*");
963 }
964 return result;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000965}
966
Guido van Rossume15dee51995-07-18 14:12:02 +0000967PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +0000968PyNumber_FloorDivide(PyObject *v, PyObject *w)
969{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000970 return binary_op(v, w, NB_SLOT(nb_floor_divide), "//");
Guido van Rossum4668b002001-08-08 05:00:18 +0000971}
972
973PyObject *
974PyNumber_TrueDivide(PyObject *v, PyObject *w)
975{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000976 return binary_op(v, w, NB_SLOT(nb_true_divide), "/");
Guido van Rossum4668b002001-08-08 05:00:18 +0000977}
978
979PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000980PyNumber_Remainder(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000981{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000982 return binary_op(v, w, NB_SLOT(nb_remainder), "%");
Guido van Rossume15dee51995-07-18 14:12:02 +0000983}
984
985PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000986PyNumber_Power(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossume15dee51995-07-18 14:12:02 +0000987{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000988 return ternary_op(v, w, z, NB_SLOT(nb_power), "** or pow()");
Guido van Rossume15dee51995-07-18 14:12:02 +0000989}
990
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000991/* Binary in-place operators */
992
993/* The in-place operators are defined to fall back to the 'normal',
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000994 non in-place operations, if the in-place methods are not in place.
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000995
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000996 - If the left hand object has the appropriate struct members, and
997 they are filled, call the appropriate function and return the
998 result. No coercion is done on the arguments; the left-hand object
999 is the one the operation is performed on, and it's up to the
1000 function to deal with the right-hand object.
Guido van Rossum77660912002-04-16 16:32:50 +00001001
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001002 - Otherwise, in-place modification is not supported. Handle it exactly as
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001003 a non in-place operation of the same kind.
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001004
1005 */
1006
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001007static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001008binary_iop1(PyObject *v, PyObject *w, const int iop_slot, const int op_slot)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001009{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001010 PyNumberMethods *mv = v->ob_type->tp_as_number;
1011 if (mv != NULL) {
1012 binaryfunc slot = NB_BINOP(mv, iop_slot);
1013 if (slot) {
1014 PyObject *x = (slot)(v, w);
1015 if (x != Py_NotImplemented) {
1016 return x;
1017 }
1018 Py_DECREF(x);
1019 }
1020 }
1021 return binary_op1(v, w, op_slot);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001022}
1023
1024static PyObject *
1025binary_iop(PyObject *v, PyObject *w, const int iop_slot, const int op_slot,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001026 const char *op_name)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001027{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001028 PyObject *result = binary_iop1(v, w, iop_slot, op_slot);
1029 if (result == Py_NotImplemented) {
1030 Py_DECREF(result);
1031 return binop_type_error(v, w, op_name);
1032 }
1033 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001034}
1035
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001036#define INPLACE_BINOP(func, iop, op, op_name) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001037 PyObject * \
1038 func(PyObject *v, PyObject *w) { \
1039 return binary_iop(v, w, NB_SLOT(iop), NB_SLOT(op), op_name); \
1040 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001041
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001042INPLACE_BINOP(PyNumber_InPlaceOr, nb_inplace_or, nb_or, "|=")
1043INPLACE_BINOP(PyNumber_InPlaceXor, nb_inplace_xor, nb_xor, "^=")
1044INPLACE_BINOP(PyNumber_InPlaceAnd, nb_inplace_and, nb_and, "&=")
1045INPLACE_BINOP(PyNumber_InPlaceLshift, nb_inplace_lshift, nb_lshift, "<<=")
1046INPLACE_BINOP(PyNumber_InPlaceRshift, nb_inplace_rshift, nb_rshift, ">>=")
1047INPLACE_BINOP(PyNumber_InPlaceSubtract, nb_inplace_subtract, nb_subtract, "-=")
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001048
1049PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +00001050PyNumber_InPlaceFloorDivide(PyObject *v, PyObject *w)
1051{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001052 return binary_iop(v, w, NB_SLOT(nb_inplace_floor_divide),
1053 NB_SLOT(nb_floor_divide), "//=");
Guido van Rossum4668b002001-08-08 05:00:18 +00001054}
1055
1056PyObject *
1057PyNumber_InPlaceTrueDivide(PyObject *v, PyObject *w)
1058{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001059 return binary_iop(v, w, NB_SLOT(nb_inplace_true_divide),
1060 NB_SLOT(nb_true_divide), "/=");
Guido van Rossum4668b002001-08-08 05:00:18 +00001061}
1062
1063PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001064PyNumber_InPlaceAdd(PyObject *v, PyObject *w)
1065{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001066 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_add),
1067 NB_SLOT(nb_add));
1068 if (result == Py_NotImplemented) {
1069 PySequenceMethods *m = v->ob_type->tp_as_sequence;
1070 Py_DECREF(result);
1071 if (m != NULL) {
1072 binaryfunc f = NULL;
1073 f = m->sq_inplace_concat;
1074 if (f == NULL)
1075 f = m->sq_concat;
1076 if (f != NULL)
1077 return (*f)(v, w);
1078 }
1079 result = binop_type_error(v, w, "+=");
1080 }
1081 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001082}
1083
1084PyObject *
1085PyNumber_InPlaceMultiply(PyObject *v, PyObject *w)
1086{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001087 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_multiply),
1088 NB_SLOT(nb_multiply));
1089 if (result == Py_NotImplemented) {
1090 ssizeargfunc f = NULL;
1091 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
1092 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
1093 Py_DECREF(result);
1094 if (mv != NULL) {
1095 f = mv->sq_inplace_repeat;
1096 if (f == NULL)
1097 f = mv->sq_repeat;
1098 if (f != NULL)
1099 return sequence_repeat(f, v, w);
1100 }
1101 else if (mw != NULL) {
1102 /* Note that the right hand operand should not be
1103 * mutated in this case so sq_inplace_repeat is not
1104 * used. */
1105 if (mw->sq_repeat)
1106 return sequence_repeat(mw->sq_repeat, w, v);
1107 }
1108 result = binop_type_error(v, w, "*=");
1109 }
1110 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001111}
1112
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001113PyObject *
1114PyNumber_InPlaceRemainder(PyObject *v, PyObject *w)
1115{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001116 return binary_iop(v, w, NB_SLOT(nb_inplace_remainder),
1117 NB_SLOT(nb_remainder), "%=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001118}
1119
1120PyObject *
1121PyNumber_InPlacePower(PyObject *v, PyObject *w, PyObject *z)
1122{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001123 if (v->ob_type->tp_as_number &&
1124 v->ob_type->tp_as_number->nb_inplace_power != NULL) {
1125 return ternary_op(v, w, z, NB_SLOT(nb_inplace_power), "**=");
1126 }
1127 else {
1128 return ternary_op(v, w, z, NB_SLOT(nb_power), "**=");
1129 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001130}
1131
1132
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001133/* Unary operators and functions */
Guido van Rossume15dee51995-07-18 14:12:02 +00001134
1135PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001136PyNumber_Negative(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001137{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001138 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001139
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001140 if (o == NULL)
1141 return null_error();
1142 m = o->ob_type->tp_as_number;
1143 if (m && m->nb_negative)
1144 return (*m->nb_negative)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001145
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001146 return type_error("bad operand type for unary -: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001147}
1148
1149PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001150PyNumber_Positive(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001151{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001152 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001153
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001154 if (o == NULL)
1155 return null_error();
1156 m = o->ob_type->tp_as_number;
1157 if (m && m->nb_positive)
1158 return (*m->nb_positive)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001159
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001160 return type_error("bad operand type for unary +: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001161}
1162
1163PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001164PyNumber_Invert(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001165{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001166 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001167
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001168 if (o == NULL)
1169 return null_error();
1170 m = o->ob_type->tp_as_number;
1171 if (m && m->nb_invert)
1172 return (*m->nb_invert)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001173
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001174 return type_error("bad operand type for unary ~: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001175}
1176
1177PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001178PyNumber_Absolute(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001179{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001180 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001181
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001182 if (o == NULL)
1183 return null_error();
1184 m = o->ob_type->tp_as_number;
1185 if (m && m->nb_absolute)
1186 return m->nb_absolute(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001187
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001188 return type_error("bad operand type for abs(): '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001189}
1190
Guido van Rossum98297ee2007-11-06 21:34:58 +00001191/* Return a Python Int or Long from the object item
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001192 Raise TypeError if the result is not an int-or-long
Guido van Rossum98297ee2007-11-06 21:34:58 +00001193 or if the object cannot be interpreted as an index.
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001194*/
1195PyObject *
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001196PyNumber_Index(PyObject *item)
1197{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001198 PyObject *result = NULL;
1199 if (item == NULL)
1200 return null_error();
1201 if (PyLong_Check(item)) {
1202 Py_INCREF(item);
1203 return item;
1204 }
1205 if (PyIndex_Check(item)) {
1206 result = item->ob_type->tp_as_number->nb_index(item);
1207 if (result && !PyLong_Check(result)) {
1208 PyErr_Format(PyExc_TypeError,
1209 "__index__ returned non-int "
1210 "(type %.200s)",
1211 result->ob_type->tp_name);
1212 Py_DECREF(result);
1213 return NULL;
1214 }
1215 }
1216 else {
1217 PyErr_Format(PyExc_TypeError,
1218 "'%.200s' object cannot be interpreted "
1219 "as an integer", item->ob_type->tp_name);
1220 }
1221 return result;
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001222}
1223
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001224/* Return an error on Overflow only if err is not NULL*/
1225
1226Py_ssize_t
1227PyNumber_AsSsize_t(PyObject *item, PyObject *err)
1228{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001229 Py_ssize_t result;
1230 PyObject *runerr;
1231 PyObject *value = PyNumber_Index(item);
1232 if (value == NULL)
1233 return -1;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001234
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001235 /* We're done if PyLong_AsSsize_t() returns without error. */
1236 result = PyLong_AsSsize_t(value);
1237 if (result != -1 || !(runerr = PyErr_Occurred()))
1238 goto finish;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001239
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001240 /* Error handling code -- only manage OverflowError differently */
1241 if (!PyErr_GivenExceptionMatches(runerr, PyExc_OverflowError))
1242 goto finish;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001243
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001244 PyErr_Clear();
1245 /* If no error-handling desired then the default clipping
1246 is sufficient.
1247 */
1248 if (!err) {
1249 assert(PyLong_Check(value));
1250 /* Whether or not it is less than or equal to
1251 zero is determined by the sign of ob_size
1252 */
1253 if (_PyLong_Sign(value) < 0)
1254 result = PY_SSIZE_T_MIN;
1255 else
1256 result = PY_SSIZE_T_MAX;
1257 }
1258 else {
1259 /* Otherwise replace the error with caller's error object. */
1260 PyErr_Format(err,
1261 "cannot fit '%.200s' into an index-sized integer",
1262 item->ob_type->tp_name);
1263 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001264
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001265 finish:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001266 Py_DECREF(value);
1267 return result;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001268}
1269
1270
Benjamin Petersonb7f1da52012-03-21 14:44:43 -04001271/*
1272 Returns the Integral instance converted to an int. The instance is expected
1273 to be an int or have an __int__ method. Steals integral's
1274 reference. error_format will be used to create the TypeError if integral
1275 isn't actually an Integral instance. error_format should be a format string
1276 that can accept a char* naming integral's type.
1277*/
1278static PyObject *
1279convert_integral_to_int(PyObject *integral, const char *error_format)
Christian Heimes15ebc882008-02-04 18:48:49 +00001280{
Benjamin Petersond614e702012-03-21 14:38:11 -04001281 PyNumberMethods *nb;
1282 if (PyLong_Check(integral))
1283 return integral;
1284 nb = Py_TYPE(integral)->tp_as_number;
1285 if (nb->nb_int) {
1286 PyObject *as_int = nb->nb_int(integral);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001287 Py_DECREF(integral);
Benjamin Petersond614e702012-03-21 14:38:11 -04001288 if (!as_int)
1289 return NULL;
1290 if (PyLong_Check(as_int))
1291 return as_int;
1292 Py_DECREF(as_int);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001293 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001294 PyErr_Format(PyExc_TypeError, error_format, Py_TYPE(integral)->tp_name);
1295 Py_DECREF(integral);
Benjamin Petersond614e702012-03-21 14:38:11 -04001296 return NULL;
Christian Heimes15ebc882008-02-04 18:48:49 +00001297}
1298
1299
Guido van Rossum9e896b32000-04-05 20:11:21 +00001300/* Add a check for embedded NULL-bytes in the argument. */
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001301static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001302long_from_string(const char *s, Py_ssize_t len)
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001303{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001304 char *end;
1305 PyObject *x;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001306
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001307 x = PyLong_FromString((char*)s, &end, 10);
1308 if (x == NULL)
1309 return NULL;
1310 if (end != s + len) {
1311 PyErr_SetString(PyExc_ValueError,
1312 "null byte in argument for int()");
1313 Py_DECREF(x);
1314 return NULL;
1315 }
1316 return x;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001317}
1318
Guido van Rossume15dee51995-07-18 14:12:02 +00001319PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001320PyNumber_Long(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001321{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001322 PyNumberMethods *m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001323 PyObject *trunc_func;
1324 const char *buffer;
1325 Py_ssize_t buffer_len;
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04001326 _Py_IDENTIFIER(__trunc__);
Christian Heimes15ebc882008-02-04 18:48:49 +00001327
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001328 if (o == NULL)
1329 return null_error();
1330 if (PyLong_CheckExact(o)) {
1331 Py_INCREF(o);
1332 return o;
1333 }
1334 m = o->ob_type->tp_as_number;
1335 if (m && m->nb_int) { /* This should include subclasses of int */
1336 PyObject *res = m->nb_int(o);
1337 if (res && !PyLong_Check(res)) {
1338 PyErr_Format(PyExc_TypeError,
1339 "__int__ returned non-int (type %.200s)",
1340 res->ob_type->tp_name);
1341 Py_DECREF(res);
1342 return NULL;
1343 }
1344 return res;
1345 }
1346 if (PyLong_Check(o)) /* An int subclass without nb_int */
1347 return _PyLong_Copy((PyLongObject *)o);
Benjamin Peterson1b1a8e72012-03-20 23:48:11 -04001348 trunc_func = _PyObject_LookupSpecial(o, &PyId___trunc__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001349 if (trunc_func) {
1350 PyObject *truncated = PyEval_CallObject(trunc_func, NULL);
1351 PyObject *int_instance;
1352 Py_DECREF(trunc_func);
1353 /* __trunc__ is specified to return an Integral type,
Benjamin Peterson520e8502012-03-21 14:51:14 -04001354 but int() needs to return a int. */
Benjamin Petersonb7f1da52012-03-21 14:44:43 -04001355 int_instance = convert_integral_to_int(truncated,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001356 "__trunc__ returned non-Integral (type %.200s)");
1357 return int_instance;
1358 }
Benjamin Peterson1b1a8e72012-03-20 23:48:11 -04001359 if (PyErr_Occurred())
1360 return NULL;
Christian Heimes15ebc882008-02-04 18:48:49 +00001361
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001362 if (PyBytes_Check(o))
1363 /* need to do extra error checking that PyLong_FromString()
Benjamin Peterson520e8502012-03-21 14:51:14 -04001364 * doesn't do. In particular int('9.5') must raise an
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001365 * exception, not truncate the float.
1366 */
1367 return long_from_string(PyBytes_AS_STRING(o),
1368 PyBytes_GET_SIZE(o));
1369 if (PyUnicode_Check(o))
1370 /* The above check is done in PyLong_FromUnicode(). */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001371 return PyLong_FromUnicodeObject(o, 10);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001372 if (!PyObject_AsCharBuffer(o, &buffer, &buffer_len))
1373 return long_from_string(buffer, buffer_len);
Guido van Rossume15dee51995-07-18 14:12:02 +00001374
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001375 return type_error("int() argument must be a string or a "
1376 "number, not '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001377}
1378
1379PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001380PyNumber_Float(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001381{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001382 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001383
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001384 if (o == NULL)
1385 return null_error();
1386 m = o->ob_type->tp_as_number;
1387 if (m && m->nb_float) { /* This should include subclasses of float */
1388 PyObject *res = m->nb_float(o);
1389 if (res && !PyFloat_Check(res)) {
1390 PyErr_Format(PyExc_TypeError,
1391 "__float__ returned non-float (type %.200s)",
1392 res->ob_type->tp_name);
1393 Py_DECREF(res);
1394 return NULL;
1395 }
1396 return res;
1397 }
1398 if (PyFloat_Check(o)) { /* A float subclass with nb_float == NULL */
1399 PyFloatObject *po = (PyFloatObject *)o;
1400 return PyFloat_FromDouble(po->ob_fval);
1401 }
1402 return PyFloat_FromString(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001403}
1404
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001405
1406PyObject *
1407PyNumber_ToBase(PyObject *n, int base)
1408{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001409 PyObject *res = NULL;
1410 PyObject *index = PyNumber_Index(n);
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001411
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001412 if (!index)
1413 return NULL;
1414 if (PyLong_Check(index))
1415 res = _PyLong_Format(index, base);
1416 else
1417 /* It should not be possible to get here, as
1418 PyNumber_Index already has a check for the same
1419 condition */
1420 PyErr_SetString(PyExc_ValueError, "PyNumber_ToBase: index not "
1421 "int or long");
1422 Py_DECREF(index);
1423 return res;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001424}
1425
1426
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001427/* Operations on sequences */
Guido van Rossume15dee51995-07-18 14:12:02 +00001428
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001429int
Fred Drake79912472000-07-09 04:06:11 +00001430PySequence_Check(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001431{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001432 if (PyDict_Check(s))
1433 return 0;
1434 return s != NULL && s->ob_type->tp_as_sequence &&
1435 s->ob_type->tp_as_sequence->sq_item != NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001436}
1437
Martin v. Löwis18e16552006-02-15 17:27:45 +00001438Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001439PySequence_Size(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001440{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001441 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001442
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001443 if (s == NULL) {
1444 null_error();
1445 return -1;
1446 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001447
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001448 m = s->ob_type->tp_as_sequence;
1449 if (m && m->sq_length)
1450 return m->sq_length(s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001451
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001452 type_error("object of type '%.200s' has no len()", s);
1453 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001454}
1455
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001456#undef PySequence_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001457Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001458PySequence_Length(PyObject *s)
1459{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001460 return PySequence_Size(s);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001461}
1462#define PySequence_Length PySequence_Size
1463
Guido van Rossume15dee51995-07-18 14:12:02 +00001464PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001465PySequence_Concat(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001466{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001467 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001468
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001469 if (s == NULL || o == NULL)
1470 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001471
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001472 m = s->ob_type->tp_as_sequence;
1473 if (m && m->sq_concat)
1474 return m->sq_concat(s, o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001475
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001476 /* Instances of user classes defining an __add__() method only
1477 have an nb_add slot, not an sq_concat slot. So we fall back
1478 to nb_add if both arguments appear to be sequences. */
1479 if (PySequence_Check(s) && PySequence_Check(o)) {
1480 PyObject *result = binary_op1(s, o, NB_SLOT(nb_add));
1481 if (result != Py_NotImplemented)
1482 return result;
1483 Py_DECREF(result);
1484 }
1485 return type_error("'%.200s' object can't be concatenated", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001486}
1487
1488PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001489PySequence_Repeat(PyObject *o, Py_ssize_t count)
Guido van Rossume15dee51995-07-18 14:12:02 +00001490{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001491 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001492
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001493 if (o == NULL)
1494 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001495
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001496 m = o->ob_type->tp_as_sequence;
1497 if (m && m->sq_repeat)
1498 return m->sq_repeat(o, count);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001499
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001500 /* Instances of user classes defining a __mul__() method only
1501 have an nb_multiply slot, not an sq_repeat slot. so we fall back
1502 to nb_multiply if o appears to be a sequence. */
1503 if (PySequence_Check(o)) {
1504 PyObject *n, *result;
1505 n = PyLong_FromSsize_t(count);
1506 if (n == NULL)
1507 return NULL;
1508 result = binary_op1(o, n, NB_SLOT(nb_multiply));
1509 Py_DECREF(n);
1510 if (result != Py_NotImplemented)
1511 return result;
1512 Py_DECREF(result);
1513 }
1514 return type_error("'%.200s' object can't be repeated", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001515}
1516
1517PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001518PySequence_InPlaceConcat(PyObject *s, PyObject *o)
1519{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001520 PySequenceMethods *m;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001521
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001522 if (s == NULL || o == NULL)
1523 return null_error();
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001524
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001525 m = s->ob_type->tp_as_sequence;
1526 if (m && m->sq_inplace_concat)
1527 return m->sq_inplace_concat(s, o);
1528 if (m && m->sq_concat)
1529 return m->sq_concat(s, o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001530
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001531 if (PySequence_Check(s) && PySequence_Check(o)) {
1532 PyObject *result = binary_iop1(s, o, NB_SLOT(nb_inplace_add),
1533 NB_SLOT(nb_add));
1534 if (result != Py_NotImplemented)
1535 return result;
1536 Py_DECREF(result);
1537 }
1538 return type_error("'%.200s' object can't be concatenated", s);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001539}
1540
1541PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001542PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001543{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001544 PySequenceMethods *m;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001545
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001546 if (o == NULL)
1547 return null_error();
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001548
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001549 m = o->ob_type->tp_as_sequence;
1550 if (m && m->sq_inplace_repeat)
1551 return m->sq_inplace_repeat(o, count);
1552 if (m && m->sq_repeat)
1553 return m->sq_repeat(o, count);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001554
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001555 if (PySequence_Check(o)) {
1556 PyObject *n, *result;
1557 n = PyLong_FromSsize_t(count);
1558 if (n == NULL)
1559 return NULL;
1560 result = binary_iop1(o, n, NB_SLOT(nb_inplace_multiply),
1561 NB_SLOT(nb_multiply));
1562 Py_DECREF(n);
1563 if (result != Py_NotImplemented)
1564 return result;
1565 Py_DECREF(result);
1566 }
1567 return type_error("'%.200s' object can't be repeated", o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001568}
1569
1570PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001571PySequence_GetItem(PyObject *s, Py_ssize_t i)
Guido van Rossume15dee51995-07-18 14:12:02 +00001572{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001573 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001574
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001575 if (s == NULL)
1576 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001577
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001578 m = s->ob_type->tp_as_sequence;
1579 if (m && m->sq_item) {
1580 if (i < 0) {
1581 if (m->sq_length) {
1582 Py_ssize_t l = (*m->sq_length)(s);
1583 if (l < 0)
1584 return NULL;
1585 i += l;
1586 }
1587 }
1588 return m->sq_item(s, i);
1589 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001590
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001591 return type_error("'%.200s' object does not support indexing", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001592}
1593
1594PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001595PySequence_GetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossume15dee51995-07-18 14:12:02 +00001596{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001597 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001598
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001599 if (!s) return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001600
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001601 mp = s->ob_type->tp_as_mapping;
Benjamin Peterson568867a2010-09-11 16:02:03 +00001602 if (mp && mp->mp_subscript) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001603 PyObject *res;
1604 PyObject *slice = _PySlice_FromIndices(i1, i2);
1605 if (!slice)
1606 return NULL;
1607 res = mp->mp_subscript(s, slice);
1608 Py_DECREF(slice);
1609 return res;
1610 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001611
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001612 return type_error("'%.200s' object is unsliceable", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001613}
1614
1615int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001616PySequence_SetItem(PyObject *s, Py_ssize_t i, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001617{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001618 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001619
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001620 if (s == NULL) {
1621 null_error();
1622 return -1;
1623 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001624
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001625 m = s->ob_type->tp_as_sequence;
1626 if (m && m->sq_ass_item) {
1627 if (i < 0) {
1628 if (m->sq_length) {
1629 Py_ssize_t l = (*m->sq_length)(s);
1630 if (l < 0)
1631 return -1;
1632 i += l;
1633 }
1634 }
1635 return m->sq_ass_item(s, i, o);
1636 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001637
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001638 type_error("'%.200s' object does not support item assignment", s);
1639 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001640}
1641
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001642int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001643PySequence_DelItem(PyObject *s, Py_ssize_t i)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001644{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001645 PySequenceMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001646
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001647 if (s == NULL) {
1648 null_error();
1649 return -1;
1650 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001651
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001652 m = s->ob_type->tp_as_sequence;
1653 if (m && m->sq_ass_item) {
1654 if (i < 0) {
1655 if (m->sq_length) {
1656 Py_ssize_t l = (*m->sq_length)(s);
1657 if (l < 0)
1658 return -1;
1659 i += l;
1660 }
1661 }
1662 return m->sq_ass_item(s, i, (PyObject *)NULL);
1663 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001664
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001665 type_error("'%.200s' object doesn't support item deletion", s);
1666 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001667}
1668
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001669int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001670PySequence_SetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001671{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001672 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001673
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001674 if (s == NULL) {
1675 null_error();
1676 return -1;
1677 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001678
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001679 mp = s->ob_type->tp_as_mapping;
Benjamin Peterson568867a2010-09-11 16:02:03 +00001680 if (mp && mp->mp_ass_subscript) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001681 int res;
1682 PyObject *slice = _PySlice_FromIndices(i1, i2);
1683 if (!slice)
1684 return -1;
1685 res = mp->mp_ass_subscript(s, slice, o);
1686 Py_DECREF(slice);
1687 return res;
1688 }
Thomas Wouters1d75a792000-08-17 22:37:32 +00001689
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001690 type_error("'%.200s' object doesn't support slice assignment", s);
1691 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001692}
1693
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001694int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001695PySequence_DelSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001696{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001697 PyMappingMethods *mp;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001698
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001699 if (s == NULL) {
1700 null_error();
1701 return -1;
1702 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001703
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001704 mp = s->ob_type->tp_as_mapping;
Benjamin Peterson568867a2010-09-11 16:02:03 +00001705 if (mp && mp->mp_ass_subscript) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001706 int res;
1707 PyObject *slice = _PySlice_FromIndices(i1, i2);
1708 if (!slice)
1709 return -1;
1710 res = mp->mp_ass_subscript(s, slice, NULL);
1711 Py_DECREF(slice);
1712 return res;
1713 }
1714 type_error("'%.200s' object doesn't support slice deletion", s);
1715 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001716}
1717
Guido van Rossume15dee51995-07-18 14:12:02 +00001718PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001719PySequence_Tuple(PyObject *v)
Guido van Rossume15dee51995-07-18 14:12:02 +00001720{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001721 PyObject *it; /* iter(v) */
1722 Py_ssize_t n; /* guess for result tuple size */
1723 PyObject *result = NULL;
1724 Py_ssize_t j;
Guido van Rossume15dee51995-07-18 14:12:02 +00001725
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001726 if (v == NULL)
1727 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001728
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001729 /* Special-case the common tuple and list cases, for efficiency. */
1730 if (PyTuple_CheckExact(v)) {
1731 /* Note that we can't know whether it's safe to return
1732 a tuple *subclass* instance as-is, hence the restriction
1733 to exact tuples here. In contrast, lists always make
1734 a copy, so there's no need for exactness below. */
1735 Py_INCREF(v);
1736 return v;
1737 }
1738 if (PyList_Check(v))
1739 return PyList_AsTuple(v);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001740
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001741 /* Get iterator. */
1742 it = PyObject_GetIter(v);
1743 if (it == NULL)
1744 return NULL;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001745
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001746 /* Guess result size and allocate space. */
1747 n = _PyObject_LengthHint(v, 10);
1748 if (n == -1)
1749 goto Fail;
1750 result = PyTuple_New(n);
1751 if (result == NULL)
1752 goto Fail;
Tim Peters6912d4d2001-05-05 03:56:37 +00001753
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001754 /* Fill the tuple. */
1755 for (j = 0; ; ++j) {
1756 PyObject *item = PyIter_Next(it);
1757 if (item == NULL) {
1758 if (PyErr_Occurred())
1759 goto Fail;
1760 break;
1761 }
1762 if (j >= n) {
1763 Py_ssize_t oldn = n;
1764 /* The over-allocation strategy can grow a bit faster
1765 than for lists because unlike lists the
1766 over-allocation isn't permanent -- we reclaim
1767 the excess before the end of this routine.
1768 So, grow by ten and then add 25%.
1769 */
1770 n += 10;
1771 n += n >> 2;
1772 if (n < oldn) {
1773 /* Check for overflow */
1774 PyErr_NoMemory();
1775 Py_DECREF(item);
1776 goto Fail;
1777 }
1778 if (_PyTuple_Resize(&result, n) != 0) {
1779 Py_DECREF(item);
1780 goto Fail;
1781 }
1782 }
1783 PyTuple_SET_ITEM(result, j, item);
1784 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001785
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001786 /* Cut tuple back if guess was too large. */
1787 if (j < n &&
1788 _PyTuple_Resize(&result, j) != 0)
1789 goto Fail;
Tim Peters6912d4d2001-05-05 03:56:37 +00001790
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001791 Py_DECREF(it);
1792 return result;
Tim Peters6912d4d2001-05-05 03:56:37 +00001793
1794Fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001795 Py_XDECREF(result);
1796 Py_DECREF(it);
1797 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001798}
1799
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001800PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001801PySequence_List(PyObject *v)
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001802{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001803 PyObject *result; /* result list */
1804 PyObject *rv; /* return value from PyList_Extend */
Guido van Rossum4669fb41997-04-02 05:31:09 +00001805
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001806 if (v == NULL)
1807 return null_error();
Guido van Rossum5dba9e81998-07-10 18:03:50 +00001808
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001809 result = PyList_New(0);
1810 if (result == NULL)
1811 return NULL;
Tim Petersf553f892001-05-01 20:45:31 +00001812
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001813 rv = _PyList_Extend((PyListObject *)result, v);
1814 if (rv == NULL) {
1815 Py_DECREF(result);
1816 return NULL;
1817 }
1818 Py_DECREF(rv);
1819 return result;
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001820}
1821
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001822PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001823PySequence_Fast(PyObject *v, const char *m)
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001824{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001825 PyObject *it;
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001826
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001827 if (v == NULL)
1828 return null_error();
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001829
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001830 if (PyList_CheckExact(v) || PyTuple_CheckExact(v)) {
1831 Py_INCREF(v);
1832 return v;
1833 }
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001834
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001835 it = PyObject_GetIter(v);
1836 if (it == NULL) {
1837 if (PyErr_ExceptionMatches(PyExc_TypeError))
1838 PyErr_SetString(PyExc_TypeError, m);
1839 return NULL;
1840 }
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001841
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001842 v = PySequence_List(it);
1843 Py_DECREF(it);
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001844
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001845 return v;
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001846}
1847
Tim Peters16a77ad2001-09-08 04:00:12 +00001848/* Iterate over seq. Result depends on the operation:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001849 PY_ITERSEARCH_COUNT: -1 if error, else # of times obj appears in seq.
1850 PY_ITERSEARCH_INDEX: 0-based index of first occurrence of obj in seq;
1851 set ValueError and return -1 if none found; also return -1 on error.
Tim Peters16a77ad2001-09-08 04:00:12 +00001852 Py_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on error.
1853*/
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001854Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001855_PySequence_IterSearch(PyObject *seq, PyObject *obj, int operation)
Guido van Rossume15dee51995-07-18 14:12:02 +00001856{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001857 Py_ssize_t n;
1858 int wrapped; /* for PY_ITERSEARCH_INDEX, true iff n wrapped around */
1859 PyObject *it; /* iter(seq) */
Guido van Rossume15dee51995-07-18 14:12:02 +00001860
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001861 if (seq == NULL || obj == NULL) {
1862 null_error();
1863 return -1;
1864 }
Tim Peters75f8e352001-05-05 11:33:43 +00001865
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001866 it = PyObject_GetIter(seq);
1867 if (it == NULL) {
1868 type_error("argument of type '%.200s' is not iterable", seq);
1869 return -1;
1870 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001871
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001872 n = wrapped = 0;
1873 for (;;) {
1874 int cmp;
1875 PyObject *item = PyIter_Next(it);
1876 if (item == NULL) {
1877 if (PyErr_Occurred())
1878 goto Fail;
1879 break;
1880 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001881
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001882 cmp = PyObject_RichCompareBool(obj, item, Py_EQ);
1883 Py_DECREF(item);
1884 if (cmp < 0)
1885 goto Fail;
1886 if (cmp > 0) {
1887 switch (operation) {
1888 case PY_ITERSEARCH_COUNT:
1889 if (n == PY_SSIZE_T_MAX) {
1890 PyErr_SetString(PyExc_OverflowError,
1891 "count exceeds C integer size");
1892 goto Fail;
1893 }
1894 ++n;
1895 break;
Tim Peters16a77ad2001-09-08 04:00:12 +00001896
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001897 case PY_ITERSEARCH_INDEX:
1898 if (wrapped) {
1899 PyErr_SetString(PyExc_OverflowError,
1900 "index exceeds C integer size");
1901 goto Fail;
1902 }
1903 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00001904
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001905 case PY_ITERSEARCH_CONTAINS:
1906 n = 1;
1907 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00001908
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001909 default:
1910 assert(!"unknown operation");
1911 }
1912 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001913
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001914 if (operation == PY_ITERSEARCH_INDEX) {
1915 if (n == PY_SSIZE_T_MAX)
1916 wrapped = 1;
1917 ++n;
1918 }
1919 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001920
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001921 if (operation != PY_ITERSEARCH_INDEX)
1922 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00001923
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001924 PyErr_SetString(PyExc_ValueError,
1925 "sequence.index(x): x not in sequence");
1926 /* fall into failure code */
Tim Peters16a77ad2001-09-08 04:00:12 +00001927Fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001928 n = -1;
1929 /* fall through */
Tim Peters16a77ad2001-09-08 04:00:12 +00001930Done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001931 Py_DECREF(it);
1932 return n;
Tim Peters75f8e352001-05-05 11:33:43 +00001933
Guido van Rossume15dee51995-07-18 14:12:02 +00001934}
1935
Tim Peters16a77ad2001-09-08 04:00:12 +00001936/* Return # of times o appears in s. */
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001937Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001938PySequence_Count(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001939{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001940 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_COUNT);
Guido van Rossume15dee51995-07-18 14:12:02 +00001941}
1942
Tim Peterscb8d3682001-05-05 21:05:01 +00001943/* Return -1 if error; 1 if ob in seq; 0 if ob not in seq.
Tim Peters16a77ad2001-09-08 04:00:12 +00001944 * Use sq_contains if possible, else defer to _PySequence_IterSearch().
Tim Peterscb8d3682001-05-05 21:05:01 +00001945 */
1946int
1947PySequence_Contains(PyObject *seq, PyObject *ob)
1948{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001949 Py_ssize_t result;
1950 PySequenceMethods *sqm = seq->ob_type->tp_as_sequence;
1951 if (sqm != NULL && sqm->sq_contains != NULL)
1952 return (*sqm->sq_contains)(seq, ob);
1953 result = _PySequence_IterSearch(seq, ob, PY_ITERSEARCH_CONTAINS);
1954 return Py_SAFE_DOWNCAST(result, Py_ssize_t, int);
Tim Peterscb8d3682001-05-05 21:05:01 +00001955}
1956
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001957/* Backwards compatibility */
1958#undef PySequence_In
1959int
Fred Drake79912472000-07-09 04:06:11 +00001960PySequence_In(PyObject *w, PyObject *v)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001961{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001962 return PySequence_Contains(w, v);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001963}
1964
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001965Py_ssize_t
Fred Drake79912472000-07-09 04:06:11 +00001966PySequence_Index(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001967{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001968 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_INDEX);
Guido van Rossume15dee51995-07-18 14:12:02 +00001969}
1970
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001971/* Operations on mappings */
1972
1973int
Fred Drake79912472000-07-09 04:06:11 +00001974PyMapping_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001975{
Benjamin Peterson21992272011-12-28 12:01:31 -06001976 return o && o->ob_type->tp_as_mapping &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001977 o->ob_type->tp_as_mapping->mp_subscript;
Guido van Rossume15dee51995-07-18 14:12:02 +00001978}
1979
Martin v. Löwis18e16552006-02-15 17:27:45 +00001980Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001981PyMapping_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001982{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001983 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001984
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001985 if (o == NULL) {
1986 null_error();
1987 return -1;
1988 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001989
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001990 m = o->ob_type->tp_as_mapping;
1991 if (m && m->mp_length)
1992 return m->mp_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001993
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001994 type_error("object of type '%.200s' has no len()", o);
1995 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001996}
1997
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001998#undef PyMapping_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001999Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002000PyMapping_Length(PyObject *o)
2001{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002002 return PyMapping_Size(o);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002003}
2004#define PyMapping_Length PyMapping_Size
2005
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002006PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002007PyMapping_GetItemString(PyObject *o, char *key)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002008{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002009 PyObject *okey, *r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002010
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002011 if (key == NULL)
2012 return null_error();
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002013
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002014 okey = PyUnicode_FromString(key);
2015 if (okey == NULL)
2016 return NULL;
2017 r = PyObject_GetItem(o, okey);
2018 Py_DECREF(okey);
2019 return r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002020}
2021
2022int
Fred Drake79912472000-07-09 04:06:11 +00002023PyMapping_SetItemString(PyObject *o, char *key, PyObject *value)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002024{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002025 PyObject *okey;
2026 int r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002027
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002028 if (key == NULL) {
2029 null_error();
2030 return -1;
2031 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002032
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002033 okey = PyUnicode_FromString(key);
2034 if (okey == NULL)
2035 return -1;
2036 r = PyObject_SetItem(o, okey, value);
2037 Py_DECREF(okey);
2038 return r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002039}
2040
2041int
Fred Drake79912472000-07-09 04:06:11 +00002042PyMapping_HasKeyString(PyObject *o, char *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002043{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002044 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002045
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002046 v = PyMapping_GetItemString(o, key);
2047 if (v) {
2048 Py_DECREF(v);
2049 return 1;
2050 }
2051 PyErr_Clear();
2052 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002053}
2054
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002055int
Fred Drake79912472000-07-09 04:06:11 +00002056PyMapping_HasKey(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002057{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002058 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002059
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002060 v = PyObject_GetItem(o, key);
2061 if (v) {
2062 Py_DECREF(v);
2063 return 1;
2064 }
2065 PyErr_Clear();
2066 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002067}
2068
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002069PyObject *
2070PyMapping_Keys(PyObject *o)
2071{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002072 PyObject *keys;
2073 PyObject *fast;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002074 _Py_IDENTIFIER(keys);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002075
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002076 if (PyDict_CheckExact(o))
2077 return PyDict_Keys(o);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002078 keys = _PyObject_CallMethodId(o, &PyId_keys, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002079 if (keys == NULL)
2080 return NULL;
2081 fast = PySequence_Fast(keys, "o.keys() are not iterable");
2082 Py_DECREF(keys);
2083 return fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002084}
2085
2086PyObject *
2087PyMapping_Items(PyObject *o)
2088{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002089 PyObject *items;
2090 PyObject *fast;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002091 _Py_IDENTIFIER(items);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002092
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002093 if (PyDict_CheckExact(o))
2094 return PyDict_Items(o);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002095 items = _PyObject_CallMethodId(o, &PyId_items, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002096 if (items == NULL)
2097 return NULL;
2098 fast = PySequence_Fast(items, "o.items() are not iterable");
2099 Py_DECREF(items);
2100 return fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002101}
2102
2103PyObject *
2104PyMapping_Values(PyObject *o)
2105{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002106 PyObject *values;
2107 PyObject *fast;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002108 _Py_IDENTIFIER(values);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002109
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002110 if (PyDict_CheckExact(o))
2111 return PyDict_Values(o);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002112 values = _PyObject_CallMethodId(o, &PyId_values, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002113 if (values == NULL)
2114 return NULL;
2115 fast = PySequence_Fast(values, "o.values() are not iterable");
2116 Py_DECREF(values);
2117 return fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002118}
2119
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002120/* Operations on callable objects */
2121
2122/* XXX PyCallable_Check() is in object.c */
2123
Guido van Rossume15dee51995-07-18 14:12:02 +00002124PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002125PyObject_CallObject(PyObject *o, PyObject *a)
Guido van Rossume15dee51995-07-18 14:12:02 +00002126{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002127 return PyEval_CallObjectWithKeywords(o, a, NULL);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002128}
Guido van Rossume15dee51995-07-18 14:12:02 +00002129
2130PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00002131PyObject_Call(PyObject *func, PyObject *arg, PyObject *kw)
2132{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002133 ternaryfunc call;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002134
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002135 if ((call = func->ob_type->tp_call) != NULL) {
2136 PyObject *result;
2137 if (Py_EnterRecursiveCall(" while calling a Python object"))
2138 return NULL;
2139 result = (*call)(func, arg, kw);
2140 Py_LeaveRecursiveCall();
2141 if (result == NULL && !PyErr_Occurred())
2142 PyErr_SetString(
2143 PyExc_SystemError,
2144 "NULL result without error in PyObject_Call");
2145 return result;
2146 }
2147 PyErr_Format(PyExc_TypeError, "'%.200s' object is not callable",
2148 func->ob_type->tp_name);
2149 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002150}
2151
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002152static PyObject*
2153call_function_tail(PyObject *callable, PyObject *args)
2154{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002155 PyObject *retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002156
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002157 if (args == NULL)
2158 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002159
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002160 if (!PyTuple_Check(args)) {
2161 PyObject *a;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002162
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002163 a = PyTuple_New(1);
2164 if (a == NULL) {
2165 Py_DECREF(args);
2166 return NULL;
2167 }
2168 PyTuple_SET_ITEM(a, 0, args);
2169 args = a;
2170 }
2171 retval = PyObject_Call(callable, args, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002172
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002173 Py_DECREF(args);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002174
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002175 return retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002176}
2177
Tim Peters6d6c1a32001-08-02 04:15:00 +00002178PyObject *
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002179PyObject_CallFunction(PyObject *callable, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002180{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002181 va_list va;
2182 PyObject *args;
Guido van Rossume15dee51995-07-18 14:12:02 +00002183
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002184 if (callable == NULL)
2185 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002186
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002187 if (format && *format) {
2188 va_start(va, format);
2189 args = Py_VaBuildValue(format, va);
2190 va_end(va);
2191 }
2192 else
2193 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002194
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002195 return call_function_tail(callable, args);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002196}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002197
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002198PyObject *
2199_PyObject_CallFunction_SizeT(PyObject *callable, char *format, ...)
2200{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002201 va_list va;
2202 PyObject *args;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002203
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002204 if (callable == NULL)
2205 return null_error();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002206
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002207 if (format && *format) {
2208 va_start(va, format);
2209 args = _Py_VaBuildValue_SizeT(format, va);
2210 va_end(va);
2211 }
2212 else
2213 args = PyTuple_New(0);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002214
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002215 return call_function_tail(callable, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002216}
2217
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002218static PyObject*
2219callmethod(PyObject* func, char *format, va_list va, int is_size_t)
2220{
2221 PyObject *retval = NULL;
2222 PyObject *args;
2223
2224 if (!PyCallable_Check(func)) {
2225 type_error("attribute of type '%.200s' is not callable", func);
2226 goto exit;
2227 }
2228
2229 if (format && *format) {
2230 if (is_size_t)
2231 args = _Py_VaBuildValue_SizeT(format, va);
2232 else
2233 args = Py_VaBuildValue(format, va);
2234 }
2235 else
2236 args = PyTuple_New(0);
2237
2238 retval = call_function_tail(func, args);
2239
2240 exit:
2241 /* args gets consumed in call_function_tail */
2242 Py_XDECREF(func);
2243
2244 return retval;
2245}
2246
Guido van Rossume15dee51995-07-18 14:12:02 +00002247PyObject *
Guido van Rossume15dee51995-07-18 14:12:02 +00002248PyObject_CallMethod(PyObject *o, char *name, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002249{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002250 va_list va;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002251 PyObject *func = NULL;
2252 PyObject *retval = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002253
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002254 if (o == NULL || name == NULL)
2255 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002256
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002257 func = PyObject_GetAttrString(o, name);
2258 if (func == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002259 return 0;
2260 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002261
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002262 va_start(va, format);
2263 retval = callmethod(func, format, va, 0);
2264 va_end(va);
2265 return retval;
2266}
2267
2268PyObject *
2269_PyObject_CallMethodId(PyObject *o, _Py_Identifier *name, char *format, ...)
2270{
2271 va_list va;
2272 PyObject *func = NULL;
2273 PyObject *retval = NULL;
2274
2275 if (o == NULL || name == NULL)
2276 return null_error();
2277
2278 func = _PyObject_GetAttrId(o, name);
2279 if (func == NULL) {
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002280 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002281 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002282
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002283 va_start(va, format);
2284 retval = callmethod(func, format, va, 0);
2285 va_end(va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002286 return retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002287}
2288
2289PyObject *
2290_PyObject_CallMethod_SizeT(PyObject *o, char *name, char *format, ...)
2291{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002292 va_list va;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002293 PyObject *func = NULL;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002294 PyObject *retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002295
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002296 if (o == NULL || name == NULL)
2297 return null_error();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002298
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002299 func = PyObject_GetAttrString(o, name);
2300 if (func == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002301 return 0;
2302 }
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002303 va_start(va, format);
2304 retval = callmethod(func, format, va, 1);
2305 va_end(va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002306 return retval;
Guido van Rossume15dee51995-07-18 14:12:02 +00002307}
Guido van Rossum823649d2001-03-21 18:40:58 +00002308
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002309PyObject *
2310_PyObject_CallMethodId_SizeT(PyObject *o, _Py_Identifier *name, char *format, ...)
2311{
2312 va_list va;
2313 PyObject *func = NULL;
2314 PyObject *retval;
2315
2316 if (o == NULL || name == NULL)
2317 return null_error();
2318
2319 func = _PyObject_GetAttrId(o, name);
2320 if (func == NULL) {
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002321 return NULL;
2322 }
2323 va_start(va, format);
2324 retval = callmethod(func, format, va, 1);
2325 va_end(va);
2326 return retval;
2327}
Guido van Rossum823649d2001-03-21 18:40:58 +00002328
Fred Drakeb421b8c2001-10-26 16:21:32 +00002329static PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002330objargs_mktuple(va_list va)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002331{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002332 int i, n = 0;
2333 va_list countva;
2334 PyObject *result, *tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002335
Alexander Belopolskyf0f45142010-08-11 17:31:17 +00002336 Py_VA_COPY(countva, va);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002337
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002338 while (((PyObject *)va_arg(countva, PyObject *)) != NULL)
2339 ++n;
2340 result = PyTuple_New(n);
2341 if (result != NULL && n > 0) {
2342 for (i = 0; i < n; ++i) {
2343 tmp = (PyObject *)va_arg(va, PyObject *);
2344 PyTuple_SET_ITEM(result, i, tmp);
2345 Py_INCREF(tmp);
2346 }
2347 }
2348 return result;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002349}
2350
2351PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002352PyObject_CallMethodObjArgs(PyObject *callable, PyObject *name, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002353{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002354 PyObject *args, *tmp;
2355 va_list vargs;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002356
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002357 if (callable == NULL || name == NULL)
2358 return null_error();
Fred Drakeb421b8c2001-10-26 16:21:32 +00002359
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002360 callable = PyObject_GetAttr(callable, name);
2361 if (callable == NULL)
2362 return NULL;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002363
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002364 /* count the args */
2365 va_start(vargs, name);
2366 args = objargs_mktuple(vargs);
2367 va_end(vargs);
2368 if (args == NULL) {
2369 Py_DECREF(callable);
2370 return NULL;
2371 }
2372 tmp = PyObject_Call(callable, args, NULL);
2373 Py_DECREF(args);
2374 Py_DECREF(callable);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002375
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002376 return tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002377}
2378
2379PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002380PyObject_CallFunctionObjArgs(PyObject *callable, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002381{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002382 PyObject *args, *tmp;
2383 va_list vargs;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002384
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002385 if (callable == NULL)
2386 return null_error();
Fred Drakeb421b8c2001-10-26 16:21:32 +00002387
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002388 /* count the args */
2389 va_start(vargs, callable);
2390 args = objargs_mktuple(vargs);
2391 va_end(vargs);
2392 if (args == NULL)
2393 return NULL;
2394 tmp = PyObject_Call(callable, args, NULL);
2395 Py_DECREF(args);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002396
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002397 return tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002398}
2399
2400
Guido van Rossum823649d2001-03-21 18:40:58 +00002401/* isinstance(), issubclass() */
2402
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002403/* abstract_get_bases() has logically 4 return states:
Barry Warsawf16951c2002-04-23 22:45:44 +00002404 *
Barry Warsawf16951c2002-04-23 22:45:44 +00002405 * 1. getattr(cls, '__bases__') could raise an AttributeError
2406 * 2. getattr(cls, '__bases__') could raise some other exception
2407 * 3. getattr(cls, '__bases__') could return a tuple
2408 * 4. getattr(cls, '__bases__') could return something other than a tuple
2409 *
2410 * Only state #3 is a non-error state and only it returns a non-NULL object
2411 * (it returns the retrieved tuple).
2412 *
2413 * Any raised AttributeErrors are masked by clearing the exception and
2414 * returning NULL. If an object other than a tuple comes out of __bases__,
2415 * then again, the return value is NULL. So yes, these two situations
2416 * produce exactly the same results: NULL is returned and no error is set.
2417 *
2418 * If some exception other than AttributeError is raised, then NULL is also
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002419 * returned, but the exception is not cleared. That's because we want the
Barry Warsawf16951c2002-04-23 22:45:44 +00002420 * exception to be propagated along.
2421 *
2422 * Callers are expected to test for PyErr_Occurred() when the return value
2423 * is NULL to decide whether a valid exception should be propagated or not.
2424 * When there's no exception to propagate, it's customary for the caller to
2425 * set a TypeError.
2426 */
Neil Schemenauer6b471292001-10-18 03:18:43 +00002427static PyObject *
2428abstract_get_bases(PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002429{
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002430 _Py_IDENTIFIER(__bases__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002431 PyObject *bases;
Guido van Rossum823649d2001-03-21 18:40:58 +00002432
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002433 Py_ALLOW_RECURSION
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002434 bases = _PyObject_GetAttrId(cls, &PyId___bases__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002435 Py_END_ALLOW_RECURSION
2436 if (bases == NULL) {
2437 if (PyErr_ExceptionMatches(PyExc_AttributeError))
2438 PyErr_Clear();
2439 return NULL;
2440 }
2441 if (!PyTuple_Check(bases)) {
2442 Py_DECREF(bases);
2443 return NULL;
2444 }
2445 return bases;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002446}
2447
2448
2449static int
2450abstract_issubclass(PyObject *derived, PyObject *cls)
2451{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002452 PyObject *bases = NULL;
2453 Py_ssize_t i, n;
2454 int r = 0;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002455
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002456 while (1) {
2457 if (derived == cls)
2458 return 1;
2459 bases = abstract_get_bases(derived);
2460 if (bases == NULL) {
2461 if (PyErr_Occurred())
2462 return -1;
2463 return 0;
2464 }
2465 n = PyTuple_GET_SIZE(bases);
2466 if (n == 0) {
2467 Py_DECREF(bases);
2468 return 0;
2469 }
2470 /* Avoid recursivity in the single inheritance case */
2471 if (n == 1) {
2472 derived = PyTuple_GET_ITEM(bases, 0);
2473 Py_DECREF(bases);
2474 continue;
2475 }
2476 for (i = 0; i < n; i++) {
2477 r = abstract_issubclass(PyTuple_GET_ITEM(bases, i), cls);
2478 if (r != 0)
2479 break;
2480 }
2481 Py_DECREF(bases);
2482 return r;
2483 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002484}
2485
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002486static int
2487check_class(PyObject *cls, const char *error)
2488{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002489 PyObject *bases = abstract_get_bases(cls);
2490 if (bases == NULL) {
2491 /* Do not mask errors. */
2492 if (!PyErr_Occurred())
2493 PyErr_SetString(PyExc_TypeError, error);
2494 return 0;
2495 }
2496 Py_DECREF(bases);
2497 return -1;
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002498}
2499
Brett Cannon4f653312004-03-20 22:52:14 +00002500static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002501recursive_isinstance(PyObject *inst, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002502{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002503 PyObject *icls;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002504 int retval = 0;
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002505 _Py_IDENTIFIER(__class__);
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002506
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002507 if (PyType_Check(cls)) {
2508 retval = PyObject_TypeCheck(inst, (PyTypeObject *)cls);
2509 if (retval == 0) {
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002510 PyObject *c = _PyObject_GetAttrId(inst, &PyId___class__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002511 if (c == NULL) {
Benjamin Peterson72288d42010-11-20 17:21:08 +00002512 if (PyErr_ExceptionMatches(PyExc_AttributeError))
R. David Murray6bb99892010-11-20 16:33:30 +00002513 PyErr_Clear();
Benjamin Peterson72288d42010-11-20 17:21:08 +00002514 else
R. David Murray6bb99892010-11-20 16:33:30 +00002515 retval = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002516 }
2517 else {
2518 if (c != (PyObject *)(inst->ob_type) &&
2519 PyType_Check(c))
2520 retval = PyType_IsSubtype(
2521 (PyTypeObject *)c,
2522 (PyTypeObject *)cls);
2523 Py_DECREF(c);
2524 }
2525 }
2526 }
2527 else {
2528 if (!check_class(cls,
Benjamin Petersone893af52010-06-28 19:43:42 +00002529 "isinstance() arg 2 must be a type or tuple of types"))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002530 return -1;
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002531 icls = _PyObject_GetAttrId(inst, &PyId___class__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002532 if (icls == NULL) {
Benjamin Peterson72288d42010-11-20 17:21:08 +00002533 if (PyErr_ExceptionMatches(PyExc_AttributeError))
R. David Murray6bb99892010-11-20 16:33:30 +00002534 PyErr_Clear();
Benjamin Peterson72288d42010-11-20 17:21:08 +00002535 else
R. David Murray6bb99892010-11-20 16:33:30 +00002536 retval = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002537 }
2538 else {
2539 retval = abstract_issubclass(icls, cls);
2540 Py_DECREF(icls);
2541 }
2542 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002543
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002544 return retval;
Guido van Rossum823649d2001-03-21 18:40:58 +00002545}
2546
2547int
Brett Cannon4f653312004-03-20 22:52:14 +00002548PyObject_IsInstance(PyObject *inst, PyObject *cls)
2549{
Benjamin Petersonce798522012-01-22 11:24:29 -05002550 _Py_IDENTIFIER(__instancecheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002551 PyObject *checker;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002552
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002553 /* Quick test for an exact match */
2554 if (Py_TYPE(inst) == (PyTypeObject *)cls)
2555 return 1;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002556
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002557 if (PyTuple_Check(cls)) {
2558 Py_ssize_t i;
2559 Py_ssize_t n;
2560 int r = 0;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002561
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002562 if (Py_EnterRecursiveCall(" in __instancecheck__"))
2563 return -1;
2564 n = PyTuple_GET_SIZE(cls);
2565 for (i = 0; i < n; ++i) {
2566 PyObject *item = PyTuple_GET_ITEM(cls, i);
2567 r = PyObject_IsInstance(inst, item);
2568 if (r != 0)
2569 /* either found it, or got an error */
2570 break;
2571 }
2572 Py_LeaveRecursiveCall();
2573 return r;
2574 }
Benjamin Peterson88fe5f92009-05-16 21:55:24 +00002575
Benjamin Petersonce798522012-01-22 11:24:29 -05002576 checker = _PyObject_LookupSpecial(cls, &PyId___instancecheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002577 if (checker != NULL) {
2578 PyObject *res;
2579 int ok = -1;
2580 if (Py_EnterRecursiveCall(" in __instancecheck__")) {
2581 Py_DECREF(checker);
2582 return ok;
2583 }
2584 res = PyObject_CallFunctionObjArgs(checker, inst, NULL);
2585 Py_LeaveRecursiveCall();
2586 Py_DECREF(checker);
2587 if (res != NULL) {
2588 ok = PyObject_IsTrue(res);
2589 Py_DECREF(res);
2590 }
2591 return ok;
2592 }
2593 else if (PyErr_Occurred())
2594 return -1;
2595 return recursive_isinstance(inst, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002596}
2597
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002598static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002599recursive_issubclass(PyObject *derived, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002600{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002601 if (PyType_Check(cls) && PyType_Check(derived)) {
2602 /* Fast path (non-recursive) */
2603 return PyType_IsSubtype((PyTypeObject *)derived, (PyTypeObject *)cls);
2604 }
2605 if (!check_class(derived,
2606 "issubclass() arg 1 must be a class"))
2607 return -1;
2608 if (!check_class(cls,
2609 "issubclass() arg 2 must be a class"
2610 " or tuple of classes"))
2611 return -1;
Guido van Rossum823649d2001-03-21 18:40:58 +00002612
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002613 return abstract_issubclass(derived, cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002614}
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002615
Brett Cannon4f653312004-03-20 22:52:14 +00002616int
2617PyObject_IsSubclass(PyObject *derived, PyObject *cls)
2618{
Benjamin Petersonce798522012-01-22 11:24:29 -05002619 _Py_IDENTIFIER(__subclasscheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002620 PyObject *checker;
Georg Brandldcfe8e42009-05-17 08:22:45 +00002621
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002622 if (PyTuple_Check(cls)) {
2623 Py_ssize_t i;
2624 Py_ssize_t n;
2625 int r = 0;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002626
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002627 if (Py_EnterRecursiveCall(" in __subclasscheck__"))
2628 return -1;
2629 n = PyTuple_GET_SIZE(cls);
2630 for (i = 0; i < n; ++i) {
2631 PyObject *item = PyTuple_GET_ITEM(cls, i);
2632 r = PyObject_IsSubclass(derived, item);
2633 if (r != 0)
2634 /* either found it, or got an error */
2635 break;
2636 }
2637 Py_LeaveRecursiveCall();
2638 return r;
2639 }
Benjamin Peterson88fe5f92009-05-16 21:55:24 +00002640
Benjamin Petersonce798522012-01-22 11:24:29 -05002641 checker = _PyObject_LookupSpecial(cls, &PyId___subclasscheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002642 if (checker != NULL) {
2643 PyObject *res;
2644 int ok = -1;
2645 if (Py_EnterRecursiveCall(" in __subclasscheck__")) {
2646 Py_DECREF(checker);
2647 return ok;
2648 }
2649 res = PyObject_CallFunctionObjArgs(checker, derived, NULL);
2650 Py_LeaveRecursiveCall();
2651 Py_DECREF(checker);
2652 if (res != NULL) {
2653 ok = PyObject_IsTrue(res);
2654 Py_DECREF(res);
2655 }
2656 return ok;
2657 }
2658 else if (PyErr_Occurred())
2659 return -1;
2660 return recursive_issubclass(derived, cls);
Antoine Pitrouec569b72008-08-26 22:40:48 +00002661}
2662
2663int
2664_PyObject_RealIsInstance(PyObject *inst, PyObject *cls)
2665{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002666 return recursive_isinstance(inst, cls);
Antoine Pitrouec569b72008-08-26 22:40:48 +00002667}
2668
2669int
2670_PyObject_RealIsSubclass(PyObject *derived, PyObject *cls)
2671{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002672 return recursive_issubclass(derived, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002673}
2674
2675
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002676PyObject *
2677PyObject_GetIter(PyObject *o)
2678{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002679 PyTypeObject *t = o->ob_type;
2680 getiterfunc f = NULL;
2681 f = t->tp_iter;
2682 if (f == NULL) {
2683 if (PySequence_Check(o))
2684 return PySeqIter_New(o);
2685 return type_error("'%.200s' object is not iterable", o);
2686 }
2687 else {
2688 PyObject *res = (*f)(o);
2689 if (res != NULL && !PyIter_Check(res)) {
2690 PyErr_Format(PyExc_TypeError,
2691 "iter() returned non-iterator "
2692 "of type '%.100s'",
2693 res->ob_type->tp_name);
2694 Py_DECREF(res);
2695 res = NULL;
2696 }
2697 return res;
2698 }
Guido van Rossum213c7a62001-04-23 14:08:49 +00002699}
2700
Tim Petersf4848da2001-05-05 00:14:56 +00002701/* Return next item.
2702 * If an error occurs, return NULL. PyErr_Occurred() will be true.
2703 * If the iteration terminates normally, return NULL and clear the
2704 * PyExc_StopIteration exception (if it was set). PyErr_Occurred()
2705 * will be false.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002706 * Else return the next object. PyErr_Occurred() will be false.
Tim Petersf4848da2001-05-05 00:14:56 +00002707 */
Guido van Rossum213c7a62001-04-23 14:08:49 +00002708PyObject *
2709PyIter_Next(PyObject *iter)
2710{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002711 PyObject *result;
2712 result = (*iter->ob_type->tp_iternext)(iter);
2713 if (result == NULL &&
2714 PyErr_Occurred() &&
2715 PyErr_ExceptionMatches(PyExc_StopIteration))
2716 PyErr_Clear();
2717 return result;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002718}
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002719
2720
2721/*
2722 * Flatten a sequence of bytes() objects into a C array of
2723 * NULL terminated string pointers with a NULL char* terminating the array.
2724 * (ie: an argv or env list)
2725 *
2726 * Memory allocated for the returned list is allocated using malloc() and MUST
2727 * be freed by the caller using a free() loop or _Py_FreeCharPArray().
2728 */
2729char *const *
2730_PySequence_BytesToCharpArray(PyObject* self)
2731{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002732 char **array;
2733 Py_ssize_t i, argc;
2734 PyObject *item = NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002735
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002736 argc = PySequence_Size(self);
2737 if (argc == -1)
2738 return NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002739
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002740 array = malloc((argc + 1) * sizeof(char *));
2741 if (array == NULL) {
2742 PyErr_NoMemory();
2743 return NULL;
2744 }
2745 for (i = 0; i < argc; ++i) {
2746 char *data;
2747 item = PySequence_GetItem(self, i);
2748 data = PyBytes_AsString(item);
2749 if (data == NULL) {
2750 /* NULL terminate before freeing. */
2751 array[i] = NULL;
2752 goto fail;
2753 }
2754 array[i] = strdup(data);
2755 if (!array[i]) {
2756 PyErr_NoMemory();
2757 goto fail;
2758 }
2759 Py_DECREF(item);
2760 }
2761 array[argc] = NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002762
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002763 return array;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002764
2765fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002766 Py_XDECREF(item);
2767 _Py_FreeCharPArray(array);
2768 return NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002769}
2770
2771
2772/* Free's a NULL terminated char** array of C strings. */
2773void
2774_Py_FreeCharPArray(char *const array[])
2775{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002776 Py_ssize_t i;
2777 for (i = 0; array[i] != NULL; ++i) {
2778 free(array[i]);
2779 }
2780 free((void*)array);
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002781}