blob: 1b6c2b427965e9c26d193f2cfbd6044fd3128c22 [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{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000077 static PyObject *hintstrobj = NULL;
78 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__() */
92 hintmeth = _PyObject_LookupSpecial(o, "__length_hint__", &hintstrobj);
93 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,
240 "expected an object with the buffer interface");
241 return -1;
242 }
243 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE)) return -1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000244
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000245 *buffer = view.buf;
246 *buffer_len = view.len;
247 if (pb->bf_releasebuffer != NULL)
248 (*pb->bf_releasebuffer)(obj, &view);
249 Py_XDECREF(view.obj);
250 return 0;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000251}
Guido van Rossum4c08d552000-03-10 22:55:18 +0000252
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000253int
254PyObject_CheckReadBuffer(PyObject *obj)
255{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000256 PyBufferProcs *pb = obj->ob_type->tp_as_buffer;
257 Py_buffer view;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000258
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000259 if (pb == NULL ||
260 pb->bf_getbuffer == NULL)
261 return 0;
262 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE) == -1) {
263 PyErr_Clear();
264 return 0;
265 }
266 PyBuffer_Release(&view);
267 return 1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000268}
269
270int PyObject_AsReadBuffer(PyObject *obj,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000271 const void **buffer,
272 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000273{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000274 PyBufferProcs *pb;
275 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000276
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000277 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
278 null_error();
279 return -1;
280 }
281 pb = obj->ob_type->tp_as_buffer;
282 if (pb == NULL ||
283 pb->bf_getbuffer == NULL) {
284 PyErr_SetString(PyExc_TypeError,
285 "expected an object with a buffer interface");
286 return -1;
287 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000288
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000289 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE)) return -1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000290
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000291 *buffer = view.buf;
292 *buffer_len = view.len;
293 if (pb->bf_releasebuffer != NULL)
294 (*pb->bf_releasebuffer)(obj, &view);
295 Py_XDECREF(view.obj);
296 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000297}
298
299int PyObject_AsWriteBuffer(PyObject *obj,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000300 void **buffer,
301 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000302{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000303 PyBufferProcs *pb;
304 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000305
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000306 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
307 null_error();
308 return -1;
309 }
310 pb = obj->ob_type->tp_as_buffer;
311 if (pb == NULL ||
312 pb->bf_getbuffer == NULL ||
313 ((*pb->bf_getbuffer)(obj, &view, PyBUF_WRITABLE) != 0)) {
314 PyErr_SetString(PyExc_TypeError,
315 "expected an object with a writable buffer interface");
316 return -1;
317 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000318
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000319 *buffer = view.buf;
320 *buffer_len = view.len;
321 if (pb->bf_releasebuffer != NULL)
322 (*pb->bf_releasebuffer)(obj, &view);
323 Py_XDECREF(view.obj);
324 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000325}
326
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000327/* Buffer C-API for Python 3.0 */
328
329int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000330PyObject_GetBuffer(PyObject *obj, Py_buffer *view, int flags)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000331{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000332 if (!PyObject_CheckBuffer(obj)) {
333 PyErr_Format(PyExc_TypeError,
334 "'%100s' does not support the buffer interface",
335 Py_TYPE(obj)->tp_name);
336 return -1;
337 }
338 return (*(obj->ob_type->tp_as_buffer->bf_getbuffer))(obj, view, flags);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000339}
340
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000341static int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000342_IsFortranContiguous(Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000343{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000344 Py_ssize_t sd, dim;
345 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000346
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000347 if (view->ndim == 0) return 1;
348 if (view->strides == NULL) return (view->ndim == 1);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000349
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000350 sd = view->itemsize;
351 if (view->ndim == 1) return (view->shape[0] == 1 ||
352 sd == view->strides[0]);
353 for (i=0; i<view->ndim; i++) {
354 dim = view->shape[i];
355 if (dim == 0) return 1;
356 if (view->strides[i] != sd) return 0;
357 sd *= dim;
358 }
359 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000360}
361
362static int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000363_IsCContiguous(Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000364{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000365 Py_ssize_t sd, dim;
366 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000367
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000368 if (view->ndim == 0) return 1;
369 if (view->strides == NULL) return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000370
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000371 sd = view->itemsize;
372 if (view->ndim == 1) return (view->shape[0] == 1 ||
373 sd == view->strides[0]);
374 for (i=view->ndim-1; i>=0; i--) {
375 dim = view->shape[i];
376 if (dim == 0) return 1;
377 if (view->strides[i] != sd) return 0;
378 sd *= dim;
379 }
380 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000381}
382
383int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000384PyBuffer_IsContiguous(Py_buffer *view, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000385{
386
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000387 if (view->suboffsets != NULL) return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000388
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000389 if (fort == 'C')
390 return _IsCContiguous(view);
391 else if (fort == 'F')
392 return _IsFortranContiguous(view);
393 else if (fort == 'A')
394 return (_IsCContiguous(view) || _IsFortranContiguous(view));
395 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000396}
397
398
Guido van Rossum98297ee2007-11-06 21:34:58 +0000399void*
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000400PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000401{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000402 char* pointer;
403 int i;
404 pointer = (char *)view->buf;
405 for (i = 0; i < view->ndim; i++) {
406 pointer += view->strides[i]*indices[i];
407 if ((view->suboffsets != NULL) && (view->suboffsets[i] >= 0)) {
408 pointer = *((char**)pointer) + view->suboffsets[i];
409 }
410 }
411 return (void*)pointer;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000412}
413
414
Guido van Rossum98297ee2007-11-06 21:34:58 +0000415void
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000416_add_one_to_index_F(int nd, Py_ssize_t *index, Py_ssize_t *shape)
417{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000418 int k;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000419
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000420 for (k=0; k<nd; k++) {
421 if (index[k] < shape[k]-1) {
422 index[k]++;
423 break;
424 }
425 else {
426 index[k] = 0;
427 }
428 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000429}
430
Guido van Rossum98297ee2007-11-06 21:34:58 +0000431void
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000432_add_one_to_index_C(int nd, Py_ssize_t *index, Py_ssize_t *shape)
433{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000434 int k;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000435
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000436 for (k=nd-1; k>=0; k--) {
437 if (index[k] < shape[k]-1) {
438 index[k]++;
439 break;
440 }
441 else {
442 index[k] = 0;
443 }
444 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000445}
446
447 /* view is not checked for consistency in either of these. It is
Guido van Rossum98297ee2007-11-06 21:34:58 +0000448 assumed that the size of the buffer is view->len in
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000449 view->len / view->itemsize elements.
450 */
451
Guido van Rossum98297ee2007-11-06 21:34:58 +0000452int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000453PyBuffer_ToContiguous(void *buf, Py_buffer *view, Py_ssize_t len, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000454{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000455 int k;
456 void (*addone)(int, Py_ssize_t *, Py_ssize_t *);
457 Py_ssize_t *indices, elements;
458 char *dest, *ptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000459
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000460 if (len > view->len) {
461 len = view->len;
462 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000463
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000464 if (PyBuffer_IsContiguous(view, fort)) {
465 /* simplest copy is all that is needed */
466 memcpy(buf, view->buf, len);
467 return 0;
468 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000469
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000470 /* Otherwise a more elaborate scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000471
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000472 /* XXX(nnorwitz): need to check for overflow! */
473 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
474 if (indices == NULL) {
475 PyErr_NoMemory();
476 return -1;
477 }
478 for (k=0; k<view->ndim;k++) {
479 indices[k] = 0;
480 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000481
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000482 if (fort == 'F') {
483 addone = _add_one_to_index_F;
484 }
485 else {
486 addone = _add_one_to_index_C;
487 }
488 dest = buf;
489 /* XXX : This is not going to be the fastest code in the world
490 several optimizations are possible.
491 */
492 elements = len / view->itemsize;
493 while (elements--) {
494 addone(view->ndim, indices, view->shape);
495 ptr = PyBuffer_GetPointer(view, indices);
496 memcpy(dest, ptr, view->itemsize);
497 dest += view->itemsize;
498 }
499 PyMem_Free(indices);
500 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000501}
502
503int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000504PyBuffer_FromContiguous(Py_buffer *view, void *buf, Py_ssize_t len, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000505{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000506 int k;
507 void (*addone)(int, Py_ssize_t *, Py_ssize_t *);
508 Py_ssize_t *indices, elements;
509 char *src, *ptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000510
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000511 if (len > view->len) {
512 len = view->len;
513 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000514
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000515 if (PyBuffer_IsContiguous(view, fort)) {
516 /* simplest copy is all that is needed */
517 memcpy(view->buf, buf, len);
518 return 0;
519 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000520
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000521 /* Otherwise a more elaborate scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000522
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000523 /* XXX(nnorwitz): need to check for overflow! */
524 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
525 if (indices == NULL) {
526 PyErr_NoMemory();
527 return -1;
528 }
529 for (k=0; k<view->ndim;k++) {
530 indices[k] = 0;
531 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000532
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000533 if (fort == 'F') {
534 addone = _add_one_to_index_F;
535 }
536 else {
537 addone = _add_one_to_index_C;
538 }
539 src = buf;
540 /* XXX : This is not going to be the fastest code in the world
541 several optimizations are possible.
542 */
543 elements = len / view->itemsize;
544 while (elements--) {
545 addone(view->ndim, indices, view->shape);
546 ptr = PyBuffer_GetPointer(view, indices);
547 memcpy(ptr, src, view->itemsize);
548 src += view->itemsize;
549 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000550
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000551 PyMem_Free(indices);
552 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000553}
554
Guido van Rossum98297ee2007-11-06 21:34:58 +0000555int PyObject_CopyData(PyObject *dest, PyObject *src)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000556{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000557 Py_buffer view_dest, view_src;
558 int k;
559 Py_ssize_t *indices, elements;
560 char *dptr, *sptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000561
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000562 if (!PyObject_CheckBuffer(dest) ||
563 !PyObject_CheckBuffer(src)) {
564 PyErr_SetString(PyExc_TypeError,
565 "both destination and source must have the "\
566 "buffer interface");
567 return -1;
568 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000569
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000570 if (PyObject_GetBuffer(dest, &view_dest, PyBUF_FULL) != 0) return -1;
571 if (PyObject_GetBuffer(src, &view_src, PyBUF_FULL_RO) != 0) {
572 PyBuffer_Release(&view_dest);
573 return -1;
574 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000575
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000576 if (view_dest.len < view_src.len) {
577 PyErr_SetString(PyExc_BufferError,
578 "destination is too small to receive data from source");
579 PyBuffer_Release(&view_dest);
580 PyBuffer_Release(&view_src);
581 return -1;
582 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000583
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000584 if ((PyBuffer_IsContiguous(&view_dest, 'C') &&
585 PyBuffer_IsContiguous(&view_src, 'C')) ||
586 (PyBuffer_IsContiguous(&view_dest, 'F') &&
587 PyBuffer_IsContiguous(&view_src, 'F'))) {
588 /* simplest copy is all that is needed */
589 memcpy(view_dest.buf, view_src.buf, view_src.len);
590 PyBuffer_Release(&view_dest);
591 PyBuffer_Release(&view_src);
592 return 0;
593 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000594
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000595 /* Otherwise a more elaborate copy scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000596
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000597 /* XXX(nnorwitz): need to check for overflow! */
598 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*view_src.ndim);
599 if (indices == NULL) {
600 PyErr_NoMemory();
601 PyBuffer_Release(&view_dest);
602 PyBuffer_Release(&view_src);
603 return -1;
604 }
605 for (k=0; k<view_src.ndim;k++) {
606 indices[k] = 0;
607 }
608 elements = 1;
609 for (k=0; k<view_src.ndim; k++) {
610 /* XXX(nnorwitz): can this overflow? */
611 elements *= view_src.shape[k];
612 }
613 while (elements--) {
614 _add_one_to_index_C(view_src.ndim, indices, view_src.shape);
615 dptr = PyBuffer_GetPointer(&view_dest, indices);
616 sptr = PyBuffer_GetPointer(&view_src, indices);
617 memcpy(dptr, sptr, view_src.itemsize);
618 }
619 PyMem_Free(indices);
620 PyBuffer_Release(&view_dest);
621 PyBuffer_Release(&view_src);
622 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000623}
624
625void
626PyBuffer_FillContiguousStrides(int nd, Py_ssize_t *shape,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000627 Py_ssize_t *strides, int itemsize,
628 char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000629{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000630 int k;
631 Py_ssize_t sd;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000632
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000633 sd = itemsize;
634 if (fort == 'F') {
635 for (k=0; k<nd; k++) {
636 strides[k] = sd;
637 sd *= shape[k];
638 }
639 }
640 else {
641 for (k=nd-1; k>=0; k--) {
642 strides[k] = sd;
643 sd *= shape[k];
644 }
645 }
646 return;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000647}
648
649int
Martin v. Löwis423be952008-08-13 15:53:07 +0000650PyBuffer_FillInfo(Py_buffer *view, PyObject *obj, void *buf, Py_ssize_t len,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000651 int readonly, int flags)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000652{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000653 if (view == NULL) return 0;
654 if (((flags & PyBUF_WRITABLE) == PyBUF_WRITABLE) &&
655 (readonly == 1)) {
656 PyErr_SetString(PyExc_BufferError,
657 "Object is not writable.");
658 return -1;
659 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000660
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000661 view->obj = obj;
662 if (obj)
663 Py_INCREF(obj);
664 view->buf = buf;
665 view->len = len;
666 view->readonly = readonly;
667 view->itemsize = 1;
668 view->format = NULL;
669 if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT)
670 view->format = "B";
671 view->ndim = 1;
672 view->shape = NULL;
673 if ((flags & PyBUF_ND) == PyBUF_ND)
674 view->shape = &(view->len);
675 view->strides = NULL;
676 if ((flags & PyBUF_STRIDES) == PyBUF_STRIDES)
677 view->strides = &(view->itemsize);
678 view->suboffsets = NULL;
679 view->internal = NULL;
680 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000681}
682
Martin v. Löwis423be952008-08-13 15:53:07 +0000683void
684PyBuffer_Release(Py_buffer *view)
685{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000686 PyObject *obj = view->obj;
687 if (obj && Py_TYPE(obj)->tp_as_buffer && Py_TYPE(obj)->tp_as_buffer->bf_releasebuffer)
688 Py_TYPE(obj)->tp_as_buffer->bf_releasebuffer(obj, view);
689 Py_XDECREF(obj);
690 view->obj = NULL;
Martin v. Löwis423be952008-08-13 15:53:07 +0000691}
692
Eric Smith8fd3eba2008-02-17 19:48:00 +0000693PyObject *
694PyObject_Format(PyObject *obj, PyObject *format_spec)
695{
Eric Smith8fd3eba2008-02-17 19:48:00 +0000696 PyObject *meth;
697 PyObject *empty = NULL;
698 PyObject *result = NULL;
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000699 static PyObject *format_cache = NULL;
Eric Smith8fd3eba2008-02-17 19:48:00 +0000700
701 /* If no format_spec is provided, use an empty string */
702 if (format_spec == NULL) {
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000703 empty = PyUnicode_FromUnicode(NULL, 0);
704 format_spec = empty;
Eric Smith8fd3eba2008-02-17 19:48:00 +0000705 }
706
Eric Smith8fd3eba2008-02-17 19:48:00 +0000707 /* Find the (unbound!) __format__ method (a borrowed reference) */
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000708 meth = _PyObject_LookupSpecial(obj, "__format__", &format_cache);
Eric Smith8fd3eba2008-02-17 19:48:00 +0000709 if (meth == NULL) {
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000710 if (!PyErr_Occurred())
711 PyErr_Format(PyExc_TypeError,
712 "Type %.100s doesn't define __format__",
713 Py_TYPE(obj)->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000714 goto done;
Eric Smith8fd3eba2008-02-17 19:48:00 +0000715 }
716
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000717 /* And call it. */
718 result = PyObject_CallFunctionObjArgs(meth, format_spec, NULL);
Eric Smith8fd3eba2008-02-17 19:48:00 +0000719
720 if (result && !PyUnicode_Check(result)) {
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000721 PyErr_SetString(PyExc_TypeError,
722 "__format__ method did not return string");
723 Py_DECREF(result);
724 result = NULL;
725 goto done;
Eric Smith8fd3eba2008-02-17 19:48:00 +0000726 }
727
728done:
729 Py_XDECREF(empty);
730 return result;
731}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000732/* Operations on numbers */
733
734int
Fred Drake79912472000-07-09 04:06:11 +0000735PyNumber_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +0000736{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000737 return o && o->ob_type->tp_as_number &&
738 (o->ob_type->tp_as_number->nb_int ||
739 o->ob_type->tp_as_number->nb_float);
Guido van Rossume15dee51995-07-18 14:12:02 +0000740}
741
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000742/* Binary operators */
Guido van Rossume15dee51995-07-18 14:12:02 +0000743
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000744#define NB_SLOT(x) offsetof(PyNumberMethods, x)
745#define NB_BINOP(nb_methods, slot) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000746 (*(binaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000747#define NB_TERNOP(nb_methods, slot) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000748 (*(ternaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000749
750/*
751 Calling scheme used for binary operations:
752
Neal Norwitz4886cc32006-08-21 17:06:07 +0000753 Order operations are tried until either a valid result or error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000754 w.op(v,w)[*], v.op(v,w), w.op(v,w)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000755
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000756 [*] only when v->ob_type != w->ob_type && w->ob_type is a subclass of
757 v->ob_type
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000758 */
759
760static PyObject *
761binary_op1(PyObject *v, PyObject *w, const int op_slot)
Guido van Rossume15dee51995-07-18 14:12:02 +0000762{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000763 PyObject *x;
764 binaryfunc slotv = NULL;
765 binaryfunc slotw = NULL;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000766
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000767 if (v->ob_type->tp_as_number != NULL)
768 slotv = NB_BINOP(v->ob_type->tp_as_number, op_slot);
769 if (w->ob_type != v->ob_type &&
770 w->ob_type->tp_as_number != NULL) {
771 slotw = NB_BINOP(w->ob_type->tp_as_number, op_slot);
772 if (slotw == slotv)
773 slotw = NULL;
774 }
775 if (slotv) {
776 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
777 x = slotw(v, w);
778 if (x != Py_NotImplemented)
779 return x;
780 Py_DECREF(x); /* can't do it */
781 slotw = NULL;
782 }
783 x = slotv(v, w);
784 if (x != Py_NotImplemented)
785 return x;
786 Py_DECREF(x); /* can't do it */
787 }
788 if (slotw) {
789 x = slotw(v, w);
790 if (x != Py_NotImplemented)
791 return x;
792 Py_DECREF(x); /* can't do it */
793 }
794 Py_INCREF(Py_NotImplemented);
795 return Py_NotImplemented;
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000796}
Guido van Rossum77660912002-04-16 16:32:50 +0000797
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000798static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000799binop_type_error(PyObject *v, PyObject *w, const char *op_name)
800{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000801 PyErr_Format(PyExc_TypeError,
802 "unsupported operand type(s) for %.100s: "
803 "'%.100s' and '%.100s'",
804 op_name,
805 v->ob_type->tp_name,
806 w->ob_type->tp_name);
807 return NULL;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000808}
809
810static PyObject *
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000811binary_op(PyObject *v, PyObject *w, const int op_slot, const char *op_name)
812{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000813 PyObject *result = binary_op1(v, w, op_slot);
814 if (result == Py_NotImplemented) {
815 Py_DECREF(result);
816 return binop_type_error(v, w, op_name);
817 }
818 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000819}
820
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000821
822/*
823 Calling scheme used for ternary operations:
824
Neal Norwitz4886cc32006-08-21 17:06:07 +0000825 Order operations are tried until either a valid result or error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000826 v.op(v,w,z), w.op(v,w,z), z.op(v,w,z)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000827 */
828
829static PyObject *
830ternary_op(PyObject *v,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000831 PyObject *w,
832 PyObject *z,
833 const int op_slot,
834 const char *op_name)
Guido van Rossume15dee51995-07-18 14:12:02 +0000835{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000836 PyNumberMethods *mv, *mw, *mz;
837 PyObject *x = NULL;
838 ternaryfunc slotv = NULL;
839 ternaryfunc slotw = NULL;
840 ternaryfunc slotz = NULL;
Guido van Rossum77660912002-04-16 16:32:50 +0000841
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000842 mv = v->ob_type->tp_as_number;
843 mw = w->ob_type->tp_as_number;
844 if (mv != NULL)
845 slotv = NB_TERNOP(mv, op_slot);
846 if (w->ob_type != v->ob_type &&
847 mw != NULL) {
848 slotw = NB_TERNOP(mw, op_slot);
849 if (slotw == slotv)
850 slotw = NULL;
851 }
852 if (slotv) {
853 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
854 x = slotw(v, w, z);
855 if (x != Py_NotImplemented)
856 return x;
857 Py_DECREF(x); /* can't do it */
858 slotw = NULL;
859 }
860 x = slotv(v, w, z);
861 if (x != Py_NotImplemented)
862 return x;
863 Py_DECREF(x); /* can't do it */
864 }
865 if (slotw) {
866 x = slotw(v, w, z);
867 if (x != Py_NotImplemented)
868 return x;
869 Py_DECREF(x); /* can't do it */
870 }
871 mz = z->ob_type->tp_as_number;
872 if (mz != NULL) {
873 slotz = NB_TERNOP(mz, op_slot);
874 if (slotz == slotv || slotz == slotw)
875 slotz = NULL;
876 if (slotz) {
877 x = slotz(v, w, z);
878 if (x != Py_NotImplemented)
879 return x;
880 Py_DECREF(x); /* can't do it */
881 }
882 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000883
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000884 if (z == Py_None)
885 PyErr_Format(
886 PyExc_TypeError,
887 "unsupported operand type(s) for ** or pow(): "
888 "'%.100s' and '%.100s'",
889 v->ob_type->tp_name,
890 w->ob_type->tp_name);
891 else
892 PyErr_Format(
893 PyExc_TypeError,
894 "unsupported operand type(s) for pow(): "
895 "'%.100s', '%.100s', '%.100s'",
896 v->ob_type->tp_name,
897 w->ob_type->tp_name,
898 z->ob_type->tp_name);
899 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000900}
901
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000902#define BINARY_FUNC(func, op, op_name) \
903 PyObject * \
904 func(PyObject *v, PyObject *w) { \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000905 return binary_op(v, w, NB_SLOT(op), op_name); \
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000906 }
Guido van Rossume15dee51995-07-18 14:12:02 +0000907
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000908BINARY_FUNC(PyNumber_Or, nb_or, "|")
909BINARY_FUNC(PyNumber_Xor, nb_xor, "^")
910BINARY_FUNC(PyNumber_And, nb_and, "&")
911BINARY_FUNC(PyNumber_Lshift, nb_lshift, "<<")
912BINARY_FUNC(PyNumber_Rshift, nb_rshift, ">>")
913BINARY_FUNC(PyNumber_Subtract, nb_subtract, "-")
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000914BINARY_FUNC(PyNumber_Divmod, nb_divmod, "divmod()")
Guido van Rossume15dee51995-07-18 14:12:02 +0000915
916PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000917PyNumber_Add(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000918{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000919 PyObject *result = binary_op1(v, w, NB_SLOT(nb_add));
920 if (result == Py_NotImplemented) {
921 PySequenceMethods *m = v->ob_type->tp_as_sequence;
922 Py_DECREF(result);
923 if (m && m->sq_concat) {
924 return (*m->sq_concat)(v, w);
925 }
926 result = binop_type_error(v, w, "+");
927 }
928 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000929}
930
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000931static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000932sequence_repeat(ssizeargfunc repeatfunc, PyObject *seq, PyObject *n)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000933{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000934 Py_ssize_t count;
935 if (PyIndex_Check(n)) {
936 count = PyNumber_AsSsize_t(n, PyExc_OverflowError);
937 if (count == -1 && PyErr_Occurred())
938 return NULL;
939 }
940 else {
941 return type_error("can't multiply sequence by "
942 "non-int of type '%.200s'", n);
943 }
944 return (*repeatfunc)(seq, count);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000945}
946
947PyObject *
948PyNumber_Multiply(PyObject *v, PyObject *w)
949{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000950 PyObject *result = binary_op1(v, w, NB_SLOT(nb_multiply));
951 if (result == Py_NotImplemented) {
952 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
953 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
954 Py_DECREF(result);
955 if (mv && mv->sq_repeat) {
956 return sequence_repeat(mv->sq_repeat, v, w);
957 }
958 else if (mw && mw->sq_repeat) {
959 return sequence_repeat(mw->sq_repeat, w, v);
960 }
961 result = binop_type_error(v, w, "*");
962 }
963 return result;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000964}
965
Guido van Rossume15dee51995-07-18 14:12:02 +0000966PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +0000967PyNumber_FloorDivide(PyObject *v, PyObject *w)
968{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000969 return binary_op(v, w, NB_SLOT(nb_floor_divide), "//");
Guido van Rossum4668b002001-08-08 05:00:18 +0000970}
971
972PyObject *
973PyNumber_TrueDivide(PyObject *v, PyObject *w)
974{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000975 return binary_op(v, w, NB_SLOT(nb_true_divide), "/");
Guido van Rossum4668b002001-08-08 05:00:18 +0000976}
977
978PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000979PyNumber_Remainder(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000980{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000981 return binary_op(v, w, NB_SLOT(nb_remainder), "%");
Guido van Rossume15dee51995-07-18 14:12:02 +0000982}
983
984PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000985PyNumber_Power(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossume15dee51995-07-18 14:12:02 +0000986{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000987 return ternary_op(v, w, z, NB_SLOT(nb_power), "** or pow()");
Guido van Rossume15dee51995-07-18 14:12:02 +0000988}
989
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000990/* Binary in-place operators */
991
992/* The in-place operators are defined to fall back to the 'normal',
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000993 non in-place operations, if the in-place methods are not in place.
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000994
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000995 - If the left hand object has the appropriate struct members, and
996 they are filled, call the appropriate function and return the
997 result. No coercion is done on the arguments; the left-hand object
998 is the one the operation is performed on, and it's up to the
999 function to deal with the right-hand object.
Guido van Rossum77660912002-04-16 16:32:50 +00001000
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001001 - Otherwise, in-place modification is not supported. Handle it exactly as
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001002 a non in-place operation of the same kind.
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001003
1004 */
1005
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001006static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001007binary_iop1(PyObject *v, PyObject *w, const int iop_slot, const int op_slot)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001008{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001009 PyNumberMethods *mv = v->ob_type->tp_as_number;
1010 if (mv != NULL) {
1011 binaryfunc slot = NB_BINOP(mv, iop_slot);
1012 if (slot) {
1013 PyObject *x = (slot)(v, w);
1014 if (x != Py_NotImplemented) {
1015 return x;
1016 }
1017 Py_DECREF(x);
1018 }
1019 }
1020 return binary_op1(v, w, op_slot);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001021}
1022
1023static PyObject *
1024binary_iop(PyObject *v, PyObject *w, const int iop_slot, const int op_slot,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001025 const char *op_name)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001026{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001027 PyObject *result = binary_iop1(v, w, iop_slot, op_slot);
1028 if (result == Py_NotImplemented) {
1029 Py_DECREF(result);
1030 return binop_type_error(v, w, op_name);
1031 }
1032 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001033}
1034
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001035#define INPLACE_BINOP(func, iop, op, op_name) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001036 PyObject * \
1037 func(PyObject *v, PyObject *w) { \
1038 return binary_iop(v, w, NB_SLOT(iop), NB_SLOT(op), op_name); \
1039 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001040
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001041INPLACE_BINOP(PyNumber_InPlaceOr, nb_inplace_or, nb_or, "|=")
1042INPLACE_BINOP(PyNumber_InPlaceXor, nb_inplace_xor, nb_xor, "^=")
1043INPLACE_BINOP(PyNumber_InPlaceAnd, nb_inplace_and, nb_and, "&=")
1044INPLACE_BINOP(PyNumber_InPlaceLshift, nb_inplace_lshift, nb_lshift, "<<=")
1045INPLACE_BINOP(PyNumber_InPlaceRshift, nb_inplace_rshift, nb_rshift, ">>=")
1046INPLACE_BINOP(PyNumber_InPlaceSubtract, nb_inplace_subtract, nb_subtract, "-=")
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001047
1048PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +00001049PyNumber_InPlaceFloorDivide(PyObject *v, PyObject *w)
1050{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001051 return binary_iop(v, w, NB_SLOT(nb_inplace_floor_divide),
1052 NB_SLOT(nb_floor_divide), "//=");
Guido van Rossum4668b002001-08-08 05:00:18 +00001053}
1054
1055PyObject *
1056PyNumber_InPlaceTrueDivide(PyObject *v, PyObject *w)
1057{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001058 return binary_iop(v, w, NB_SLOT(nb_inplace_true_divide),
1059 NB_SLOT(nb_true_divide), "/=");
Guido van Rossum4668b002001-08-08 05:00:18 +00001060}
1061
1062PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001063PyNumber_InPlaceAdd(PyObject *v, PyObject *w)
1064{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001065 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_add),
1066 NB_SLOT(nb_add));
1067 if (result == Py_NotImplemented) {
1068 PySequenceMethods *m = v->ob_type->tp_as_sequence;
1069 Py_DECREF(result);
1070 if (m != NULL) {
1071 binaryfunc f = NULL;
1072 f = m->sq_inplace_concat;
1073 if (f == NULL)
1074 f = m->sq_concat;
1075 if (f != NULL)
1076 return (*f)(v, w);
1077 }
1078 result = binop_type_error(v, w, "+=");
1079 }
1080 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001081}
1082
1083PyObject *
1084PyNumber_InPlaceMultiply(PyObject *v, PyObject *w)
1085{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001086 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_multiply),
1087 NB_SLOT(nb_multiply));
1088 if (result == Py_NotImplemented) {
1089 ssizeargfunc f = NULL;
1090 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
1091 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
1092 Py_DECREF(result);
1093 if (mv != NULL) {
1094 f = mv->sq_inplace_repeat;
1095 if (f == NULL)
1096 f = mv->sq_repeat;
1097 if (f != NULL)
1098 return sequence_repeat(f, v, w);
1099 }
1100 else if (mw != NULL) {
1101 /* Note that the right hand operand should not be
1102 * mutated in this case so sq_inplace_repeat is not
1103 * used. */
1104 if (mw->sq_repeat)
1105 return sequence_repeat(mw->sq_repeat, w, v);
1106 }
1107 result = binop_type_error(v, w, "*=");
1108 }
1109 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001110}
1111
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001112PyObject *
1113PyNumber_InPlaceRemainder(PyObject *v, PyObject *w)
1114{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001115 return binary_iop(v, w, NB_SLOT(nb_inplace_remainder),
1116 NB_SLOT(nb_remainder), "%=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001117}
1118
1119PyObject *
1120PyNumber_InPlacePower(PyObject *v, PyObject *w, PyObject *z)
1121{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001122 if (v->ob_type->tp_as_number &&
1123 v->ob_type->tp_as_number->nb_inplace_power != NULL) {
1124 return ternary_op(v, w, z, NB_SLOT(nb_inplace_power), "**=");
1125 }
1126 else {
1127 return ternary_op(v, w, z, NB_SLOT(nb_power), "**=");
1128 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001129}
1130
1131
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001132/* Unary operators and functions */
Guido van Rossume15dee51995-07-18 14:12:02 +00001133
1134PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001135PyNumber_Negative(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001136{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001137 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001138
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001139 if (o == NULL)
1140 return null_error();
1141 m = o->ob_type->tp_as_number;
1142 if (m && m->nb_negative)
1143 return (*m->nb_negative)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001144
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001145 return type_error("bad operand type for unary -: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001146}
1147
1148PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001149PyNumber_Positive(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001150{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001151 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001152
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001153 if (o == NULL)
1154 return null_error();
1155 m = o->ob_type->tp_as_number;
1156 if (m && m->nb_positive)
1157 return (*m->nb_positive)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001158
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001159 return type_error("bad operand type for unary +: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001160}
1161
1162PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001163PyNumber_Invert(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001164{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001165 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001166
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001167 if (o == NULL)
1168 return null_error();
1169 m = o->ob_type->tp_as_number;
1170 if (m && m->nb_invert)
1171 return (*m->nb_invert)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001172
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001173 return type_error("bad operand type for unary ~: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001174}
1175
1176PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001177PyNumber_Absolute(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001178{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001179 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001180
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001181 if (o == NULL)
1182 return null_error();
1183 m = o->ob_type->tp_as_number;
1184 if (m && m->nb_absolute)
1185 return m->nb_absolute(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001186
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001187 return type_error("bad operand type for abs(): '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001188}
1189
Guido van Rossum98297ee2007-11-06 21:34:58 +00001190/* Return a Python Int or Long from the object item
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001191 Raise TypeError if the result is not an int-or-long
Guido van Rossum98297ee2007-11-06 21:34:58 +00001192 or if the object cannot be interpreted as an index.
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001193*/
1194PyObject *
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001195PyNumber_Index(PyObject *item)
1196{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001197 PyObject *result = NULL;
1198 if (item == NULL)
1199 return null_error();
1200 if (PyLong_Check(item)) {
1201 Py_INCREF(item);
1202 return item;
1203 }
1204 if (PyIndex_Check(item)) {
1205 result = item->ob_type->tp_as_number->nb_index(item);
1206 if (result && !PyLong_Check(result)) {
1207 PyErr_Format(PyExc_TypeError,
1208 "__index__ returned non-int "
1209 "(type %.200s)",
1210 result->ob_type->tp_name);
1211 Py_DECREF(result);
1212 return NULL;
1213 }
1214 }
1215 else {
1216 PyErr_Format(PyExc_TypeError,
1217 "'%.200s' object cannot be interpreted "
1218 "as an integer", item->ob_type->tp_name);
1219 }
1220 return result;
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001221}
1222
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001223/* Return an error on Overflow only if err is not NULL*/
1224
1225Py_ssize_t
1226PyNumber_AsSsize_t(PyObject *item, PyObject *err)
1227{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001228 Py_ssize_t result;
1229 PyObject *runerr;
1230 PyObject *value = PyNumber_Index(item);
1231 if (value == NULL)
1232 return -1;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001233
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001234 /* We're done if PyLong_AsSsize_t() returns without error. */
1235 result = PyLong_AsSsize_t(value);
1236 if (result != -1 || !(runerr = PyErr_Occurred()))
1237 goto finish;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001238
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001239 /* Error handling code -- only manage OverflowError differently */
1240 if (!PyErr_GivenExceptionMatches(runerr, PyExc_OverflowError))
1241 goto finish;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001242
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001243 PyErr_Clear();
1244 /* If no error-handling desired then the default clipping
1245 is sufficient.
1246 */
1247 if (!err) {
1248 assert(PyLong_Check(value));
1249 /* Whether or not it is less than or equal to
1250 zero is determined by the sign of ob_size
1251 */
1252 if (_PyLong_Sign(value) < 0)
1253 result = PY_SSIZE_T_MIN;
1254 else
1255 result = PY_SSIZE_T_MAX;
1256 }
1257 else {
1258 /* Otherwise replace the error with caller's error object. */
1259 PyErr_Format(err,
1260 "cannot fit '%.200s' into an index-sized integer",
1261 item->ob_type->tp_name);
1262 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001263
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001264 finish:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001265 Py_DECREF(value);
1266 return result;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001267}
1268
1269
Christian Heimes15ebc882008-02-04 18:48:49 +00001270PyObject *
1271_PyNumber_ConvertIntegralToInt(PyObject *integral, const char* error_format)
1272{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001273 static PyObject *int_name = NULL;
1274 if (int_name == NULL) {
1275 int_name = PyUnicode_InternFromString("__int__");
1276 if (int_name == NULL)
1277 return NULL;
1278 }
Christian Heimes15ebc882008-02-04 18:48:49 +00001279
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001280 if (integral && !PyLong_Check(integral)) {
1281 /* Don't go through tp_as_number->nb_int to avoid
1282 hitting the classic class fallback to __trunc__. */
1283 PyObject *int_func = PyObject_GetAttr(integral, int_name);
1284 if (int_func == NULL) {
1285 PyErr_Clear(); /* Raise a different error. */
1286 goto non_integral_error;
1287 }
1288 Py_DECREF(integral);
1289 integral = PyEval_CallObject(int_func, NULL);
1290 Py_DECREF(int_func);
1291 if (integral && !PyLong_Check(integral)) {
1292 goto non_integral_error;
1293 }
1294 }
1295 return integral;
Christian Heimes15ebc882008-02-04 18:48:49 +00001296
1297non_integral_error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001298 PyErr_Format(PyExc_TypeError, error_format, Py_TYPE(integral)->tp_name);
1299 Py_DECREF(integral);
1300 return NULL;
Christian Heimes15ebc882008-02-04 18:48:49 +00001301}
1302
1303
Guido van Rossum9e896b32000-04-05 20:11:21 +00001304/* Add a check for embedded NULL-bytes in the argument. */
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001305static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001306long_from_string(const char *s, Py_ssize_t len)
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001307{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001308 char *end;
1309 PyObject *x;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001310
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001311 x = PyLong_FromString((char*)s, &end, 10);
1312 if (x == NULL)
1313 return NULL;
1314 if (end != s + len) {
1315 PyErr_SetString(PyExc_ValueError,
1316 "null byte in argument for int()");
1317 Py_DECREF(x);
1318 return NULL;
1319 }
1320 return x;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001321}
1322
Guido van Rossume15dee51995-07-18 14:12:02 +00001323PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001324PyNumber_Long(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001325{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001326 PyNumberMethods *m;
1327 static PyObject *trunc_name = NULL;
1328 PyObject *trunc_func;
1329 const char *buffer;
1330 Py_ssize_t buffer_len;
Guido van Rossume15dee51995-07-18 14:12:02 +00001331
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001332 if (trunc_name == NULL) {
1333 trunc_name = PyUnicode_InternFromString("__trunc__");
1334 if (trunc_name == NULL)
1335 return NULL;
1336 }
Christian Heimes15ebc882008-02-04 18:48:49 +00001337
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001338 if (o == NULL)
1339 return null_error();
1340 if (PyLong_CheckExact(o)) {
1341 Py_INCREF(o);
1342 return o;
1343 }
1344 m = o->ob_type->tp_as_number;
1345 if (m && m->nb_int) { /* This should include subclasses of int */
1346 PyObject *res = m->nb_int(o);
1347 if (res && !PyLong_Check(res)) {
1348 PyErr_Format(PyExc_TypeError,
1349 "__int__ returned non-int (type %.200s)",
1350 res->ob_type->tp_name);
1351 Py_DECREF(res);
1352 return NULL;
1353 }
1354 return res;
1355 }
1356 if (PyLong_Check(o)) /* An int subclass without nb_int */
1357 return _PyLong_Copy((PyLongObject *)o);
1358 trunc_func = PyObject_GetAttr(o, trunc_name);
1359 if (trunc_func) {
1360 PyObject *truncated = PyEval_CallObject(trunc_func, NULL);
1361 PyObject *int_instance;
1362 Py_DECREF(trunc_func);
1363 /* __trunc__ is specified to return an Integral type,
1364 but long() needs to return a long. */
1365 int_instance = _PyNumber_ConvertIntegralToInt(
1366 truncated,
1367 "__trunc__ returned non-Integral (type %.200s)");
1368 return int_instance;
1369 }
1370 PyErr_Clear(); /* It's not an error if o.__trunc__ doesn't exist. */
Christian Heimes15ebc882008-02-04 18:48:49 +00001371
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001372 if (PyBytes_Check(o))
1373 /* need to do extra error checking that PyLong_FromString()
1374 * doesn't do. In particular long('9.5') must raise an
1375 * exception, not truncate the float.
1376 */
1377 return long_from_string(PyBytes_AS_STRING(o),
1378 PyBytes_GET_SIZE(o));
1379 if (PyUnicode_Check(o))
1380 /* The above check is done in PyLong_FromUnicode(). */
1381 return PyLong_FromUnicode(PyUnicode_AS_UNICODE(o),
1382 PyUnicode_GET_SIZE(o),
1383 10);
1384 if (!PyObject_AsCharBuffer(o, &buffer, &buffer_len))
1385 return long_from_string(buffer, buffer_len);
Guido van Rossume15dee51995-07-18 14:12:02 +00001386
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001387 return type_error("int() argument must be a string or a "
1388 "number, not '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001389}
1390
1391PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001392PyNumber_Float(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001393{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001394 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001395
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001396 if (o == NULL)
1397 return null_error();
1398 m = o->ob_type->tp_as_number;
1399 if (m && m->nb_float) { /* This should include subclasses of float */
1400 PyObject *res = m->nb_float(o);
1401 if (res && !PyFloat_Check(res)) {
1402 PyErr_Format(PyExc_TypeError,
1403 "__float__ returned non-float (type %.200s)",
1404 res->ob_type->tp_name);
1405 Py_DECREF(res);
1406 return NULL;
1407 }
1408 return res;
1409 }
1410 if (PyFloat_Check(o)) { /* A float subclass with nb_float == NULL */
1411 PyFloatObject *po = (PyFloatObject *)o;
1412 return PyFloat_FromDouble(po->ob_fval);
1413 }
1414 return PyFloat_FromString(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001415}
1416
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001417
1418PyObject *
1419PyNumber_ToBase(PyObject *n, int base)
1420{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001421 PyObject *res = NULL;
1422 PyObject *index = PyNumber_Index(n);
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001423
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001424 if (!index)
1425 return NULL;
1426 if (PyLong_Check(index))
1427 res = _PyLong_Format(index, base);
1428 else
1429 /* It should not be possible to get here, as
1430 PyNumber_Index already has a check for the same
1431 condition */
1432 PyErr_SetString(PyExc_ValueError, "PyNumber_ToBase: index not "
1433 "int or long");
1434 Py_DECREF(index);
1435 return res;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001436}
1437
1438
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001439/* Operations on sequences */
Guido van Rossume15dee51995-07-18 14:12:02 +00001440
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001441int
Fred Drake79912472000-07-09 04:06:11 +00001442PySequence_Check(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001443{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001444 if (PyDict_Check(s))
1445 return 0;
1446 return s != NULL && s->ob_type->tp_as_sequence &&
1447 s->ob_type->tp_as_sequence->sq_item != NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001448}
1449
Martin v. Löwis18e16552006-02-15 17:27:45 +00001450Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001451PySequence_Size(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001452{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001453 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001454
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001455 if (s == NULL) {
1456 null_error();
1457 return -1;
1458 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001459
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001460 m = s->ob_type->tp_as_sequence;
1461 if (m && m->sq_length)
1462 return m->sq_length(s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001463
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001464 type_error("object of type '%.200s' has no len()", s);
1465 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001466}
1467
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001468#undef PySequence_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001469Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001470PySequence_Length(PyObject *s)
1471{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001472 return PySequence_Size(s);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001473}
1474#define PySequence_Length PySequence_Size
1475
Guido van Rossume15dee51995-07-18 14:12:02 +00001476PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001477PySequence_Concat(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001478{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001479 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001480
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001481 if (s == NULL || o == NULL)
1482 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001483
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001484 m = s->ob_type->tp_as_sequence;
1485 if (m && m->sq_concat)
1486 return m->sq_concat(s, o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001487
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001488 /* Instances of user classes defining an __add__() method only
1489 have an nb_add slot, not an sq_concat slot. So we fall back
1490 to nb_add if both arguments appear to be sequences. */
1491 if (PySequence_Check(s) && PySequence_Check(o)) {
1492 PyObject *result = binary_op1(s, o, NB_SLOT(nb_add));
1493 if (result != Py_NotImplemented)
1494 return result;
1495 Py_DECREF(result);
1496 }
1497 return type_error("'%.200s' object can't be concatenated", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001498}
1499
1500PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001501PySequence_Repeat(PyObject *o, Py_ssize_t count)
Guido van Rossume15dee51995-07-18 14:12:02 +00001502{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001503 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001504
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001505 if (o == NULL)
1506 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001507
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001508 m = o->ob_type->tp_as_sequence;
1509 if (m && m->sq_repeat)
1510 return m->sq_repeat(o, count);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001511
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001512 /* Instances of user classes defining a __mul__() method only
1513 have an nb_multiply slot, not an sq_repeat slot. so we fall back
1514 to nb_multiply if o appears to be a sequence. */
1515 if (PySequence_Check(o)) {
1516 PyObject *n, *result;
1517 n = PyLong_FromSsize_t(count);
1518 if (n == NULL)
1519 return NULL;
1520 result = binary_op1(o, n, NB_SLOT(nb_multiply));
1521 Py_DECREF(n);
1522 if (result != Py_NotImplemented)
1523 return result;
1524 Py_DECREF(result);
1525 }
1526 return type_error("'%.200s' object can't be repeated", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001527}
1528
1529PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001530PySequence_InPlaceConcat(PyObject *s, PyObject *o)
1531{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001532 PySequenceMethods *m;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001533
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001534 if (s == NULL || o == NULL)
1535 return null_error();
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001536
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001537 m = s->ob_type->tp_as_sequence;
1538 if (m && m->sq_inplace_concat)
1539 return m->sq_inplace_concat(s, o);
1540 if (m && m->sq_concat)
1541 return m->sq_concat(s, o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001542
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001543 if (PySequence_Check(s) && PySequence_Check(o)) {
1544 PyObject *result = binary_iop1(s, o, NB_SLOT(nb_inplace_add),
1545 NB_SLOT(nb_add));
1546 if (result != Py_NotImplemented)
1547 return result;
1548 Py_DECREF(result);
1549 }
1550 return type_error("'%.200s' object can't be concatenated", s);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001551}
1552
1553PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001554PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001555{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001556 PySequenceMethods *m;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001557
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001558 if (o == NULL)
1559 return null_error();
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001560
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001561 m = o->ob_type->tp_as_sequence;
1562 if (m && m->sq_inplace_repeat)
1563 return m->sq_inplace_repeat(o, count);
1564 if (m && m->sq_repeat)
1565 return m->sq_repeat(o, count);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001566
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001567 if (PySequence_Check(o)) {
1568 PyObject *n, *result;
1569 n = PyLong_FromSsize_t(count);
1570 if (n == NULL)
1571 return NULL;
1572 result = binary_iop1(o, n, NB_SLOT(nb_inplace_multiply),
1573 NB_SLOT(nb_multiply));
1574 Py_DECREF(n);
1575 if (result != Py_NotImplemented)
1576 return result;
1577 Py_DECREF(result);
1578 }
1579 return type_error("'%.200s' object can't be repeated", o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001580}
1581
1582PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001583PySequence_GetItem(PyObject *s, Py_ssize_t i)
Guido van Rossume15dee51995-07-18 14:12:02 +00001584{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001585 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001586
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001587 if (s == NULL)
1588 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001589
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001590 m = s->ob_type->tp_as_sequence;
1591 if (m && m->sq_item) {
1592 if (i < 0) {
1593 if (m->sq_length) {
1594 Py_ssize_t l = (*m->sq_length)(s);
1595 if (l < 0)
1596 return NULL;
1597 i += l;
1598 }
1599 }
1600 return m->sq_item(s, i);
1601 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001602
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001603 return type_error("'%.200s' object does not support indexing", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001604}
1605
1606PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001607PySequence_GetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossume15dee51995-07-18 14:12:02 +00001608{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001609 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001610
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001611 if (!s) return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001612
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001613 mp = s->ob_type->tp_as_mapping;
1614 if (mp->mp_subscript) {
1615 PyObject *res;
1616 PyObject *slice = _PySlice_FromIndices(i1, i2);
1617 if (!slice)
1618 return NULL;
1619 res = mp->mp_subscript(s, slice);
1620 Py_DECREF(slice);
1621 return res;
1622 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001623
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001624 return type_error("'%.200s' object is unsliceable", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001625}
1626
1627int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001628PySequence_SetItem(PyObject *s, Py_ssize_t i, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001629{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001630 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001631
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001632 if (s == NULL) {
1633 null_error();
1634 return -1;
1635 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001636
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001637 m = s->ob_type->tp_as_sequence;
1638 if (m && m->sq_ass_item) {
1639 if (i < 0) {
1640 if (m->sq_length) {
1641 Py_ssize_t l = (*m->sq_length)(s);
1642 if (l < 0)
1643 return -1;
1644 i += l;
1645 }
1646 }
1647 return m->sq_ass_item(s, i, o);
1648 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001649
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001650 type_error("'%.200s' object does not support item assignment", s);
1651 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001652}
1653
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001654int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001655PySequence_DelItem(PyObject *s, Py_ssize_t i)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001656{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001657 PySequenceMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001658
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001659 if (s == NULL) {
1660 null_error();
1661 return -1;
1662 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001663
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001664 m = s->ob_type->tp_as_sequence;
1665 if (m && m->sq_ass_item) {
1666 if (i < 0) {
1667 if (m->sq_length) {
1668 Py_ssize_t l = (*m->sq_length)(s);
1669 if (l < 0)
1670 return -1;
1671 i += l;
1672 }
1673 }
1674 return m->sq_ass_item(s, i, (PyObject *)NULL);
1675 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001676
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001677 type_error("'%.200s' object doesn't support item deletion", s);
1678 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001679}
1680
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001681int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001682PySequence_SetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001683{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001684 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001685
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001686 if (s == NULL) {
1687 null_error();
1688 return -1;
1689 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001690
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001691 mp = s->ob_type->tp_as_mapping;
1692 if (mp->mp_ass_subscript) {
1693 int res;
1694 PyObject *slice = _PySlice_FromIndices(i1, i2);
1695 if (!slice)
1696 return -1;
1697 res = mp->mp_ass_subscript(s, slice, o);
1698 Py_DECREF(slice);
1699 return res;
1700 }
Thomas Wouters1d75a792000-08-17 22:37:32 +00001701
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001702 type_error("'%.200s' object doesn't support slice assignment", s);
1703 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001704}
1705
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001706int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001707PySequence_DelSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001708{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001709 PyMappingMethods *mp;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001710
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001711 if (s == NULL) {
1712 null_error();
1713 return -1;
1714 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001715
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001716 mp = s->ob_type->tp_as_mapping;
1717 if (mp->mp_ass_subscript) {
1718 int res;
1719 PyObject *slice = _PySlice_FromIndices(i1, i2);
1720 if (!slice)
1721 return -1;
1722 res = mp->mp_ass_subscript(s, slice, NULL);
1723 Py_DECREF(slice);
1724 return res;
1725 }
1726 type_error("'%.200s' object doesn't support slice deletion", s);
1727 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001728}
1729
Guido van Rossume15dee51995-07-18 14:12:02 +00001730PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001731PySequence_Tuple(PyObject *v)
Guido van Rossume15dee51995-07-18 14:12:02 +00001732{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001733 PyObject *it; /* iter(v) */
1734 Py_ssize_t n; /* guess for result tuple size */
1735 PyObject *result = NULL;
1736 Py_ssize_t j;
Guido van Rossume15dee51995-07-18 14:12:02 +00001737
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001738 if (v == NULL)
1739 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001740
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001741 /* Special-case the common tuple and list cases, for efficiency. */
1742 if (PyTuple_CheckExact(v)) {
1743 /* Note that we can't know whether it's safe to return
1744 a tuple *subclass* instance as-is, hence the restriction
1745 to exact tuples here. In contrast, lists always make
1746 a copy, so there's no need for exactness below. */
1747 Py_INCREF(v);
1748 return v;
1749 }
1750 if (PyList_Check(v))
1751 return PyList_AsTuple(v);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001752
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001753 /* Get iterator. */
1754 it = PyObject_GetIter(v);
1755 if (it == NULL)
1756 return NULL;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001757
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001758 /* Guess result size and allocate space. */
1759 n = _PyObject_LengthHint(v, 10);
1760 if (n == -1)
1761 goto Fail;
1762 result = PyTuple_New(n);
1763 if (result == NULL)
1764 goto Fail;
Tim Peters6912d4d2001-05-05 03:56:37 +00001765
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001766 /* Fill the tuple. */
1767 for (j = 0; ; ++j) {
1768 PyObject *item = PyIter_Next(it);
1769 if (item == NULL) {
1770 if (PyErr_Occurred())
1771 goto Fail;
1772 break;
1773 }
1774 if (j >= n) {
1775 Py_ssize_t oldn = n;
1776 /* The over-allocation strategy can grow a bit faster
1777 than for lists because unlike lists the
1778 over-allocation isn't permanent -- we reclaim
1779 the excess before the end of this routine.
1780 So, grow by ten and then add 25%.
1781 */
1782 n += 10;
1783 n += n >> 2;
1784 if (n < oldn) {
1785 /* Check for overflow */
1786 PyErr_NoMemory();
1787 Py_DECREF(item);
1788 goto Fail;
1789 }
1790 if (_PyTuple_Resize(&result, n) != 0) {
1791 Py_DECREF(item);
1792 goto Fail;
1793 }
1794 }
1795 PyTuple_SET_ITEM(result, j, item);
1796 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001797
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001798 /* Cut tuple back if guess was too large. */
1799 if (j < n &&
1800 _PyTuple_Resize(&result, j) != 0)
1801 goto Fail;
Tim Peters6912d4d2001-05-05 03:56:37 +00001802
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001803 Py_DECREF(it);
1804 return result;
Tim Peters6912d4d2001-05-05 03:56:37 +00001805
1806Fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001807 Py_XDECREF(result);
1808 Py_DECREF(it);
1809 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001810}
1811
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001812PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001813PySequence_List(PyObject *v)
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001814{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001815 PyObject *result; /* result list */
1816 PyObject *rv; /* return value from PyList_Extend */
Guido van Rossum4669fb41997-04-02 05:31:09 +00001817
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001818 if (v == NULL)
1819 return null_error();
Guido van Rossum5dba9e81998-07-10 18:03:50 +00001820
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001821 result = PyList_New(0);
1822 if (result == NULL)
1823 return NULL;
Tim Petersf553f892001-05-01 20:45:31 +00001824
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001825 rv = _PyList_Extend((PyListObject *)result, v);
1826 if (rv == NULL) {
1827 Py_DECREF(result);
1828 return NULL;
1829 }
1830 Py_DECREF(rv);
1831 return result;
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001832}
1833
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001834PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001835PySequence_Fast(PyObject *v, const char *m)
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001836{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001837 PyObject *it;
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001838
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001839 if (v == NULL)
1840 return null_error();
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001841
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001842 if (PyList_CheckExact(v) || PyTuple_CheckExact(v)) {
1843 Py_INCREF(v);
1844 return v;
1845 }
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001846
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001847 it = PyObject_GetIter(v);
1848 if (it == NULL) {
1849 if (PyErr_ExceptionMatches(PyExc_TypeError))
1850 PyErr_SetString(PyExc_TypeError, m);
1851 return NULL;
1852 }
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001853
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001854 v = PySequence_List(it);
1855 Py_DECREF(it);
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001856
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001857 return v;
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001858}
1859
Tim Peters16a77ad2001-09-08 04:00:12 +00001860/* Iterate over seq. Result depends on the operation:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001861 PY_ITERSEARCH_COUNT: -1 if error, else # of times obj appears in seq.
1862 PY_ITERSEARCH_INDEX: 0-based index of first occurrence of obj in seq;
1863 set ValueError and return -1 if none found; also return -1 on error.
Tim Peters16a77ad2001-09-08 04:00:12 +00001864 Py_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on error.
1865*/
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001866Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001867_PySequence_IterSearch(PyObject *seq, PyObject *obj, int operation)
Guido van Rossume15dee51995-07-18 14:12:02 +00001868{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001869 Py_ssize_t n;
1870 int wrapped; /* for PY_ITERSEARCH_INDEX, true iff n wrapped around */
1871 PyObject *it; /* iter(seq) */
Guido van Rossume15dee51995-07-18 14:12:02 +00001872
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001873 if (seq == NULL || obj == NULL) {
1874 null_error();
1875 return -1;
1876 }
Tim Peters75f8e352001-05-05 11:33:43 +00001877
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001878 it = PyObject_GetIter(seq);
1879 if (it == NULL) {
1880 type_error("argument of type '%.200s' is not iterable", seq);
1881 return -1;
1882 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001883
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001884 n = wrapped = 0;
1885 for (;;) {
1886 int cmp;
1887 PyObject *item = PyIter_Next(it);
1888 if (item == NULL) {
1889 if (PyErr_Occurred())
1890 goto Fail;
1891 break;
1892 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001893
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001894 cmp = PyObject_RichCompareBool(obj, item, Py_EQ);
1895 Py_DECREF(item);
1896 if (cmp < 0)
1897 goto Fail;
1898 if (cmp > 0) {
1899 switch (operation) {
1900 case PY_ITERSEARCH_COUNT:
1901 if (n == PY_SSIZE_T_MAX) {
1902 PyErr_SetString(PyExc_OverflowError,
1903 "count exceeds C integer size");
1904 goto Fail;
1905 }
1906 ++n;
1907 break;
Tim Peters16a77ad2001-09-08 04:00:12 +00001908
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001909 case PY_ITERSEARCH_INDEX:
1910 if (wrapped) {
1911 PyErr_SetString(PyExc_OverflowError,
1912 "index exceeds C integer size");
1913 goto Fail;
1914 }
1915 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00001916
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001917 case PY_ITERSEARCH_CONTAINS:
1918 n = 1;
1919 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00001920
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001921 default:
1922 assert(!"unknown operation");
1923 }
1924 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001925
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001926 if (operation == PY_ITERSEARCH_INDEX) {
1927 if (n == PY_SSIZE_T_MAX)
1928 wrapped = 1;
1929 ++n;
1930 }
1931 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001932
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001933 if (operation != PY_ITERSEARCH_INDEX)
1934 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00001935
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001936 PyErr_SetString(PyExc_ValueError,
1937 "sequence.index(x): x not in sequence");
1938 /* fall into failure code */
Tim Peters16a77ad2001-09-08 04:00:12 +00001939Fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001940 n = -1;
1941 /* fall through */
Tim Peters16a77ad2001-09-08 04:00:12 +00001942Done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001943 Py_DECREF(it);
1944 return n;
Tim Peters75f8e352001-05-05 11:33:43 +00001945
Guido van Rossume15dee51995-07-18 14:12:02 +00001946}
1947
Tim Peters16a77ad2001-09-08 04:00:12 +00001948/* Return # of times o appears in s. */
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001949Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001950PySequence_Count(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001951{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001952 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_COUNT);
Guido van Rossume15dee51995-07-18 14:12:02 +00001953}
1954
Tim Peterscb8d3682001-05-05 21:05:01 +00001955/* Return -1 if error; 1 if ob in seq; 0 if ob not in seq.
Tim Peters16a77ad2001-09-08 04:00:12 +00001956 * Use sq_contains if possible, else defer to _PySequence_IterSearch().
Tim Peterscb8d3682001-05-05 21:05:01 +00001957 */
1958int
1959PySequence_Contains(PyObject *seq, PyObject *ob)
1960{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001961 Py_ssize_t result;
1962 PySequenceMethods *sqm = seq->ob_type->tp_as_sequence;
1963 if (sqm != NULL && sqm->sq_contains != NULL)
1964 return (*sqm->sq_contains)(seq, ob);
1965 result = _PySequence_IterSearch(seq, ob, PY_ITERSEARCH_CONTAINS);
1966 return Py_SAFE_DOWNCAST(result, Py_ssize_t, int);
Tim Peterscb8d3682001-05-05 21:05:01 +00001967}
1968
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001969/* Backwards compatibility */
1970#undef PySequence_In
1971int
Fred Drake79912472000-07-09 04:06:11 +00001972PySequence_In(PyObject *w, PyObject *v)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001973{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001974 return PySequence_Contains(w, v);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001975}
1976
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001977Py_ssize_t
Fred Drake79912472000-07-09 04:06:11 +00001978PySequence_Index(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001979{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001980 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_INDEX);
Guido van Rossume15dee51995-07-18 14:12:02 +00001981}
1982
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001983/* Operations on mappings */
1984
1985int
Fred Drake79912472000-07-09 04:06:11 +00001986PyMapping_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001987{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001988 return o && o->ob_type->tp_as_mapping &&
1989 o->ob_type->tp_as_mapping->mp_subscript;
Guido van Rossume15dee51995-07-18 14:12:02 +00001990}
1991
Martin v. Löwis18e16552006-02-15 17:27:45 +00001992Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001993PyMapping_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001994{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001995 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001996
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001997 if (o == NULL) {
1998 null_error();
1999 return -1;
2000 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002001
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002002 m = o->ob_type->tp_as_mapping;
2003 if (m && m->mp_length)
2004 return m->mp_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00002005
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002006 type_error("object of type '%.200s' has no len()", o);
2007 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00002008}
2009
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002010#undef PyMapping_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00002011Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002012PyMapping_Length(PyObject *o)
2013{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002014 return PyMapping_Size(o);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002015}
2016#define PyMapping_Length PyMapping_Size
2017
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002018PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002019PyMapping_GetItemString(PyObject *o, char *key)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002020{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002021 PyObject *okey, *r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002022
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002023 if (key == NULL)
2024 return null_error();
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002025
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002026 okey = PyUnicode_FromString(key);
2027 if (okey == NULL)
2028 return NULL;
2029 r = PyObject_GetItem(o, okey);
2030 Py_DECREF(okey);
2031 return r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002032}
2033
2034int
Fred Drake79912472000-07-09 04:06:11 +00002035PyMapping_SetItemString(PyObject *o, char *key, PyObject *value)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002036{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002037 PyObject *okey;
2038 int r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002039
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002040 if (key == NULL) {
2041 null_error();
2042 return -1;
2043 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002044
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002045 okey = PyUnicode_FromString(key);
2046 if (okey == NULL)
2047 return -1;
2048 r = PyObject_SetItem(o, okey, value);
2049 Py_DECREF(okey);
2050 return r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002051}
2052
2053int
Fred Drake79912472000-07-09 04:06:11 +00002054PyMapping_HasKeyString(PyObject *o, char *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002055{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002056 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002057
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002058 v = PyMapping_GetItemString(o, key);
2059 if (v) {
2060 Py_DECREF(v);
2061 return 1;
2062 }
2063 PyErr_Clear();
2064 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002065}
2066
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002067int
Fred Drake79912472000-07-09 04:06:11 +00002068PyMapping_HasKey(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002069{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002070 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002071
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002072 v = PyObject_GetItem(o, key);
2073 if (v) {
2074 Py_DECREF(v);
2075 return 1;
2076 }
2077 PyErr_Clear();
2078 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002079}
2080
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002081PyObject *
2082PyMapping_Keys(PyObject *o)
2083{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002084 PyObject *keys;
2085 PyObject *fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002086
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002087 if (PyDict_CheckExact(o))
2088 return PyDict_Keys(o);
2089 keys = PyObject_CallMethod(o, "keys", NULL);
2090 if (keys == NULL)
2091 return NULL;
2092 fast = PySequence_Fast(keys, "o.keys() are not iterable");
2093 Py_DECREF(keys);
2094 return fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002095}
2096
2097PyObject *
2098PyMapping_Items(PyObject *o)
2099{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002100 PyObject *items;
2101 PyObject *fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002102
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002103 if (PyDict_CheckExact(o))
2104 return PyDict_Items(o);
2105 items = PyObject_CallMethod(o, "items", NULL);
2106 if (items == NULL)
2107 return NULL;
2108 fast = PySequence_Fast(items, "o.items() are not iterable");
2109 Py_DECREF(items);
2110 return fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002111}
2112
2113PyObject *
2114PyMapping_Values(PyObject *o)
2115{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002116 PyObject *values;
2117 PyObject *fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002118
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002119 if (PyDict_CheckExact(o))
2120 return PyDict_Values(o);
2121 values = PyObject_CallMethod(o, "values", NULL);
2122 if (values == NULL)
2123 return NULL;
2124 fast = PySequence_Fast(values, "o.values() are not iterable");
2125 Py_DECREF(values);
2126 return fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002127}
2128
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002129/* Operations on callable objects */
2130
2131/* XXX PyCallable_Check() is in object.c */
2132
Guido van Rossume15dee51995-07-18 14:12:02 +00002133PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002134PyObject_CallObject(PyObject *o, PyObject *a)
Guido van Rossume15dee51995-07-18 14:12:02 +00002135{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002136 return PyEval_CallObjectWithKeywords(o, a, NULL);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002137}
Guido van Rossume15dee51995-07-18 14:12:02 +00002138
2139PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00002140PyObject_Call(PyObject *func, PyObject *arg, PyObject *kw)
2141{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002142 ternaryfunc call;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002143
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002144 if ((call = func->ob_type->tp_call) != NULL) {
2145 PyObject *result;
2146 if (Py_EnterRecursiveCall(" while calling a Python object"))
2147 return NULL;
2148 result = (*call)(func, arg, kw);
2149 Py_LeaveRecursiveCall();
2150 if (result == NULL && !PyErr_Occurred())
2151 PyErr_SetString(
2152 PyExc_SystemError,
2153 "NULL result without error in PyObject_Call");
2154 return result;
2155 }
2156 PyErr_Format(PyExc_TypeError, "'%.200s' object is not callable",
2157 func->ob_type->tp_name);
2158 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002159}
2160
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002161static PyObject*
2162call_function_tail(PyObject *callable, PyObject *args)
2163{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002164 PyObject *retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002165
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002166 if (args == NULL)
2167 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002168
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002169 if (!PyTuple_Check(args)) {
2170 PyObject *a;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002171
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002172 a = PyTuple_New(1);
2173 if (a == NULL) {
2174 Py_DECREF(args);
2175 return NULL;
2176 }
2177 PyTuple_SET_ITEM(a, 0, args);
2178 args = a;
2179 }
2180 retval = PyObject_Call(callable, args, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002181
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002182 Py_DECREF(args);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002183
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002184 return retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002185}
2186
Tim Peters6d6c1a32001-08-02 04:15:00 +00002187PyObject *
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002188PyObject_CallFunction(PyObject *callable, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002189{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002190 va_list va;
2191 PyObject *args;
Guido van Rossume15dee51995-07-18 14:12:02 +00002192
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002193 if (callable == NULL)
2194 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002195
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002196 if (format && *format) {
2197 va_start(va, format);
2198 args = Py_VaBuildValue(format, va);
2199 va_end(va);
2200 }
2201 else
2202 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002203
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002204 return call_function_tail(callable, args);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002205}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002206
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002207PyObject *
2208_PyObject_CallFunction_SizeT(PyObject *callable, char *format, ...)
2209{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002210 va_list va;
2211 PyObject *args;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002212
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002213 if (callable == NULL)
2214 return null_error();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002215
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002216 if (format && *format) {
2217 va_start(va, format);
2218 args = _Py_VaBuildValue_SizeT(format, va);
2219 va_end(va);
2220 }
2221 else
2222 args = PyTuple_New(0);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002223
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002224 return call_function_tail(callable, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002225}
2226
2227PyObject *
Guido van Rossume15dee51995-07-18 14:12:02 +00002228PyObject_CallMethod(PyObject *o, char *name, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002229{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002230 va_list va;
2231 PyObject *args;
2232 PyObject *func = NULL;
2233 PyObject *retval = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002234
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002235 if (o == NULL || name == NULL)
2236 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002237
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002238 func = PyObject_GetAttrString(o, name);
2239 if (func == NULL) {
2240 PyErr_SetString(PyExc_AttributeError, name);
2241 return 0;
2242 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002243
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002244 if (!PyCallable_Check(func)) {
2245 type_error("attribute of type '%.200s' is not callable", func);
2246 goto exit;
2247 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002248
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002249 if (format && *format) {
2250 va_start(va, format);
2251 args = Py_VaBuildValue(format, va);
2252 va_end(va);
2253 }
2254 else
2255 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002256
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002257 retval = call_function_tail(func, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002258
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002259 exit:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002260 /* args gets consumed in call_function_tail */
2261 Py_XDECREF(func);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002262
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002263 return retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002264}
2265
2266PyObject *
2267_PyObject_CallMethod_SizeT(PyObject *o, char *name, char *format, ...)
2268{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002269 va_list va;
2270 PyObject *args;
2271 PyObject *func = NULL;
2272 PyObject *retval = NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002273
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002274 if (o == NULL || name == NULL)
2275 return null_error();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002276
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002277 func = PyObject_GetAttrString(o, name);
2278 if (func == NULL) {
2279 PyErr_SetString(PyExc_AttributeError, name);
2280 return 0;
2281 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002282
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002283 if (!PyCallable_Check(func)) {
2284 type_error("attribute of type '%.200s' is not callable", func);
2285 goto exit;
2286 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002287
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002288 if (format && *format) {
2289 va_start(va, format);
2290 args = _Py_VaBuildValue_SizeT(format, va);
2291 va_end(va);
2292 }
2293 else
2294 args = PyTuple_New(0);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002295
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002296 retval = call_function_tail(func, args);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002297
2298 exit:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002299 /* args gets consumed in call_function_tail */
2300 Py_XDECREF(func);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002301
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002302 return retval;
Guido van Rossume15dee51995-07-18 14:12:02 +00002303}
Guido van Rossum823649d2001-03-21 18:40:58 +00002304
2305
Fred Drakeb421b8c2001-10-26 16:21:32 +00002306static PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002307objargs_mktuple(va_list va)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002308{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002309 int i, n = 0;
2310 va_list countva;
2311 PyObject *result, *tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002312
2313#ifdef VA_LIST_IS_ARRAY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002314 memcpy(countva, va, sizeof(va_list));
Fred Drakeb421b8c2001-10-26 16:21:32 +00002315#else
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002316#ifdef __va_copy
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002317 __va_copy(countva, va);
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002318#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002319 countva = va;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002320#endif
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002321#endif
Fred Drakeb421b8c2001-10-26 16:21:32 +00002322
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002323 while (((PyObject *)va_arg(countva, PyObject *)) != NULL)
2324 ++n;
2325 result = PyTuple_New(n);
2326 if (result != NULL && n > 0) {
2327 for (i = 0; i < n; ++i) {
2328 tmp = (PyObject *)va_arg(va, PyObject *);
2329 PyTuple_SET_ITEM(result, i, tmp);
2330 Py_INCREF(tmp);
2331 }
2332 }
2333 return result;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002334}
2335
2336PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002337PyObject_CallMethodObjArgs(PyObject *callable, PyObject *name, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002338{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002339 PyObject *args, *tmp;
2340 va_list vargs;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002341
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002342 if (callable == NULL || name == NULL)
2343 return null_error();
Fred Drakeb421b8c2001-10-26 16:21:32 +00002344
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002345 callable = PyObject_GetAttr(callable, name);
2346 if (callable == NULL)
2347 return NULL;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002348
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002349 /* count the args */
2350 va_start(vargs, name);
2351 args = objargs_mktuple(vargs);
2352 va_end(vargs);
2353 if (args == NULL) {
2354 Py_DECREF(callable);
2355 return NULL;
2356 }
2357 tmp = PyObject_Call(callable, args, NULL);
2358 Py_DECREF(args);
2359 Py_DECREF(callable);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002360
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002361 return tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002362}
2363
2364PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002365PyObject_CallFunctionObjArgs(PyObject *callable, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002366{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002367 PyObject *args, *tmp;
2368 va_list vargs;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002369
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002370 if (callable == NULL)
2371 return null_error();
Fred Drakeb421b8c2001-10-26 16:21:32 +00002372
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002373 /* count the args */
2374 va_start(vargs, callable);
2375 args = objargs_mktuple(vargs);
2376 va_end(vargs);
2377 if (args == NULL)
2378 return NULL;
2379 tmp = PyObject_Call(callable, args, NULL);
2380 Py_DECREF(args);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002381
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002382 return tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002383}
2384
2385
Guido van Rossum823649d2001-03-21 18:40:58 +00002386/* isinstance(), issubclass() */
2387
Barry Warsawf16951c2002-04-23 22:45:44 +00002388/* abstract_get_bases() has logically 4 return states, with a sort of 0th
2389 * state that will almost never happen.
2390 *
2391 * 0. creating the __bases__ static string could get a MemoryError
2392 * 1. getattr(cls, '__bases__') could raise an AttributeError
2393 * 2. getattr(cls, '__bases__') could raise some other exception
2394 * 3. getattr(cls, '__bases__') could return a tuple
2395 * 4. getattr(cls, '__bases__') could return something other than a tuple
2396 *
2397 * Only state #3 is a non-error state and only it returns a non-NULL object
2398 * (it returns the retrieved tuple).
2399 *
2400 * Any raised AttributeErrors are masked by clearing the exception and
2401 * returning NULL. If an object other than a tuple comes out of __bases__,
2402 * then again, the return value is NULL. So yes, these two situations
2403 * produce exactly the same results: NULL is returned and no error is set.
2404 *
2405 * If some exception other than AttributeError is raised, then NULL is also
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002406 * returned, but the exception is not cleared. That's because we want the
Barry Warsawf16951c2002-04-23 22:45:44 +00002407 * exception to be propagated along.
2408 *
2409 * Callers are expected to test for PyErr_Occurred() when the return value
2410 * is NULL to decide whether a valid exception should be propagated or not.
2411 * When there's no exception to propagate, it's customary for the caller to
2412 * set a TypeError.
2413 */
Neil Schemenauer6b471292001-10-18 03:18:43 +00002414static PyObject *
2415abstract_get_bases(PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002416{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002417 static PyObject *__bases__ = NULL;
2418 PyObject *bases;
Guido van Rossum823649d2001-03-21 18:40:58 +00002419
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002420 if (__bases__ == NULL) {
2421 __bases__ = PyUnicode_InternFromString("__bases__");
2422 if (__bases__ == NULL)
2423 return NULL;
2424 }
2425 Py_ALLOW_RECURSION
2426 bases = PyObject_GetAttr(cls, __bases__);
2427 Py_END_ALLOW_RECURSION
2428 if (bases == NULL) {
2429 if (PyErr_ExceptionMatches(PyExc_AttributeError))
2430 PyErr_Clear();
2431 return NULL;
2432 }
2433 if (!PyTuple_Check(bases)) {
2434 Py_DECREF(bases);
2435 return NULL;
2436 }
2437 return bases;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002438}
2439
2440
2441static int
2442abstract_issubclass(PyObject *derived, PyObject *cls)
2443{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002444 PyObject *bases = NULL;
2445 Py_ssize_t i, n;
2446 int r = 0;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002447
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002448 while (1) {
2449 if (derived == cls)
2450 return 1;
2451 bases = abstract_get_bases(derived);
2452 if (bases == NULL) {
2453 if (PyErr_Occurred())
2454 return -1;
2455 return 0;
2456 }
2457 n = PyTuple_GET_SIZE(bases);
2458 if (n == 0) {
2459 Py_DECREF(bases);
2460 return 0;
2461 }
2462 /* Avoid recursivity in the single inheritance case */
2463 if (n == 1) {
2464 derived = PyTuple_GET_ITEM(bases, 0);
2465 Py_DECREF(bases);
2466 continue;
2467 }
2468 for (i = 0; i < n; i++) {
2469 r = abstract_issubclass(PyTuple_GET_ITEM(bases, i), cls);
2470 if (r != 0)
2471 break;
2472 }
2473 Py_DECREF(bases);
2474 return r;
2475 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002476}
2477
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002478static int
2479check_class(PyObject *cls, const char *error)
2480{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002481 PyObject *bases = abstract_get_bases(cls);
2482 if (bases == NULL) {
2483 /* Do not mask errors. */
2484 if (!PyErr_Occurred())
2485 PyErr_SetString(PyExc_TypeError, error);
2486 return 0;
2487 }
2488 Py_DECREF(bases);
2489 return -1;
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002490}
2491
Brett Cannon4f653312004-03-20 22:52:14 +00002492static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002493recursive_isinstance(PyObject *inst, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002494{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002495 PyObject *icls;
2496 static PyObject *__class__ = NULL;
2497 int retval = 0;
Guido van Rossum823649d2001-03-21 18:40:58 +00002498
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002499 if (__class__ == NULL) {
2500 __class__ = PyUnicode_InternFromString("__class__");
2501 if (__class__ == NULL)
2502 return -1;
2503 }
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002504
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002505 if (PyType_Check(cls)) {
2506 retval = PyObject_TypeCheck(inst, (PyTypeObject *)cls);
2507 if (retval == 0) {
2508 PyObject *c = PyObject_GetAttr(inst, __class__);
2509 if (c == NULL) {
2510 PyErr_Clear();
2511 }
2512 else {
2513 if (c != (PyObject *)(inst->ob_type) &&
2514 PyType_Check(c))
2515 retval = PyType_IsSubtype(
2516 (PyTypeObject *)c,
2517 (PyTypeObject *)cls);
2518 Py_DECREF(c);
2519 }
2520 }
2521 }
2522 else {
2523 if (!check_class(cls,
2524 "isinstance() arg 2 must be a class, type,"
2525 " or tuple of classes and types"))
2526 return -1;
2527 icls = PyObject_GetAttr(inst, __class__);
2528 if (icls == NULL) {
2529 PyErr_Clear();
2530 retval = 0;
2531 }
2532 else {
2533 retval = abstract_issubclass(icls, cls);
2534 Py_DECREF(icls);
2535 }
2536 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002537
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002538 return retval;
Guido van Rossum823649d2001-03-21 18:40:58 +00002539}
2540
2541int
Brett Cannon4f653312004-03-20 22:52:14 +00002542PyObject_IsInstance(PyObject *inst, PyObject *cls)
2543{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002544 static PyObject *name = NULL;
2545 PyObject *checker;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002546
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002547 /* Quick test for an exact match */
2548 if (Py_TYPE(inst) == (PyTypeObject *)cls)
2549 return 1;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002550
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002551 if (PyTuple_Check(cls)) {
2552 Py_ssize_t i;
2553 Py_ssize_t n;
2554 int r = 0;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002555
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002556 if (Py_EnterRecursiveCall(" in __instancecheck__"))
2557 return -1;
2558 n = PyTuple_GET_SIZE(cls);
2559 for (i = 0; i < n; ++i) {
2560 PyObject *item = PyTuple_GET_ITEM(cls, i);
2561 r = PyObject_IsInstance(inst, item);
2562 if (r != 0)
2563 /* either found it, or got an error */
2564 break;
2565 }
2566 Py_LeaveRecursiveCall();
2567 return r;
2568 }
Benjamin Peterson88fe5f92009-05-16 21:55:24 +00002569
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002570 checker = _PyObject_LookupSpecial(cls, "__instancecheck__", &name);
2571 if (checker != NULL) {
2572 PyObject *res;
2573 int ok = -1;
2574 if (Py_EnterRecursiveCall(" in __instancecheck__")) {
2575 Py_DECREF(checker);
2576 return ok;
2577 }
2578 res = PyObject_CallFunctionObjArgs(checker, inst, NULL);
2579 Py_LeaveRecursiveCall();
2580 Py_DECREF(checker);
2581 if (res != NULL) {
2582 ok = PyObject_IsTrue(res);
2583 Py_DECREF(res);
2584 }
2585 return ok;
2586 }
2587 else if (PyErr_Occurred())
2588 return -1;
2589 return recursive_isinstance(inst, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002590}
2591
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002592static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002593recursive_issubclass(PyObject *derived, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002594{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002595 if (PyType_Check(cls) && PyType_Check(derived)) {
2596 /* Fast path (non-recursive) */
2597 return PyType_IsSubtype((PyTypeObject *)derived, (PyTypeObject *)cls);
2598 }
2599 if (!check_class(derived,
2600 "issubclass() arg 1 must be a class"))
2601 return -1;
2602 if (!check_class(cls,
2603 "issubclass() arg 2 must be a class"
2604 " or tuple of classes"))
2605 return -1;
Guido van Rossum823649d2001-03-21 18:40:58 +00002606
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002607 return abstract_issubclass(derived, cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002608}
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002609
Brett Cannon4f653312004-03-20 22:52:14 +00002610int
2611PyObject_IsSubclass(PyObject *derived, PyObject *cls)
2612{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002613 static PyObject *name = NULL;
2614 PyObject *checker;
Georg Brandldcfe8e42009-05-17 08:22:45 +00002615
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002616 if (PyTuple_Check(cls)) {
2617 Py_ssize_t i;
2618 Py_ssize_t n;
2619 int r = 0;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002620
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002621 if (Py_EnterRecursiveCall(" in __subclasscheck__"))
2622 return -1;
2623 n = PyTuple_GET_SIZE(cls);
2624 for (i = 0; i < n; ++i) {
2625 PyObject *item = PyTuple_GET_ITEM(cls, i);
2626 r = PyObject_IsSubclass(derived, item);
2627 if (r != 0)
2628 /* either found it, or got an error */
2629 break;
2630 }
2631 Py_LeaveRecursiveCall();
2632 return r;
2633 }
Benjamin Peterson88fe5f92009-05-16 21:55:24 +00002634
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002635 checker = _PyObject_LookupSpecial(cls, "__subclasscheck__", &name);
2636 if (checker != NULL) {
2637 PyObject *res;
2638 int ok = -1;
2639 if (Py_EnterRecursiveCall(" in __subclasscheck__")) {
2640 Py_DECREF(checker);
2641 return ok;
2642 }
2643 res = PyObject_CallFunctionObjArgs(checker, derived, NULL);
2644 Py_LeaveRecursiveCall();
2645 Py_DECREF(checker);
2646 if (res != NULL) {
2647 ok = PyObject_IsTrue(res);
2648 Py_DECREF(res);
2649 }
2650 return ok;
2651 }
2652 else if (PyErr_Occurred())
2653 return -1;
2654 return recursive_issubclass(derived, cls);
Antoine Pitrouec569b72008-08-26 22:40:48 +00002655}
2656
2657int
2658_PyObject_RealIsInstance(PyObject *inst, PyObject *cls)
2659{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002660 return recursive_isinstance(inst, cls);
Antoine Pitrouec569b72008-08-26 22:40:48 +00002661}
2662
2663int
2664_PyObject_RealIsSubclass(PyObject *derived, PyObject *cls)
2665{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002666 return recursive_issubclass(derived, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002667}
2668
2669
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002670PyObject *
2671PyObject_GetIter(PyObject *o)
2672{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002673 PyTypeObject *t = o->ob_type;
2674 getiterfunc f = NULL;
2675 f = t->tp_iter;
2676 if (f == NULL) {
2677 if (PySequence_Check(o))
2678 return PySeqIter_New(o);
2679 return type_error("'%.200s' object is not iterable", o);
2680 }
2681 else {
2682 PyObject *res = (*f)(o);
2683 if (res != NULL && !PyIter_Check(res)) {
2684 PyErr_Format(PyExc_TypeError,
2685 "iter() returned non-iterator "
2686 "of type '%.100s'",
2687 res->ob_type->tp_name);
2688 Py_DECREF(res);
2689 res = NULL;
2690 }
2691 return res;
2692 }
Guido van Rossum213c7a62001-04-23 14:08:49 +00002693}
2694
Tim Petersf4848da2001-05-05 00:14:56 +00002695/* Return next item.
2696 * If an error occurs, return NULL. PyErr_Occurred() will be true.
2697 * If the iteration terminates normally, return NULL and clear the
2698 * PyExc_StopIteration exception (if it was set). PyErr_Occurred()
2699 * will be false.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002700 * Else return the next object. PyErr_Occurred() will be false.
Tim Petersf4848da2001-05-05 00:14:56 +00002701 */
Guido van Rossum213c7a62001-04-23 14:08:49 +00002702PyObject *
2703PyIter_Next(PyObject *iter)
2704{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002705 PyObject *result;
2706 result = (*iter->ob_type->tp_iternext)(iter);
2707 if (result == NULL &&
2708 PyErr_Occurred() &&
2709 PyErr_ExceptionMatches(PyExc_StopIteration))
2710 PyErr_Clear();
2711 return result;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002712}
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002713
2714
2715/*
2716 * Flatten a sequence of bytes() objects into a C array of
2717 * NULL terminated string pointers with a NULL char* terminating the array.
2718 * (ie: an argv or env list)
2719 *
2720 * Memory allocated for the returned list is allocated using malloc() and MUST
2721 * be freed by the caller using a free() loop or _Py_FreeCharPArray().
2722 */
2723char *const *
2724_PySequence_BytesToCharpArray(PyObject* self)
2725{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002726 char **array;
2727 Py_ssize_t i, argc;
2728 PyObject *item = NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002729
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002730 argc = PySequence_Size(self);
2731 if (argc == -1)
2732 return NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002733
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002734 array = malloc((argc + 1) * sizeof(char *));
2735 if (array == NULL) {
2736 PyErr_NoMemory();
2737 return NULL;
2738 }
2739 for (i = 0; i < argc; ++i) {
2740 char *data;
2741 item = PySequence_GetItem(self, i);
2742 data = PyBytes_AsString(item);
2743 if (data == NULL) {
2744 /* NULL terminate before freeing. */
2745 array[i] = NULL;
2746 goto fail;
2747 }
2748 array[i] = strdup(data);
2749 if (!array[i]) {
2750 PyErr_NoMemory();
2751 goto fail;
2752 }
2753 Py_DECREF(item);
2754 }
2755 array[argc] = NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002756
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002757 return array;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002758
2759fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002760 Py_XDECREF(item);
2761 _Py_FreeCharPArray(array);
2762 return NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002763}
2764
2765
2766/* Free's a NULL terminated char** array of C strings. */
2767void
2768_Py_FreeCharPArray(char *const array[])
2769{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002770 Py_ssize_t i;
2771 for (i = 0; array[i] != NULL; ++i) {
2772 free(array[i]);
2773 }
2774 free((void*)array);
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002775}