blob: 01fbcbfb188b66648706231ec9c1c9c2082b9030 [file] [log] [blame]
Guido van Rossume15dee51995-07-18 14:12:02 +00001/* Abstract Object Interface (many thanks to Jim Fulton) */
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002
Guido van Rossume15dee51995-07-18 14:12:02 +00003#include "Python.h"
Guido van Rossumfa0b6ab1998-05-22 15:23:36 +00004#include <ctype.h>
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00005#include "structmember.h" /* we need the offsetof() macro from there */
Tim Peters64b5ce32001-09-10 20:52:51 +00006#include "longintrepr.h"
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00007
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00008
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00009
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000010/* Shorthands to return certain errors */
Guido van Rossume15dee51995-07-18 14:12:02 +000011
12static PyObject *
Thomas Wouters0e3f5912006-08-11 14:57:12 +000013type_error(const char *msg, PyObject *obj)
Guido van Rossume15dee51995-07-18 14:12:02 +000014{
Thomas Wouters0e3f5912006-08-11 14:57:12 +000015 PyErr_Format(PyExc_TypeError, msg, obj->ob_type->tp_name);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000016 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +000017}
18
Guido van Rossum052b7e11996-11-11 15:08:19 +000019static PyObject *
Fred Drake79912472000-07-09 04:06:11 +000020null_error(void)
Guido van Rossume15dee51995-07-18 14:12:02 +000021{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000022 if (!PyErr_Occurred())
23 PyErr_SetString(PyExc_SystemError,
24 "null argument to internal routine");
25 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +000026}
27
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000028/* Operations on any object */
29
30int
Fred Drake79912472000-07-09 04:06:11 +000031PyObject_Cmp(PyObject *o1, PyObject *o2, int *result)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000032{
33 int r;
34
35 if (o1 == NULL || o2 == NULL) {
36 null_error();
37 return -1;
38 }
39 r = PyObject_Compare(o1, o2);
40 if (PyErr_Occurred())
41 return -1;
42 *result = r;
Guido van Rossume15dee51995-07-18 14:12:02 +000043 return 0;
44}
Guido van Rossume15dee51995-07-18 14:12:02 +000045
46PyObject *
Fred Drake79912472000-07-09 04:06:11 +000047PyObject_Type(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +000048{
49 PyObject *v;
50
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000051 if (o == NULL)
52 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +000053 v = (PyObject *)o->ob_type;
54 Py_INCREF(v);
55 return v;
56}
57
Martin v. Löwis18e16552006-02-15 17:27:45 +000058Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +000059PyObject_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +000060{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000061 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +000062
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000063 if (o == NULL) {
64 null_error();
65 return -1;
66 }
Guido van Rossume15dee51995-07-18 14:12:02 +000067
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000068 m = o->ob_type->tp_as_sequence;
69 if (m && m->sq_length)
70 return m->sq_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +000071
Jeremy Hylton6253f832000-07-12 12:56:19 +000072 return PyMapping_Size(o);
Guido van Rossume15dee51995-07-18 14:12:02 +000073}
74
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000075#undef PyObject_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +000076Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000077PyObject_Length(PyObject *o)
78{
79 return PyObject_Size(o);
80}
81#define PyObject_Length PyObject_Size
82
Martin v. Löwis18e16552006-02-15 17:27:45 +000083Py_ssize_t
Armin Rigof5b3e362006-02-11 21:32:43 +000084_PyObject_LengthHint(PyObject *o)
Raymond Hettinger6b27cda2005-09-24 21:23:05 +000085{
Martin v. Löwis18e16552006-02-15 17:27:45 +000086 Py_ssize_t rv = PyObject_Size(o);
Raymond Hettinger6b27cda2005-09-24 21:23:05 +000087 if (rv != -1)
88 return rv;
89 if (PyErr_ExceptionMatches(PyExc_TypeError) ||
90 PyErr_ExceptionMatches(PyExc_AttributeError)) {
91 PyObject *err_type, *err_value, *err_tb, *ro;
92
93 PyErr_Fetch(&err_type, &err_value, &err_tb);
Armin Rigof5b3e362006-02-11 21:32:43 +000094 ro = PyObject_CallMethod(o, "__length_hint__", NULL);
Raymond Hettinger6b27cda2005-09-24 21:23:05 +000095 if (ro != NULL) {
Martin v. Löwis18e16552006-02-15 17:27:45 +000096 rv = PyInt_AsLong(ro);
Raymond Hettinger6b27cda2005-09-24 21:23:05 +000097 Py_DECREF(ro);
98 Py_XDECREF(err_type);
99 Py_XDECREF(err_value);
100 Py_XDECREF(err_tb);
101 return rv;
102 }
103 PyErr_Restore(err_type, err_value, err_tb);
104 }
105 return -1;
106}
107
Guido van Rossume15dee51995-07-18 14:12:02 +0000108PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000109PyObject_GetItem(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +0000110{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000111 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +0000112
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000113 if (o == NULL || key == NULL)
114 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +0000115
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000116 m = o->ob_type->tp_as_mapping;
117 if (m && m->mp_subscript)
118 return m->mp_subscript(o, key);
Guido van Rossume15dee51995-07-18 14:12:02 +0000119
Guido van Rossum21308241998-08-13 16:44:44 +0000120 if (o->ob_type->tp_as_sequence) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000121 if (PyIndex_Check(key)) {
122 Py_ssize_t key_value;
123 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
Andrew M. Kuchling0f223d22000-02-23 22:21:50 +0000124 if (key_value == -1 && PyErr_Occurred())
125 return NULL;
126 return PySequence_GetItem(o, key_value);
127 }
Guido van Rossum64585f62001-11-24 18:24:47 +0000128 else if (o->ob_type->tp_as_sequence->sq_item)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000129 return type_error("sequence index must "
130 "be integer, not '%.200s'", key);
Guido van Rossum21308241998-08-13 16:44:44 +0000131 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000132
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000133 return type_error("'%.200s' object is unsubscriptable", o);
Guido van Rossume15dee51995-07-18 14:12:02 +0000134}
135
136int
Fred Drake79912472000-07-09 04:06:11 +0000137PyObject_SetItem(PyObject *o, PyObject *key, PyObject *value)
Guido van Rossume15dee51995-07-18 14:12:02 +0000138{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000139 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +0000140
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000141 if (o == NULL || key == NULL || value == NULL) {
142 null_error();
143 return -1;
144 }
145 m = o->ob_type->tp_as_mapping;
146 if (m && m->mp_ass_subscript)
147 return m->mp_ass_subscript(o, key, value);
Guido van Rossume15dee51995-07-18 14:12:02 +0000148
Guido van Rossum21308241998-08-13 16:44:44 +0000149 if (o->ob_type->tp_as_sequence) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000150 if (PyIndex_Check(key)) {
151 Py_ssize_t key_value;
152 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
Andrew M. Kuchling0f223d22000-02-23 22:21:50 +0000153 if (key_value == -1 && PyErr_Occurred())
154 return -1;
155 return PySequence_SetItem(o, key_value, value);
156 }
Guido van Rossum64585f62001-11-24 18:24:47 +0000157 else if (o->ob_type->tp_as_sequence->sq_ass_item) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000158 type_error("sequence index must be "
159 "integer, not '%.200s'", key);
Guido van Rossum64585f62001-11-24 18:24:47 +0000160 return -1;
161 }
Guido van Rossum21308241998-08-13 16:44:44 +0000162 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000163
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000164 type_error("'%.200s' object does not support item assignment", o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000165 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +0000166}
167
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000168int
Fred Drake79912472000-07-09 04:06:11 +0000169PyObject_DelItem(PyObject *o, PyObject *key)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000170{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000171 PyMappingMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000172
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000173 if (o == NULL || key == NULL) {
174 null_error();
175 return -1;
176 }
177 m = o->ob_type->tp_as_mapping;
178 if (m && m->mp_ass_subscript)
179 return m->mp_ass_subscript(o, key, (PyObject*)NULL);
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000180
Guido van Rossum21308241998-08-13 16:44:44 +0000181 if (o->ob_type->tp_as_sequence) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000182 if (PyIndex_Check(key)) {
183 Py_ssize_t key_value;
184 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
Andrew M. Kuchling0f223d22000-02-23 22:21:50 +0000185 if (key_value == -1 && PyErr_Occurred())
186 return -1;
187 return PySequence_DelItem(o, key_value);
188 }
Guido van Rossum64585f62001-11-24 18:24:47 +0000189 else if (o->ob_type->tp_as_sequence->sq_ass_item) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000190 type_error("sequence index must be "
191 "integer, not '%.200s'", key);
Guido van Rossum64585f62001-11-24 18:24:47 +0000192 return -1;
193 }
Guido van Rossum21308241998-08-13 16:44:44 +0000194 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000195
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000196 type_error("'%.200s' object does not support item deletion", o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000197 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000198}
199
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000200int
201PyObject_DelItemString(PyObject *o, char *key)
202{
203 PyObject *okey;
204 int ret;
205
206 if (o == NULL || key == NULL) {
207 null_error();
208 return -1;
209 }
Martin v. Löwis5b222132007-06-10 09:51:05 +0000210 okey = PyUnicode_FromString(key);
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000211 if (okey == NULL)
212 return -1;
213 ret = PyObject_DelItem(o, okey);
214 Py_DECREF(okey);
215 return ret;
216}
217
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000218/* We release the buffer right after use of this function which could
Guido van Rossum98297ee2007-11-06 21:34:58 +0000219 cause issues later on. Don't use these functions in new code.
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000220 */
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000221int
222PyObject_AsCharBuffer(PyObject *obj,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000223 const char **buffer,
224 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000225{
226 PyBufferProcs *pb;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000227 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000228
229 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
230 null_error();
231 return -1;
232 }
233 pb = obj->ob_type->tp_as_buffer;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000234 if (pb == NULL || pb->bf_getbuffer == NULL) {
Guido van Rossum4c08d552000-03-10 22:55:18 +0000235 PyErr_SetString(PyExc_TypeError,
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000236 "expected an object with the buffer interface");
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000237 return -1;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000238 }
Travis E. Oliphantddacf962007-10-13 21:03:27 +0000239 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE)) return -1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000240
241 *buffer = view.buf;
242 *buffer_len = view.len;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000243 if (pb->bf_releasebuffer != NULL)
244 (*pb->bf_releasebuffer)(obj, &view);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000245 return 0;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000246}
Guido van Rossum4c08d552000-03-10 22:55:18 +0000247
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000248int
249PyObject_CheckReadBuffer(PyObject *obj)
250{
Guido van Rossum98297ee2007-11-06 21:34:58 +0000251 PyBufferProcs *pb = obj->ob_type->tp_as_buffer;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000252
253 if (pb == NULL ||
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000254 pb->bf_getbuffer == NULL)
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000255 return 0;
256 if ((*pb->bf_getbuffer)(obj, NULL, PyBUF_SIMPLE) == -1) {
257 PyErr_Clear();
258 return 0;
259 }
260 if (*pb->bf_releasebuffer != NULL)
261 (*pb->bf_releasebuffer)(obj, NULL);
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000262 return 1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000263}
264
265int PyObject_AsReadBuffer(PyObject *obj,
266 const void **buffer,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000267 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000268{
269 PyBufferProcs *pb;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000270 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000271
272 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
273 null_error();
274 return -1;
275 }
276 pb = obj->ob_type->tp_as_buffer;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000277 if (pb == NULL ||
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000278 pb->bf_getbuffer == NULL) {
Guido van Rossum4c08d552000-03-10 22:55:18 +0000279 PyErr_SetString(PyExc_TypeError,
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000280 "expected an object with a buffer interface");
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000281 return -1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000282 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000283
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000284 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE)) return -1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000285
286 *buffer = view.buf;
287 *buffer_len = view.len;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000288 if (pb->bf_releasebuffer != NULL)
289 (*pb->bf_releasebuffer)(obj, &view);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000290 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000291}
292
293int PyObject_AsWriteBuffer(PyObject *obj,
294 void **buffer,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000295 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000296{
297 PyBufferProcs *pb;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000298 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000299
300 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
301 null_error();
302 return -1;
303 }
304 pb = obj->ob_type->tp_as_buffer;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000305 if (pb == NULL ||
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000306 pb->bf_getbuffer == NULL ||
307 ((*pb->bf_getbuffer)(obj, &view, PyBUF_WRITABLE) != 0)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000308 PyErr_SetString(PyExc_TypeError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000309 "expected an object with a writable buffer interface");
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000310 return -1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000311 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000312
313 *buffer = view.buf;
314 *buffer_len = view.len;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000315 if (pb->bf_releasebuffer != NULL)
316 (*pb->bf_releasebuffer)(obj, &view);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000317 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000318}
319
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000320/* Buffer C-API for Python 3.0 */
321
322int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000323PyObject_GetBuffer(PyObject *obj, Py_buffer *view, int flags)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000324{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000325 if (!PyObject_CheckBuffer(obj)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000326 PyErr_Format(PyExc_TypeError,
327 "'%100s' does not have the buffer interface",
328 Py_Type(obj)->tp_name);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000329 return -1;
330 }
331 return (*(obj->ob_type->tp_as_buffer->bf_getbuffer))(obj, view, flags);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000332}
333
334void
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000335PyObject_ReleaseBuffer(PyObject *obj, Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000336{
Guido van Rossum98297ee2007-11-06 21:34:58 +0000337 if (obj->ob_type->tp_as_buffer != NULL &&
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000338 obj->ob_type->tp_as_buffer->bf_releasebuffer != NULL) {
339 (*(obj->ob_type->tp_as_buffer->bf_releasebuffer))(obj, view);
340 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000341}
342
343
344static int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000345_IsFortranContiguous(Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000346{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000347 Py_ssize_t sd, dim;
348 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000349
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000350 if (view->ndim == 0) return 1;
351 if (view->strides == NULL) return (view->ndim == 1);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000352
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000353 sd = view->itemsize;
354 if (view->ndim == 1) return (view->shape[0] == 1 ||
355 sd == view->strides[0]);
356 for (i=0; i<view->ndim; i++) {
357 dim = view->shape[i];
358 if (dim == 0) return 1;
359 if (view->strides[i] != sd) return 0;
360 sd *= dim;
361 }
362 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000363}
364
365static int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000366_IsCContiguous(Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000367{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000368 Py_ssize_t sd, dim;
369 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000370
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000371 if (view->ndim == 0) return 1;
372 if (view->strides == NULL) return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000373
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000374 sd = view->itemsize;
375 if (view->ndim == 1) return (view->shape[0] == 1 ||
376 sd == view->strides[0]);
377 for (i=view->ndim-1; i>=0; i--) {
378 dim = view->shape[i];
379 if (dim == 0) return 1;
380 if (view->strides[i] != sd) return 0;
381 sd *= dim;
382 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000383 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000384}
385
386int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000387PyBuffer_IsContiguous(Py_buffer *view, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000388{
389
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000390 if (view->suboffsets != NULL) return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000391
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000392 if (fort == 'C')
393 return _IsCContiguous(view);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000394 else if (fort == 'F')
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000395 return _IsFortranContiguous(view);
396 else if (fort == 'A')
397 return (_IsCContiguous(view) || _IsFortranContiguous(view));
398 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000399}
400
401
Guido van Rossum98297ee2007-11-06 21:34:58 +0000402void*
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000403PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000404{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000405 char* pointer;
406 int i;
407 pointer = (char *)view->buf;
408 for (i = 0; i < view->ndim; i++) {
409 pointer += view->strides[i]*indices[i];
410 if ((view->suboffsets != NULL) && (view->suboffsets[i] >= 0)) {
411 pointer = *((char**)pointer) + view->suboffsets[i];
412 }
413 }
414 return (void*)pointer;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000415}
416
417
Guido van Rossum98297ee2007-11-06 21:34:58 +0000418void
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000419_add_one_to_index_F(int nd, Py_ssize_t *index, Py_ssize_t *shape)
420{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000421 int k;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000422
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000423 for (k=0; k<nd; k++) {
424 if (index[k] < shape[k]-1) {
425 index[k]++;
426 break;
427 }
428 else {
429 index[k] = 0;
430 }
431 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000432}
433
Guido van Rossum98297ee2007-11-06 21:34:58 +0000434void
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000435_add_one_to_index_C(int nd, Py_ssize_t *index, Py_ssize_t *shape)
436{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000437 int k;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000438
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000439 for (k=nd-1; k>=0; k--) {
440 if (index[k] < shape[k]-1) {
441 index[k]++;
442 break;
443 }
444 else {
445 index[k] = 0;
446 }
447 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000448}
449
450 /* view is not checked for consistency in either of these. It is
Guido van Rossum98297ee2007-11-06 21:34:58 +0000451 assumed that the size of the buffer is view->len in
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000452 view->len / view->itemsize elements.
453 */
454
Guido van Rossum98297ee2007-11-06 21:34:58 +0000455int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000456PyBuffer_ToContiguous(void *buf, Py_buffer *view, Py_ssize_t len, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000457{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000458 int k;
459 void (*addone)(int, Py_ssize_t *, Py_ssize_t *);
460 Py_ssize_t *indices, elements;
461 char *dest, *ptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000462
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000463 if (len > view->len) {
464 len = view->len;
465 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000466
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000467 if (PyBuffer_IsContiguous(view, fort)) {
468 /* simplest copy is all that is needed */
469 memcpy(buf, view->buf, len);
470 return 0;
471 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000472
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000473 /* Otherwise a more elaborate scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000474
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000475 /* XXX(nnorwitz): need to check for overflow! */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000476 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
477 if (indices == NULL) {
478 PyErr_NoMemory();
479 return -1;
480 }
481 for (k=0; k<view->ndim;k++) {
482 indices[k] = 0;
483 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000484
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000485 if (fort == 'F') {
486 addone = _add_one_to_index_F;
487 }
488 else {
489 addone = _add_one_to_index_C;
490 }
491 dest = buf;
492 /* XXX : This is not going to be the fastest code in the world
Guido van Rossum98297ee2007-11-06 21:34:58 +0000493 several optimizations are possible.
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000494 */
495 elements = len / view->itemsize;
496 while (elements--) {
497 addone(view->ndim, indices, view->shape);
498 ptr = PyBuffer_GetPointer(view, indices);
499 memcpy(dest, ptr, view->itemsize);
500 dest += view->itemsize;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000501 }
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000502 PyMem_Free(indices);
503 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000504}
505
506int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000507PyBuffer_FromContiguous(Py_buffer *view, void *buf, Py_ssize_t len, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000508{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000509 int k;
510 void (*addone)(int, Py_ssize_t *, Py_ssize_t *);
511 Py_ssize_t *indices, elements;
512 char *src, *ptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000513
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000514 if (len > view->len) {
515 len = view->len;
516 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000517
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000518 if (PyBuffer_IsContiguous(view, fort)) {
519 /* simplest copy is all that is needed */
520 memcpy(view->buf, buf, len);
521 return 0;
522 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000523
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000524 /* Otherwise a more elaborate scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000525
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000526 /* XXX(nnorwitz): need to check for overflow! */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000527 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
528 if (indices == NULL) {
529 PyErr_NoMemory();
530 return -1;
531 }
532 for (k=0; k<view->ndim;k++) {
533 indices[k] = 0;
534 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000535
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000536 if (fort == 'F') {
537 addone = _add_one_to_index_F;
538 }
539 else {
540 addone = _add_one_to_index_C;
541 }
542 src = buf;
543 /* XXX : This is not going to be the fastest code in the world
Guido van Rossum98297ee2007-11-06 21:34:58 +0000544 several optimizations are possible.
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000545 */
546 elements = len / view->itemsize;
547 while (elements--) {
548 addone(view->ndim, indices, view->shape);
549 ptr = PyBuffer_GetPointer(view, indices);
550 memcpy(ptr, src, view->itemsize);
551 src += view->itemsize;
552 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000553
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000554 PyMem_Free(indices);
555 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000556}
557
Guido van Rossum98297ee2007-11-06 21:34:58 +0000558int PyObject_CopyData(PyObject *dest, PyObject *src)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000559{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000560 Py_buffer view_dest, view_src;
561 int k;
562 Py_ssize_t *indices, elements;
563 char *dptr, *sptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000564
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000565 if (!PyObject_CheckBuffer(dest) ||
566 !PyObject_CheckBuffer(src)) {
567 PyErr_SetString(PyExc_TypeError,
568 "both destination and source must have the "\
569 "buffer interface");
570 return -1;
571 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000572
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000573 if (PyObject_GetBuffer(dest, &view_dest, PyBUF_FULL) != 0) return -1;
574 if (PyObject_GetBuffer(src, &view_src, PyBUF_FULL_RO) != 0) {
575 PyObject_ReleaseBuffer(dest, &view_dest);
576 return -1;
577 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000578
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000579 if (view_dest.len < view_src.len) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000580 PyErr_SetString(PyExc_BufferError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000581 "destination is too small to receive data from source");
582 PyObject_ReleaseBuffer(dest, &view_dest);
583 PyObject_ReleaseBuffer(src, &view_src);
584 return -1;
585 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000586
Guido van Rossum98297ee2007-11-06 21:34:58 +0000587 if ((PyBuffer_IsContiguous(&view_dest, 'C') &&
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000588 PyBuffer_IsContiguous(&view_src, 'C')) ||
Guido van Rossum98297ee2007-11-06 21:34:58 +0000589 (PyBuffer_IsContiguous(&view_dest, 'F') &&
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000590 PyBuffer_IsContiguous(&view_src, 'F'))) {
591 /* simplest copy is all that is needed */
592 memcpy(view_dest.buf, view_src.buf, view_src.len);
593 PyObject_ReleaseBuffer(dest, &view_dest);
594 PyObject_ReleaseBuffer(src, &view_src);
595 return 0;
596 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000597
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000598 /* Otherwise a more elaborate copy scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000599
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000600 /* XXX(nnorwitz): need to check for overflow! */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000601 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*view_src.ndim);
602 if (indices == NULL) {
603 PyErr_NoMemory();
604 PyObject_ReleaseBuffer(dest, &view_dest);
605 PyObject_ReleaseBuffer(src, &view_src);
606 return -1;
607 }
608 for (k=0; k<view_src.ndim;k++) {
609 indices[k] = 0;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000610 }
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000611 elements = 1;
612 for (k=0; k<view_src.ndim; k++) {
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000613 /* XXX(nnorwitz): can this overflow? */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000614 elements *= view_src.shape[k];
615 }
616 while (elements--) {
617 _add_one_to_index_C(view_src.ndim, indices, view_src.shape);
618 dptr = PyBuffer_GetPointer(&view_dest, indices);
619 sptr = PyBuffer_GetPointer(&view_src, indices);
620 memcpy(dptr, sptr, view_src.itemsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000621 }
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000622 PyMem_Free(indices);
623 PyObject_ReleaseBuffer(dest, &view_dest);
624 PyObject_ReleaseBuffer(src, &view_src);
625 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000626}
627
628void
629PyBuffer_FillContiguousStrides(int nd, Py_ssize_t *shape,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000630 Py_ssize_t *strides, int itemsize,
631 char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000632{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000633 int k;
634 Py_ssize_t sd;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000635
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000636 sd = itemsize;
637 if (fort == 'F') {
638 for (k=0; k<nd; k++) {
639 strides[k] = sd;
640 sd *= shape[k];
Guido van Rossum98297ee2007-11-06 21:34:58 +0000641 }
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000642 }
643 else {
644 for (k=nd-1; k>=0; k--) {
645 strides[k] = sd;
646 sd *= shape[k];
647 }
648 }
649 return;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000650}
651
652int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000653PyBuffer_FillInfo(Py_buffer *view, void *buf, Py_ssize_t len,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000654 int readonly, int flags)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000655{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000656 if (view == NULL) return 0;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000657 if (((flags & PyBUF_LOCK) == PyBUF_LOCK) &&
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000658 readonly >= 0) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000659 PyErr_SetString(PyExc_BufferError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000660 "Cannot lock this object.");
661 return -1;
662 }
663 if (((flags & PyBUF_WRITABLE) == PyBUF_WRITABLE) &&
664 (readonly == 1)) {
665 PyErr_SetString(PyExc_BufferError,
666 "Object is not writable.");
667 return -1;
668 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000669
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000670 view->buf = buf;
671 view->len = len;
672 view->readonly = readonly;
673 view->itemsize = 1;
674 view->format = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000675 if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT)
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000676 view->format = "B";
677 view->ndim = 1;
678 view->shape = NULL;
679 if ((flags & PyBUF_ND) == PyBUF_ND)
680 view->shape = &(view->len);
681 view->strides = NULL;
682 if ((flags & PyBUF_STRIDES) == PyBUF_STRIDES)
683 view->strides = &(view->itemsize);
684 view->suboffsets = NULL;
685 view->internal = NULL;
686 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000687}
688
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000689/* Operations on numbers */
690
691int
Fred Drake79912472000-07-09 04:06:11 +0000692PyNumber_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +0000693{
Guido van Rossum6921eca2003-02-18 16:36:28 +0000694 return o && o->ob_type->tp_as_number &&
695 (o->ob_type->tp_as_number->nb_int ||
696 o->ob_type->tp_as_number->nb_float);
Guido van Rossume15dee51995-07-18 14:12:02 +0000697}
698
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000699/* Binary operators */
Guido van Rossume15dee51995-07-18 14:12:02 +0000700
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000701#define NB_SLOT(x) offsetof(PyNumberMethods, x)
702#define NB_BINOP(nb_methods, slot) \
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000703 (*(binaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000704#define NB_TERNOP(nb_methods, slot) \
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000705 (*(ternaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000706
707/*
708 Calling scheme used for binary operations:
709
Neal Norwitz4886cc32006-08-21 17:06:07 +0000710 Order operations are tried until either a valid result or error:
711 w.op(v,w)[*], v.op(v,w), w.op(v,w)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000712
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000713 [*] only when v->ob_type != w->ob_type && w->ob_type is a subclass of
714 v->ob_type
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000715 */
716
717static PyObject *
718binary_op1(PyObject *v, PyObject *w, const int op_slot)
Guido van Rossume15dee51995-07-18 14:12:02 +0000719{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000720 PyObject *x;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000721 binaryfunc slotv = NULL;
722 binaryfunc slotw = NULL;
723
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000724 if (v->ob_type->tp_as_number != NULL)
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000725 slotv = NB_BINOP(v->ob_type->tp_as_number, op_slot);
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000726 if (w->ob_type != v->ob_type &&
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000727 w->ob_type->tp_as_number != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000728 slotw = NB_BINOP(w->ob_type->tp_as_number, op_slot);
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000729 if (slotw == slotv)
730 slotw = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000731 }
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000732 if (slotv) {
Guido van Rossum89c42642001-10-01 17:10:18 +0000733 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
734 x = slotw(v, w);
735 if (x != Py_NotImplemented)
736 return x;
737 Py_DECREF(x); /* can't do it */
738 slotw = NULL;
739 }
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000740 x = slotv(v, w);
741 if (x != Py_NotImplemented)
742 return x;
743 Py_DECREF(x); /* can't do it */
744 }
745 if (slotw) {
746 x = slotw(v, w);
747 if (x != Py_NotImplemented)
748 return x;
749 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000750 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000751 Py_INCREF(Py_NotImplemented);
752 return Py_NotImplemented;
753}
Guido van Rossum77660912002-04-16 16:32:50 +0000754
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000755static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000756binop_type_error(PyObject *v, PyObject *w, const char *op_name)
757{
758 PyErr_Format(PyExc_TypeError,
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000759 "unsupported operand type(s) for %.100s: "
760 "'%.100s' and '%.100s'",
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000761 op_name,
762 v->ob_type->tp_name,
763 w->ob_type->tp_name);
764 return NULL;
765}
766
767static PyObject *
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000768binary_op(PyObject *v, PyObject *w, const int op_slot, const char *op_name)
769{
770 PyObject *result = binary_op1(v, w, op_slot);
771 if (result == Py_NotImplemented) {
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000772 Py_DECREF(result);
773 return binop_type_error(v, w, op_name);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000774 }
775 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000776}
777
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000778
779/*
780 Calling scheme used for ternary operations:
781
Neal Norwitz4886cc32006-08-21 17:06:07 +0000782 Order operations are tried until either a valid result or error:
783 v.op(v,w,z), w.op(v,w,z), z.op(v,w,z)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000784 */
785
786static PyObject *
787ternary_op(PyObject *v,
788 PyObject *w,
789 PyObject *z,
790 const int op_slot,
791 const char *op_name)
Guido van Rossume15dee51995-07-18 14:12:02 +0000792{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000793 PyNumberMethods *mv, *mw, *mz;
Guido van Rossum84675ac2001-09-29 01:05:03 +0000794 PyObject *x = NULL;
795 ternaryfunc slotv = NULL;
796 ternaryfunc slotw = NULL;
797 ternaryfunc slotz = NULL;
Guido van Rossum77660912002-04-16 16:32:50 +0000798
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000799 mv = v->ob_type->tp_as_number;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000800 mw = w->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000801 if (mv != NULL)
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000802 slotv = NB_TERNOP(mv, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000803 if (w->ob_type != v->ob_type &&
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000804 mw != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000805 slotw = NB_TERNOP(mw, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000806 if (slotw == slotv)
807 slotw = NULL;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000808 }
Guido van Rossum84675ac2001-09-29 01:05:03 +0000809 if (slotv) {
Guido van Rossum89c42642001-10-01 17:10:18 +0000810 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
811 x = slotw(v, w, z);
812 if (x != Py_NotImplemented)
813 return x;
814 Py_DECREF(x); /* can't do it */
815 slotw = NULL;
816 }
Guido van Rossum84675ac2001-09-29 01:05:03 +0000817 x = slotv(v, w, z);
818 if (x != Py_NotImplemented)
819 return x;
820 Py_DECREF(x); /* can't do it */
821 }
822 if (slotw) {
823 x = slotw(v, w, z);
824 if (x != Py_NotImplemented)
825 return x;
826 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000827 }
828 mz = z->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000829 if (mz != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000830 slotz = NB_TERNOP(mz, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000831 if (slotz == slotv || slotz == slotw)
832 slotz = NULL;
833 if (slotz) {
834 x = slotz(v, w, z);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000835 if (x != Py_NotImplemented)
836 return x;
Guido van Rossum84675ac2001-09-29 01:05:03 +0000837 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000838 }
839 }
840
Guido van Rossum5c66a262001-10-22 04:12:44 +0000841 if (z == Py_None)
842 PyErr_Format(
843 PyExc_TypeError,
844 "unsupported operand type(s) for ** or pow(): "
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000845 "'%.100s' and '%.100s'",
Guido van Rossum5c66a262001-10-22 04:12:44 +0000846 v->ob_type->tp_name,
847 w->ob_type->tp_name);
848 else
849 PyErr_Format(
850 PyExc_TypeError,
851 "unsupported operand type(s) for pow(): "
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000852 "'%.100s', '%.100s', '%.100s'",
Guido van Rossum5c66a262001-10-22 04:12:44 +0000853 v->ob_type->tp_name,
854 w->ob_type->tp_name,
855 z->ob_type->tp_name);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000856 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000857}
858
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000859#define BINARY_FUNC(func, op, op_name) \
860 PyObject * \
861 func(PyObject *v, PyObject *w) { \
862 return binary_op(v, w, NB_SLOT(op), op_name); \
863 }
Guido van Rossume15dee51995-07-18 14:12:02 +0000864
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000865BINARY_FUNC(PyNumber_Or, nb_or, "|")
866BINARY_FUNC(PyNumber_Xor, nb_xor, "^")
867BINARY_FUNC(PyNumber_And, nb_and, "&")
868BINARY_FUNC(PyNumber_Lshift, nb_lshift, "<<")
869BINARY_FUNC(PyNumber_Rshift, nb_rshift, ">>")
870BINARY_FUNC(PyNumber_Subtract, nb_subtract, "-")
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000871BINARY_FUNC(PyNumber_Divmod, nb_divmod, "divmod()")
Guido van Rossume15dee51995-07-18 14:12:02 +0000872
873PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000874PyNumber_Add(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000875{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000876 PyObject *result = binary_op1(v, w, NB_SLOT(nb_add));
877 if (result == Py_NotImplemented) {
878 PySequenceMethods *m = v->ob_type->tp_as_sequence;
Armin Rigofd163f92005-12-29 15:59:19 +0000879 Py_DECREF(result);
Jeremy Hylton0522d982002-03-08 21:28:54 +0000880 if (m && m->sq_concat) {
Armin Rigofd163f92005-12-29 15:59:19 +0000881 return (*m->sq_concat)(v, w);
Jeremy Hylton0522d982002-03-08 21:28:54 +0000882 }
Armin Rigofd163f92005-12-29 15:59:19 +0000883 result = binop_type_error(v, w, "+");
Guido van Rossume15dee51995-07-18 14:12:02 +0000884 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000885 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000886}
887
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000888static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000889sequence_repeat(ssizeargfunc repeatfunc, PyObject *seq, PyObject *n)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000890{
Guido van Rossum38fff8c2006-03-07 18:50:55 +0000891 Py_ssize_t count;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000892 if (PyIndex_Check(n)) {
893 count = PyNumber_AsSsize_t(n, PyExc_OverflowError);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000894 if (count == -1 && PyErr_Occurred())
895 return NULL;
896 }
897 else {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000898 return type_error("can't multiply sequence by "
899 "non-int of type '%.200s'", n);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000900 }
Guido van Rossum38fff8c2006-03-07 18:50:55 +0000901 return (*repeatfunc)(seq, count);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000902}
903
904PyObject *
905PyNumber_Multiply(PyObject *v, PyObject *w)
906{
907 PyObject *result = binary_op1(v, w, NB_SLOT(nb_multiply));
908 if (result == Py_NotImplemented) {
909 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
910 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
Guido van Rossuma3a243e2002-12-31 19:50:03 +0000911 Py_DECREF(result);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000912 if (mv && mv->sq_repeat) {
913 return sequence_repeat(mv->sq_repeat, v, w);
914 }
915 else if (mw && mw->sq_repeat) {
916 return sequence_repeat(mw->sq_repeat, w, v);
917 }
918 result = binop_type_error(v, w, "*");
919 }
920 return result;
921}
922
Guido van Rossume15dee51995-07-18 14:12:02 +0000923PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +0000924PyNumber_FloorDivide(PyObject *v, PyObject *w)
925{
Guido van Rossum4668b002001-08-08 05:00:18 +0000926 return binary_op(v, w, NB_SLOT(nb_floor_divide), "//");
927}
928
929PyObject *
930PyNumber_TrueDivide(PyObject *v, PyObject *w)
931{
Guido van Rossum4668b002001-08-08 05:00:18 +0000932 return binary_op(v, w, NB_SLOT(nb_true_divide), "/");
933}
934
935PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000936PyNumber_Remainder(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000937{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000938 return binary_op(v, w, NB_SLOT(nb_remainder), "%");
Guido van Rossume15dee51995-07-18 14:12:02 +0000939}
940
941PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000942PyNumber_Power(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossume15dee51995-07-18 14:12:02 +0000943{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000944 return ternary_op(v, w, z, NB_SLOT(nb_power), "** or pow()");
Guido van Rossume15dee51995-07-18 14:12:02 +0000945}
946
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000947/* Binary in-place operators */
948
949/* The in-place operators are defined to fall back to the 'normal',
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000950 non in-place operations, if the in-place methods are not in place.
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000951
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000952 - If the left hand object has the appropriate struct members, and
953 they are filled, call the appropriate function and return the
954 result. No coercion is done on the arguments; the left-hand object
955 is the one the operation is performed on, and it's up to the
956 function to deal with the right-hand object.
Guido van Rossum77660912002-04-16 16:32:50 +0000957
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000958 - Otherwise, in-place modification is not supported. Handle it exactly as
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000959 a non in-place operation of the same kind.
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000960
961 */
962
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000963static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000964binary_iop1(PyObject *v, PyObject *w, const int iop_slot, const int op_slot)
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000965{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000966 PyNumberMethods *mv = v->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000967 if (mv != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000968 binaryfunc slot = NB_BINOP(mv, iop_slot);
969 if (slot) {
970 PyObject *x = (slot)(v, w);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000971 if (x != Py_NotImplemented) {
972 return x;
973 }
974 Py_DECREF(x);
975 }
Thomas Woutersf2b332d2000-09-02 08:34:40 +0000976 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000977 return binary_op1(v, w, op_slot);
978}
979
980static PyObject *
981binary_iop(PyObject *v, PyObject *w, const int iop_slot, const int op_slot,
982 const char *op_name)
983{
984 PyObject *result = binary_iop1(v, w, iop_slot, op_slot);
985 if (result == Py_NotImplemented) {
986 Py_DECREF(result);
987 return binop_type_error(v, w, op_name);
988 }
989 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000990}
991
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000992#define INPLACE_BINOP(func, iop, op, op_name) \
993 PyObject * \
994 func(PyObject *v, PyObject *w) { \
995 return binary_iop(v, w, NB_SLOT(iop), NB_SLOT(op), op_name); \
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000996 }
997
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000998INPLACE_BINOP(PyNumber_InPlaceOr, nb_inplace_or, nb_or, "|=")
999INPLACE_BINOP(PyNumber_InPlaceXor, nb_inplace_xor, nb_xor, "^=")
1000INPLACE_BINOP(PyNumber_InPlaceAnd, nb_inplace_and, nb_and, "&=")
1001INPLACE_BINOP(PyNumber_InPlaceLshift, nb_inplace_lshift, nb_lshift, "<<=")
1002INPLACE_BINOP(PyNumber_InPlaceRshift, nb_inplace_rshift, nb_rshift, ">>=")
1003INPLACE_BINOP(PyNumber_InPlaceSubtract, nb_inplace_subtract, nb_subtract, "-=")
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001004
1005PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +00001006PyNumber_InPlaceFloorDivide(PyObject *v, PyObject *w)
1007{
Guido van Rossum4668b002001-08-08 05:00:18 +00001008 return binary_iop(v, w, NB_SLOT(nb_inplace_floor_divide),
1009 NB_SLOT(nb_floor_divide), "//=");
1010}
1011
1012PyObject *
1013PyNumber_InPlaceTrueDivide(PyObject *v, PyObject *w)
1014{
Guido van Rossum4668b002001-08-08 05:00:18 +00001015 return binary_iop(v, w, NB_SLOT(nb_inplace_true_divide),
1016 NB_SLOT(nb_true_divide), "/=");
1017}
1018
1019PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001020PyNumber_InPlaceAdd(PyObject *v, PyObject *w)
1021{
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001022 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_add),
1023 NB_SLOT(nb_add));
1024 if (result == Py_NotImplemented) {
1025 PySequenceMethods *m = v->ob_type->tp_as_sequence;
1026 Py_DECREF(result);
1027 if (m != NULL) {
1028 binaryfunc f = NULL;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001029 f = m->sq_inplace_concat;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001030 if (f == NULL)
1031 f = m->sq_concat;
1032 if (f != NULL)
1033 return (*f)(v, w);
1034 }
1035 result = binop_type_error(v, w, "+=");
Guido van Rossumbb8be932000-09-01 23:27:32 +00001036 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001037 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001038}
1039
1040PyObject *
1041PyNumber_InPlaceMultiply(PyObject *v, PyObject *w)
1042{
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001043 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_multiply),
1044 NB_SLOT(nb_multiply));
1045 if (result == Py_NotImplemented) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001046 ssizeargfunc f = NULL;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001047 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
1048 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
1049 Py_DECREF(result);
1050 if (mv != NULL) {
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001051 f = mv->sq_inplace_repeat;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001052 if (f == NULL)
1053 f = mv->sq_repeat;
1054 if (f != NULL)
1055 return sequence_repeat(f, v, w);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001056 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001057 else if (mw != NULL) {
1058 /* Note that the right hand operand should not be
1059 * mutated in this case so sq_inplace_repeat is not
1060 * used. */
1061 if (mw->sq_repeat)
1062 return sequence_repeat(mw->sq_repeat, w, v);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001063 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001064 result = binop_type_error(v, w, "*=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001065 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001066 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001067}
1068
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001069PyObject *
1070PyNumber_InPlaceRemainder(PyObject *v, PyObject *w)
1071{
Neil Schemenauerd46fbc32002-11-24 01:07:42 +00001072 return binary_iop(v, w, NB_SLOT(nb_inplace_remainder),
1073 NB_SLOT(nb_remainder), "%=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001074}
1075
1076PyObject *
1077PyNumber_InPlacePower(PyObject *v, PyObject *w, PyObject *z)
1078{
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001079 if (v->ob_type->tp_as_number &&
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001080 v->ob_type->tp_as_number->nb_inplace_power != NULL) {
1081 return ternary_op(v, w, z, NB_SLOT(nb_inplace_power), "**=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001082 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001083 else {
1084 return ternary_op(v, w, z, NB_SLOT(nb_power), "**=");
1085 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001086}
1087
1088
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001089/* Unary operators and functions */
Guido van Rossume15dee51995-07-18 14:12:02 +00001090
1091PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001092PyNumber_Negative(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001093{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001094 PyNumberMethods *m;
1095
1096 if (o == NULL)
1097 return null_error();
1098 m = o->ob_type->tp_as_number;
1099 if (m && m->nb_negative)
1100 return (*m->nb_negative)(o);
1101
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001102 return type_error("bad operand type for unary -: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001103}
1104
1105PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001106PyNumber_Positive(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001107{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001108 PyNumberMethods *m;
1109
1110 if (o == NULL)
1111 return null_error();
1112 m = o->ob_type->tp_as_number;
1113 if (m && m->nb_positive)
1114 return (*m->nb_positive)(o);
1115
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001116 return type_error("bad operand type for unary +: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001117}
1118
1119PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001120PyNumber_Invert(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001121{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001122 PyNumberMethods *m;
1123
1124 if (o == NULL)
1125 return null_error();
1126 m = o->ob_type->tp_as_number;
1127 if (m && m->nb_invert)
1128 return (*m->nb_invert)(o);
1129
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001130 return type_error("bad operand type for unary ~: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001131}
1132
1133PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001134PyNumber_Absolute(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001135{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001136 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001137
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001138 if (o == NULL)
1139 return null_error();
1140 m = o->ob_type->tp_as_number;
1141 if (m && m->nb_absolute)
1142 return m->nb_absolute(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001143
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001144 return type_error("bad operand type for abs(): '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001145}
1146
Guido van Rossum98297ee2007-11-06 21:34:58 +00001147/* Return a Python Int or Long from the object item
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001148 Raise TypeError if the result is not an int-or-long
Guido van Rossum98297ee2007-11-06 21:34:58 +00001149 or if the object cannot be interpreted as an index.
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001150*/
1151PyObject *
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001152PyNumber_Index(PyObject *item)
1153{
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001154 PyObject *result = NULL;
1155 if (item == NULL)
1156 return null_error();
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001157 if (PyLong_Check(item)) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001158 Py_INCREF(item);
1159 return item;
1160 }
1161 if (PyIndex_Check(item)) {
1162 result = item->ob_type->tp_as_number->nb_index(item);
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001163 if (result && !PyLong_Check(result)) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001164 PyErr_Format(PyExc_TypeError,
Guido van Rossum032a2842007-02-26 05:44:27 +00001165 "__index__ returned non-int "
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001166 "(type %.200s)",
1167 result->ob_type->tp_name);
1168 Py_DECREF(result);
1169 return NULL;
1170 }
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001171 }
1172 else {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001173 PyErr_Format(PyExc_TypeError,
1174 "'%.200s' object cannot be interpreted "
Guido van Rossum032a2842007-02-26 05:44:27 +00001175 "as an integer", item->ob_type->tp_name);
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001176 }
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001177 return result;
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001178}
1179
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001180/* Return an error on Overflow only if err is not NULL*/
1181
1182Py_ssize_t
1183PyNumber_AsSsize_t(PyObject *item, PyObject *err)
1184{
1185 Py_ssize_t result;
1186 PyObject *runerr;
1187 PyObject *value = PyNumber_Index(item);
1188 if (value == NULL)
1189 return -1;
1190
1191 /* We're done if PyInt_AsSsize_t() returns without error. */
1192 result = PyInt_AsSsize_t(value);
1193 if (result != -1 || !(runerr = PyErr_Occurred()))
1194 goto finish;
1195
1196 /* Error handling code -- only manage OverflowError differently */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001197 if (!PyErr_GivenExceptionMatches(runerr, PyExc_OverflowError))
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001198 goto finish;
1199
1200 PyErr_Clear();
Guido van Rossum98297ee2007-11-06 21:34:58 +00001201 /* If no error-handling desired then the default clipping
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001202 is sufficient.
1203 */
1204 if (!err) {
1205 assert(PyLong_Check(value));
Guido van Rossum98297ee2007-11-06 21:34:58 +00001206 /* Whether or not it is less than or equal to
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001207 zero is determined by the sign of ob_size
1208 */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001209 if (_PyLong_Sign(value) < 0)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001210 result = PY_SSIZE_T_MIN;
1211 else
1212 result = PY_SSIZE_T_MAX;
1213 }
1214 else {
1215 /* Otherwise replace the error with caller's error object. */
1216 PyErr_Format(err,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001217 "cannot fit '%.200s' into an index-sized integer",
1218 item->ob_type->tp_name);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001219 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001220
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001221 finish:
1222 Py_DECREF(value);
1223 return result;
1224}
1225
1226
Guido van Rossum9e896b32000-04-05 20:11:21 +00001227/* Add a check for embedded NULL-bytes in the argument. */
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001228static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001229long_from_string(const char *s, Py_ssize_t len)
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001230{
Guido van Rossum4c08d552000-03-10 22:55:18 +00001231 char *end;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001232 PyObject *x;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001233
Guido van Rossum4c08d552000-03-10 22:55:18 +00001234 x = PyLong_FromString((char*)s, &end, 10);
Guido van Rossum9e896b32000-04-05 20:11:21 +00001235 if (x == NULL)
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001236 return NULL;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001237 if (end != s + len) {
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001238 PyErr_SetString(PyExc_ValueError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00001239 "null byte in argument for int()");
Guido van Rossum9e896b32000-04-05 20:11:21 +00001240 Py_DECREF(x);
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001241 return NULL;
1242 }
1243 return x;
1244}
1245
Guido van Rossume15dee51995-07-18 14:12:02 +00001246PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001247PyNumber_Long(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001248{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001249 PyNumberMethods *m;
Guido van Rossum4c08d552000-03-10 22:55:18 +00001250 const char *buffer;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001251 Py_ssize_t buffer_len;
Guido van Rossume15dee51995-07-18 14:12:02 +00001252
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001253 if (o == NULL)
1254 return null_error();
Guido van Rossumddefaf32007-01-14 03:31:43 +00001255 if (PyLong_CheckExact(o)) {
1256 Py_INCREF(o);
1257 return o;
1258 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001259 m = o->ob_type->tp_as_number;
Guido van Rossumddefaf32007-01-14 03:31:43 +00001260 if (m && m->nb_int) { /* This should include subclasses of int */
1261 PyObject *res = m->nb_int(o);
1262 if (res && !PyLong_Check(res)) {
1263 PyErr_Format(PyExc_TypeError,
1264 "__int__ returned non-int (type %.200s)",
1265 res->ob_type->tp_name);
1266 Py_DECREF(res);
1267 return NULL;
1268 }
1269 return res;
1270 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001271 if (m && m->nb_long) { /* This should include subclasses of long */
1272 PyObject *res = m->nb_long(o);
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001273 if (res && !PyLong_Check(res)) {
Brett Cannonc3647ac2005-04-26 03:45:26 +00001274 PyErr_Format(PyExc_TypeError,
1275 "__long__ returned non-long (type %.200s)",
1276 res->ob_type->tp_name);
1277 Py_DECREF(res);
1278 return NULL;
1279 }
1280 return res;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001281 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001282 if (PyLong_Check(o)) /* A long subclass without nb_long */
Tim Petersdb30ac42002-03-02 04:14:21 +00001283 return _PyLong_Copy((PyLongObject *)o);
Guido van Rossum9e896b32000-04-05 20:11:21 +00001284 if (PyUnicode_Check(o))
1285 /* The above check is done in PyLong_FromUnicode(). */
1286 return PyLong_FromUnicode(PyUnicode_AS_UNICODE(o),
1287 PyUnicode_GET_SIZE(o),
1288 10);
Guido van Rossum4c08d552000-03-10 22:55:18 +00001289 if (!PyObject_AsCharBuffer(o, &buffer, &buffer_len))
1290 return long_from_string(buffer, buffer_len);
Guido van Rossume15dee51995-07-18 14:12:02 +00001291
Guido van Rossumddefaf32007-01-14 03:31:43 +00001292 return type_error("int() argument must be a string or a "
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001293 "number, not '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001294}
1295
1296PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001297PyNumber_Float(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001298{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001299 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001300
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001301 if (o == NULL)
1302 return null_error();
Brett Cannonc3647ac2005-04-26 03:45:26 +00001303 m = o->ob_type->tp_as_number;
1304 if (m && m->nb_float) { /* This should include subclasses of float */
1305 PyObject *res = m->nb_float(o);
1306 if (res && !PyFloat_Check(res)) {
1307 PyErr_Format(PyExc_TypeError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001308 "__float__ returned non-float (type %.200s)",
1309 res->ob_type->tp_name);
Brett Cannonc3647ac2005-04-26 03:45:26 +00001310 Py_DECREF(res);
1311 return NULL;
1312 }
1313 return res;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001314 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001315 if (PyFloat_Check(o)) { /* A float subclass with nb_float == NULL */
Tim Peters7a50f252001-09-10 21:28:20 +00001316 PyFloatObject *po = (PyFloatObject *)o;
1317 return PyFloat_FromDouble(po->ob_fval);
1318 }
Georg Brandl428f0642007-03-18 18:35:15 +00001319 return PyFloat_FromString(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001320}
1321
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001322
1323PyObject *
1324PyNumber_ToBase(PyObject *n, int base)
1325{
1326 PyObject *res;
1327 PyObject *index = PyNumber_Index(n);
1328
1329 if (!index)
1330 return NULL;
1331 assert(PyLong_Check(index));
1332 res = _PyLong_Format(index, base);
1333 Py_DECREF(index);
1334 return res;
1335}
1336
1337
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001338/* Operations on sequences */
Guido van Rossume15dee51995-07-18 14:12:02 +00001339
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001340int
Fred Drake79912472000-07-09 04:06:11 +00001341PySequence_Check(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001342{
Thomas Wouterscf297e42007-02-23 15:07:44 +00001343 if (PyObject_IsInstance(s, (PyObject *)&PyDict_Type))
1344 return 0;
Guido van Rossum8700b422001-09-07 20:20:11 +00001345 return s != NULL && s->ob_type->tp_as_sequence &&
1346 s->ob_type->tp_as_sequence->sq_item != NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001347}
1348
Martin v. Löwis18e16552006-02-15 17:27:45 +00001349Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001350PySequence_Size(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001351{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001352 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001353
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001354 if (s == NULL) {
1355 null_error();
1356 return -1;
1357 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001358
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001359 m = s->ob_type->tp_as_sequence;
1360 if (m && m->sq_length)
1361 return m->sq_length(s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001362
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001363 type_error("object of type '%.200s' has no len()", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001364 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001365}
1366
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001367#undef PySequence_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001368Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001369PySequence_Length(PyObject *s)
1370{
1371 return PySequence_Size(s);
1372}
1373#define PySequence_Length PySequence_Size
1374
Guido van Rossume15dee51995-07-18 14:12:02 +00001375PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001376PySequence_Concat(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001377{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001378 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001379
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001380 if (s == NULL || o == NULL)
1381 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001382
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001383 m = s->ob_type->tp_as_sequence;
1384 if (m && m->sq_concat)
1385 return m->sq_concat(s, o);
1386
Armin Rigofd163f92005-12-29 15:59:19 +00001387 /* Instances of user classes defining an __add__() method only
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001388 have an nb_add slot, not an sq_concat slot. So we fall back
Armin Rigofd163f92005-12-29 15:59:19 +00001389 to nb_add if both arguments appear to be sequences. */
1390 if (PySequence_Check(s) && PySequence_Check(o)) {
1391 PyObject *result = binary_op1(s, o, NB_SLOT(nb_add));
1392 if (result != Py_NotImplemented)
1393 return result;
1394 Py_DECREF(result);
1395 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001396 return type_error("'%.200s' object can't be concatenated", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001397}
1398
1399PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001400PySequence_Repeat(PyObject *o, Py_ssize_t count)
Guido van Rossume15dee51995-07-18 14:12:02 +00001401{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001402 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001403
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001404 if (o == NULL)
1405 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001406
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001407 m = o->ob_type->tp_as_sequence;
1408 if (m && m->sq_repeat)
1409 return m->sq_repeat(o, count);
1410
Armin Rigofd163f92005-12-29 15:59:19 +00001411 /* Instances of user classes defining a __mul__() method only
1412 have an nb_multiply slot, not an sq_repeat slot. so we fall back
1413 to nb_multiply if o appears to be a sequence. */
1414 if (PySequence_Check(o)) {
1415 PyObject *n, *result;
Martin v. Löwiseb079f12006-02-16 14:32:27 +00001416 n = PyInt_FromSsize_t(count);
Armin Rigofd163f92005-12-29 15:59:19 +00001417 if (n == NULL)
1418 return NULL;
1419 result = binary_op1(o, n, NB_SLOT(nb_multiply));
1420 Py_DECREF(n);
1421 if (result != Py_NotImplemented)
1422 return result;
1423 Py_DECREF(result);
1424 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001425 return type_error("'%.200s' object can't be repeated", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001426}
1427
1428PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001429PySequence_InPlaceConcat(PyObject *s, PyObject *o)
1430{
1431 PySequenceMethods *m;
1432
1433 if (s == NULL || o == NULL)
1434 return null_error();
1435
1436 m = s->ob_type->tp_as_sequence;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001437 if (m && m->sq_inplace_concat)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001438 return m->sq_inplace_concat(s, o);
1439 if (m && m->sq_concat)
1440 return m->sq_concat(s, o);
1441
Armin Rigofd163f92005-12-29 15:59:19 +00001442 if (PySequence_Check(s) && PySequence_Check(o)) {
1443 PyObject *result = binary_iop1(s, o, NB_SLOT(nb_inplace_add),
1444 NB_SLOT(nb_add));
1445 if (result != Py_NotImplemented)
1446 return result;
1447 Py_DECREF(result);
1448 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001449 return type_error("'%.200s' object can't be concatenated", s);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001450}
1451
1452PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001453PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001454{
1455 PySequenceMethods *m;
1456
1457 if (o == NULL)
1458 return null_error();
1459
1460 m = o->ob_type->tp_as_sequence;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001461 if (m && m->sq_inplace_repeat)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001462 return m->sq_inplace_repeat(o, count);
1463 if (m && m->sq_repeat)
1464 return m->sq_repeat(o, count);
1465
Armin Rigofd163f92005-12-29 15:59:19 +00001466 if (PySequence_Check(o)) {
1467 PyObject *n, *result;
Martin v. Löwiseb079f12006-02-16 14:32:27 +00001468 n = PyInt_FromSsize_t(count);
Armin Rigofd163f92005-12-29 15:59:19 +00001469 if (n == NULL)
1470 return NULL;
1471 result = binary_iop1(o, n, NB_SLOT(nb_inplace_multiply),
1472 NB_SLOT(nb_multiply));
1473 Py_DECREF(n);
1474 if (result != Py_NotImplemented)
1475 return result;
1476 Py_DECREF(result);
1477 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001478 return type_error("'%.200s' object can't be repeated", o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001479}
1480
1481PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001482PySequence_GetItem(PyObject *s, Py_ssize_t i)
Guido van Rossume15dee51995-07-18 14:12:02 +00001483{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001484 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001485
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001486 if (s == NULL)
1487 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001488
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001489 m = s->ob_type->tp_as_sequence;
1490 if (m && m->sq_item) {
1491 if (i < 0) {
1492 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001493 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001494 if (l < 0)
1495 return NULL;
1496 i += l;
1497 }
1498 }
1499 return m->sq_item(s, i);
1500 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001501
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001502 return type_error("'%.200s' object is unindexable", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001503}
1504
1505PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001506PySequence_GetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossume15dee51995-07-18 14:12:02 +00001507{
Thomas Wouters1d75a792000-08-17 22:37:32 +00001508 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001509
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001510 if (!s) return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001511
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001512 mp = s->ob_type->tp_as_mapping;
1513 if (mp->mp_subscript) {
Thomas Wouters1d75a792000-08-17 22:37:32 +00001514 PyObject *res;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001515 PyObject *slice = _PySlice_FromIndices(i1, i2);
Thomas Wouters1d75a792000-08-17 22:37:32 +00001516 if (!slice)
1517 return NULL;
1518 res = mp->mp_subscript(s, slice);
1519 Py_DECREF(slice);
1520 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001521 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001522
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001523 return type_error("'%.200s' object is unsliceable", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001524}
1525
1526int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001527PySequence_SetItem(PyObject *s, Py_ssize_t i, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001528{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001529 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001530
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001531 if (s == NULL) {
1532 null_error();
1533 return -1;
1534 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001535
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001536 m = s->ob_type->tp_as_sequence;
1537 if (m && m->sq_ass_item) {
1538 if (i < 0) {
1539 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001540 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001541 if (l < 0)
Guido van Rossumed6219b1998-05-29 02:59:33 +00001542 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001543 i += l;
1544 }
1545 }
1546 return m->sq_ass_item(s, i, o);
1547 }
1548
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001549 type_error("'%.200s' object does not support item assignment", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001550 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001551}
1552
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001553int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001554PySequence_DelItem(PyObject *s, Py_ssize_t i)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001555{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001556 PySequenceMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001557
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001558 if (s == NULL) {
1559 null_error();
1560 return -1;
1561 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001562
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001563 m = s->ob_type->tp_as_sequence;
1564 if (m && m->sq_ass_item) {
1565 if (i < 0) {
1566 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001567 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001568 if (l < 0)
Guido van Rossumed6219b1998-05-29 02:59:33 +00001569 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001570 i += l;
1571 }
1572 }
1573 return m->sq_ass_item(s, i, (PyObject *)NULL);
1574 }
1575
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001576 type_error("'%.200s' object doesn't support item deletion", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001577 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001578}
1579
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001580int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001581PySequence_SetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001582{
Thomas Wouters1d75a792000-08-17 22:37:32 +00001583 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001584
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001585 if (s == NULL) {
1586 null_error();
1587 return -1;
1588 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001589
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001590 mp = s->ob_type->tp_as_mapping;
1591 if (mp->mp_ass_subscript) {
Thomas Wouters1d75a792000-08-17 22:37:32 +00001592 int res;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001593 PyObject *slice = _PySlice_FromIndices(i1, i2);
Thomas Wouters1d75a792000-08-17 22:37:32 +00001594 if (!slice)
1595 return -1;
1596 res = mp->mp_ass_subscript(s, slice, o);
1597 Py_DECREF(slice);
1598 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001599 }
Thomas Wouters1d75a792000-08-17 22:37:32 +00001600
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001601 type_error("'%.200s' object doesn't support slice assignment", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001602 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001603}
1604
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001605int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001606PySequence_DelSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001607{
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001608 PyMappingMethods *mp;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001609
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001610 if (s == NULL) {
1611 null_error();
1612 return -1;
1613 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001614
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001615 mp = s->ob_type->tp_as_mapping;
1616 if (mp->mp_ass_subscript) {
1617 int res;
1618 PyObject *slice = _PySlice_FromIndices(i1, i2);
1619 if (!slice)
1620 return -1;
1621 res = mp->mp_ass_subscript(s, slice, NULL);
1622 Py_DECREF(slice);
1623 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001624 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001625 type_error("'%.200s' object doesn't support slice deletion", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001626 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001627}
1628
Guido van Rossume15dee51995-07-18 14:12:02 +00001629PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001630PySequence_Tuple(PyObject *v)
Guido van Rossume15dee51995-07-18 14:12:02 +00001631{
Tim Peters6912d4d2001-05-05 03:56:37 +00001632 PyObject *it; /* iter(v) */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001633 Py_ssize_t n; /* guess for result tuple size */
Tim Peters6912d4d2001-05-05 03:56:37 +00001634 PyObject *result;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001635 Py_ssize_t j;
Guido van Rossume15dee51995-07-18 14:12:02 +00001636
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001637 if (v == NULL)
1638 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001639
Tim Peters6912d4d2001-05-05 03:56:37 +00001640 /* Special-case the common tuple and list cases, for efficiency. */
Tim Peters4c3a0a32001-09-10 23:37:46 +00001641 if (PyTuple_CheckExact(v)) {
1642 /* Note that we can't know whether it's safe to return
1643 a tuple *subclass* instance as-is, hence the restriction
Tim Peters8ff70a92001-09-10 23:53:53 +00001644 to exact tuples here. In contrast, lists always make
1645 a copy, so there's no need for exactness below. */
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001646 Py_INCREF(v);
1647 return v;
Guido van Rossume15dee51995-07-18 14:12:02 +00001648 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001649 if (PyList_Check(v))
1650 return PyList_AsTuple(v);
1651
Tim Peters6912d4d2001-05-05 03:56:37 +00001652 /* Get iterator. */
1653 it = PyObject_GetIter(v);
1654 if (it == NULL)
Tim Peters1fc240e2001-10-26 05:06:50 +00001655 return NULL;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001656
Tim Peters6912d4d2001-05-05 03:56:37 +00001657 /* Guess result size and allocate space. */
Armin Rigof5b3e362006-02-11 21:32:43 +00001658 n = _PyObject_LengthHint(v);
Tim Peters6912d4d2001-05-05 03:56:37 +00001659 if (n < 0) {
Raymond Hettingera710b332005-08-21 11:03:59 +00001660 if (!PyErr_ExceptionMatches(PyExc_TypeError) &&
1661 !PyErr_ExceptionMatches(PyExc_AttributeError)) {
1662 Py_DECREF(it);
1663 return NULL;
1664 }
Tim Peters6912d4d2001-05-05 03:56:37 +00001665 PyErr_Clear();
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001666 n = 10; /* arbitrary */
Tim Peters6912d4d2001-05-05 03:56:37 +00001667 }
1668 result = PyTuple_New(n);
1669 if (result == NULL)
1670 goto Fail;
1671
1672 /* Fill the tuple. */
1673 for (j = 0; ; ++j) {
1674 PyObject *item = PyIter_Next(it);
1675 if (item == NULL) {
1676 if (PyErr_Occurred())
1677 goto Fail;
1678 break;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001679 }
Tim Peters6912d4d2001-05-05 03:56:37 +00001680 if (j >= n) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001681 Py_ssize_t oldn = n;
Raymond Hettinger4d012592004-12-16 10:38:38 +00001682 /* The over-allocation strategy can grow a bit faster
Guido van Rossum98297ee2007-11-06 21:34:58 +00001683 than for lists because unlike lists the
Raymond Hettinger4d012592004-12-16 10:38:38 +00001684 over-allocation isn't permanent -- we reclaim
1685 the excess before the end of this routine.
1686 So, grow by ten and then add 25%.
1687 */
1688 n += 10;
1689 n += n >> 2;
1690 if (n < oldn) {
1691 /* Check for overflow */
1692 PyErr_NoMemory();
Raymond Hettingere6bdb372004-12-16 15:10:21 +00001693 Py_DECREF(item);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001694 goto Fail;
Raymond Hettinger4d012592004-12-16 10:38:38 +00001695 }
Tim Peters4324aa32001-05-28 22:30:08 +00001696 if (_PyTuple_Resize(&result, n) != 0) {
Tim Peters12d0a6c2001-05-05 04:10:25 +00001697 Py_DECREF(item);
Tim Peters6912d4d2001-05-05 03:56:37 +00001698 goto Fail;
Tim Peters12d0a6c2001-05-05 04:10:25 +00001699 }
Tim Peters6912d4d2001-05-05 03:56:37 +00001700 }
1701 PyTuple_SET_ITEM(result, j, item);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001702 }
1703
Tim Peters6912d4d2001-05-05 03:56:37 +00001704 /* Cut tuple back if guess was too large. */
1705 if (j < n &&
Tim Peters4324aa32001-05-28 22:30:08 +00001706 _PyTuple_Resize(&result, j) != 0)
Tim Peters6912d4d2001-05-05 03:56:37 +00001707 goto Fail;
1708
1709 Py_DECREF(it);
1710 return result;
1711
1712Fail:
1713 Py_XDECREF(result);
1714 Py_DECREF(it);
1715 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001716}
1717
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001718PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001719PySequence_List(PyObject *v)
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001720{
Tim Petersf553f892001-05-01 20:45:31 +00001721 PyObject *result; /* result list */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001722 PyObject *rv; /* return value from PyList_Extend */
Guido van Rossum4669fb41997-04-02 05:31:09 +00001723
Guido van Rossum5dba9e81998-07-10 18:03:50 +00001724 if (v == NULL)
1725 return null_error();
1726
Raymond Hettinger8ca92ae2004-03-11 09:13:12 +00001727 result = PyList_New(0);
1728 if (result == NULL)
Tim Petersf553f892001-05-01 20:45:31 +00001729 return NULL;
1730
Raymond Hettinger8ca92ae2004-03-11 09:13:12 +00001731 rv = _PyList_Extend((PyListObject *)result, v);
1732 if (rv == NULL) {
1733 Py_DECREF(result);
Tim Petersf553f892001-05-01 20:45:31 +00001734 return NULL;
1735 }
Raymond Hettinger969d8c02004-03-17 05:24:23 +00001736 Py_DECREF(rv);
Tim Petersf553f892001-05-01 20:45:31 +00001737 return result;
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001738}
1739
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001740PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001741PySequence_Fast(PyObject *v, const char *m)
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001742{
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001743 PyObject *it;
1744
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001745 if (v == NULL)
1746 return null_error();
1747
Michael W. Hudson2801fe12002-11-05 18:05:49 +00001748 if (PyList_CheckExact(v) || PyTuple_CheckExact(v)) {
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001749 Py_INCREF(v);
1750 return v;
1751 }
1752
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001753 it = PyObject_GetIter(v);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001754 if (it == NULL) {
1755 if (PyErr_ExceptionMatches(PyExc_TypeError))
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001756 PyErr_SetString(PyExc_TypeError, m);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001757 return NULL;
1758 }
1759
Raymond Hettinger193814c2004-12-18 19:00:59 +00001760 v = PySequence_List(it);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001761 Py_DECREF(it);
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001762
1763 return v;
1764}
1765
Tim Peters16a77ad2001-09-08 04:00:12 +00001766/* Iterate over seq. Result depends on the operation:
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001767 PY_ITERSEARCH_COUNT: -1 if error, else # of times obj appears in seq.
1768 PY_ITERSEARCH_INDEX: 0-based index of first occurence of obj in seq;
1769 set ValueError and return -1 if none found; also return -1 on error.
Tim Peters16a77ad2001-09-08 04:00:12 +00001770 Py_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on error.
1771*/
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001772Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001773_PySequence_IterSearch(PyObject *seq, PyObject *obj, int operation)
Guido van Rossume15dee51995-07-18 14:12:02 +00001774{
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001775 Py_ssize_t n;
Tim Peters16a77ad2001-09-08 04:00:12 +00001776 int wrapped; /* for PY_ITERSEARCH_INDEX, true iff n wrapped around */
1777 PyObject *it; /* iter(seq) */
Guido van Rossume15dee51995-07-18 14:12:02 +00001778
Tim Peters16a77ad2001-09-08 04:00:12 +00001779 if (seq == NULL || obj == NULL) {
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001780 null_error();
1781 return -1;
1782 }
Tim Peters75f8e352001-05-05 11:33:43 +00001783
Tim Peters16a77ad2001-09-08 04:00:12 +00001784 it = PyObject_GetIter(seq);
Tim Peters75f8e352001-05-05 11:33:43 +00001785 if (it == NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001786 type_error("argument of type '%.200s' is not iterable", seq);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001787 return -1;
Tim Peters75f8e352001-05-05 11:33:43 +00001788 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001789
Tim Peters16a77ad2001-09-08 04:00:12 +00001790 n = wrapped = 0;
Tim Peters75f8e352001-05-05 11:33:43 +00001791 for (;;) {
1792 int cmp;
1793 PyObject *item = PyIter_Next(it);
1794 if (item == NULL) {
1795 if (PyErr_Occurred())
1796 goto Fail;
1797 break;
1798 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001799
1800 cmp = PyObject_RichCompareBool(obj, item, Py_EQ);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001801 Py_DECREF(item);
Tim Peters75f8e352001-05-05 11:33:43 +00001802 if (cmp < 0)
1803 goto Fail;
1804 if (cmp > 0) {
Tim Peters16a77ad2001-09-08 04:00:12 +00001805 switch (operation) {
1806 case PY_ITERSEARCH_COUNT:
Thomas Wouters89f507f2006-12-13 04:49:30 +00001807 if (n == PY_SSIZE_T_MAX) {
Tim Peters16a77ad2001-09-08 04:00:12 +00001808 PyErr_SetString(PyExc_OverflowError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00001809 "count exceeds C integer size");
Tim Peters16a77ad2001-09-08 04:00:12 +00001810 goto Fail;
1811 }
Thomas Wouters89f507f2006-12-13 04:49:30 +00001812 ++n;
Tim Peters16a77ad2001-09-08 04:00:12 +00001813 break;
1814
1815 case PY_ITERSEARCH_INDEX:
1816 if (wrapped) {
1817 PyErr_SetString(PyExc_OverflowError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00001818 "index exceeds C integer size");
Tim Peters16a77ad2001-09-08 04:00:12 +00001819 goto Fail;
1820 }
1821 goto Done;
1822
1823 case PY_ITERSEARCH_CONTAINS:
1824 n = 1;
1825 goto Done;
1826
1827 default:
1828 assert(!"unknown operation");
Tim Peters75f8e352001-05-05 11:33:43 +00001829 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001830 }
1831
1832 if (operation == PY_ITERSEARCH_INDEX) {
Thomas Wouters89f507f2006-12-13 04:49:30 +00001833 if (n == PY_SSIZE_T_MAX)
Tim Peters16a77ad2001-09-08 04:00:12 +00001834 wrapped = 1;
Thomas Wouters89f507f2006-12-13 04:49:30 +00001835 ++n;
Tim Peters75f8e352001-05-05 11:33:43 +00001836 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001837 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001838
1839 if (operation != PY_ITERSEARCH_INDEX)
1840 goto Done;
1841
1842 PyErr_SetString(PyExc_ValueError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001843 "sequence.index(x): x not in sequence");
Tim Peters16a77ad2001-09-08 04:00:12 +00001844 /* fall into failure code */
1845Fail:
1846 n = -1;
1847 /* fall through */
1848Done:
Tim Peters75f8e352001-05-05 11:33:43 +00001849 Py_DECREF(it);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001850 return n;
Tim Peters75f8e352001-05-05 11:33:43 +00001851
Guido van Rossume15dee51995-07-18 14:12:02 +00001852}
1853
Tim Peters16a77ad2001-09-08 04:00:12 +00001854/* Return # of times o appears in s. */
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001855Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001856PySequence_Count(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001857{
Tim Peters16a77ad2001-09-08 04:00:12 +00001858 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_COUNT);
Guido van Rossume15dee51995-07-18 14:12:02 +00001859}
1860
Tim Peterscb8d3682001-05-05 21:05:01 +00001861/* Return -1 if error; 1 if ob in seq; 0 if ob not in seq.
Tim Peters16a77ad2001-09-08 04:00:12 +00001862 * Use sq_contains if possible, else defer to _PySequence_IterSearch().
Tim Peterscb8d3682001-05-05 21:05:01 +00001863 */
1864int
1865PySequence_Contains(PyObject *seq, PyObject *ob)
1866{
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001867 Py_ssize_t result;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001868 PySequenceMethods *sqm = seq->ob_type->tp_as_sequence;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001869 if (sqm != NULL && sqm->sq_contains != NULL)
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001870 return (*sqm->sq_contains)(seq, ob);
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001871 result = _PySequence_IterSearch(seq, ob, PY_ITERSEARCH_CONTAINS);
1872 return Py_SAFE_DOWNCAST(result, Py_ssize_t, int);
Tim Peterscb8d3682001-05-05 21:05:01 +00001873}
1874
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001875/* Backwards compatibility */
1876#undef PySequence_In
1877int
Fred Drake79912472000-07-09 04:06:11 +00001878PySequence_In(PyObject *w, PyObject *v)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001879{
1880 return PySequence_Contains(w, v);
1881}
1882
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001883Py_ssize_t
Fred Drake79912472000-07-09 04:06:11 +00001884PySequence_Index(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001885{
Tim Peters16a77ad2001-09-08 04:00:12 +00001886 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_INDEX);
Guido van Rossume15dee51995-07-18 14:12:02 +00001887}
1888
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001889/* Operations on mappings */
1890
1891int
Fred Drake79912472000-07-09 04:06:11 +00001892PyMapping_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001893{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001894 return o && o->ob_type->tp_as_mapping &&
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001895 o->ob_type->tp_as_mapping->mp_subscript;
Guido van Rossume15dee51995-07-18 14:12:02 +00001896}
1897
Martin v. Löwis18e16552006-02-15 17:27:45 +00001898Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001899PyMapping_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001900{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001901 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001902
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001903 if (o == NULL) {
1904 null_error();
1905 return -1;
1906 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001907
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001908 m = o->ob_type->tp_as_mapping;
1909 if (m && m->mp_length)
1910 return m->mp_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001911
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001912 type_error("object of type '%.200s' has no len()", o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001913 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001914}
1915
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001916#undef PyMapping_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001917Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001918PyMapping_Length(PyObject *o)
1919{
1920 return PyMapping_Size(o);
1921}
1922#define PyMapping_Length PyMapping_Size
1923
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001924PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001925PyMapping_GetItemString(PyObject *o, char *key)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001926{
1927 PyObject *okey, *r;
1928
1929 if (key == NULL)
1930 return null_error();
1931
Martin v. Löwis5b222132007-06-10 09:51:05 +00001932 okey = PyUnicode_FromString(key);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001933 if (okey == NULL)
1934 return NULL;
1935 r = PyObject_GetItem(o, okey);
1936 Py_DECREF(okey);
1937 return r;
1938}
1939
1940int
Fred Drake79912472000-07-09 04:06:11 +00001941PyMapping_SetItemString(PyObject *o, char *key, PyObject *value)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001942{
1943 PyObject *okey;
1944 int r;
1945
1946 if (key == NULL) {
1947 null_error();
1948 return -1;
1949 }
1950
Martin v. Löwis5b222132007-06-10 09:51:05 +00001951 okey = PyUnicode_FromString(key);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001952 if (okey == NULL)
Guido van Rossumed6219b1998-05-29 02:59:33 +00001953 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001954 r = PyObject_SetItem(o, okey, value);
1955 Py_DECREF(okey);
1956 return r;
1957}
1958
1959int
Fred Drake79912472000-07-09 04:06:11 +00001960PyMapping_HasKeyString(PyObject *o, char *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00001961{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001962 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00001963
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001964 v = PyMapping_GetItemString(o, key);
1965 if (v) {
1966 Py_DECREF(v);
1967 return 1;
1968 }
1969 PyErr_Clear();
1970 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00001971}
1972
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001973int
Fred Drake79912472000-07-09 04:06:11 +00001974PyMapping_HasKey(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00001975{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001976 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00001977
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001978 v = PyObject_GetItem(o, key);
1979 if (v) {
1980 Py_DECREF(v);
1981 return 1;
1982 }
1983 PyErr_Clear();
1984 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00001985}
1986
Guido van Rossumcc2b0162007-02-11 06:12:03 +00001987PyObject *
1988PyMapping_Keys(PyObject *o)
1989{
1990 PyObject *keys;
1991 PyObject *fast;
1992
1993 if (PyDict_CheckExact(o))
1994 return PyDict_Keys(o);
1995 keys = PyObject_CallMethod(o, "keys", NULL);
1996 if (keys == NULL)
1997 return NULL;
1998 fast = PySequence_Fast(keys, "o.keys() are not iterable");
1999 Py_DECREF(keys);
2000 return fast;
2001}
2002
2003PyObject *
2004PyMapping_Items(PyObject *o)
2005{
2006 PyObject *items;
2007 PyObject *fast;
2008
2009 if (PyDict_CheckExact(o))
2010 return PyDict_Items(o);
2011 items = PyObject_CallMethod(o, "items", NULL);
2012 if (items == NULL)
2013 return NULL;
2014 fast = PySequence_Fast(items, "o.items() are not iterable");
2015 Py_DECREF(items);
2016 return fast;
2017}
2018
2019PyObject *
2020PyMapping_Values(PyObject *o)
2021{
2022 PyObject *values;
2023 PyObject *fast;
2024
2025 if (PyDict_CheckExact(o))
2026 return PyDict_Values(o);
2027 values = PyObject_CallMethod(o, "values", NULL);
2028 if (values == NULL)
2029 return NULL;
2030 fast = PySequence_Fast(values, "o.values() are not iterable");
2031 Py_DECREF(values);
2032 return fast;
2033}
2034
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002035/* Operations on callable objects */
2036
2037/* XXX PyCallable_Check() is in object.c */
2038
Guido van Rossume15dee51995-07-18 14:12:02 +00002039PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002040PyObject_CallObject(PyObject *o, PyObject *a)
Guido van Rossume15dee51995-07-18 14:12:02 +00002041{
Guido van Rossum5560b742001-09-14 16:47:50 +00002042 return PyEval_CallObjectWithKeywords(o, a, NULL);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002043}
Guido van Rossume15dee51995-07-18 14:12:02 +00002044
2045PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00002046PyObject_Call(PyObject *func, PyObject *arg, PyObject *kw)
2047{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002048 ternaryfunc call;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002049
2050 if ((call = func->ob_type->tp_call) != NULL) {
Thomas Wouters89d996e2007-09-08 17:39:28 +00002051 PyObject *result;
2052 if (Py_EnterRecursiveCall(" while calling a Python object"))
2053 return NULL;
2054 result = (*call)(func, arg, kw);
2055 Py_LeaveRecursiveCall();
Tim Peters6d6c1a32001-08-02 04:15:00 +00002056 if (result == NULL && !PyErr_Occurred())
2057 PyErr_SetString(
2058 PyExc_SystemError,
2059 "NULL result without error in PyObject_Call");
2060 return result;
2061 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002062 PyErr_Format(PyExc_TypeError, "'%.200s' object is not callable",
Fred Drake573395a2001-11-01 20:26:12 +00002063 func->ob_type->tp_name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002064 return NULL;
2065}
2066
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002067static PyObject*
2068call_function_tail(PyObject *callable, PyObject *args)
2069{
2070 PyObject *retval;
2071
2072 if (args == NULL)
2073 return NULL;
2074
2075 if (!PyTuple_Check(args)) {
2076 PyObject *a;
2077
2078 a = PyTuple_New(1);
2079 if (a == NULL) {
2080 Py_DECREF(args);
2081 return NULL;
2082 }
2083 PyTuple_SET_ITEM(a, 0, args);
2084 args = a;
2085 }
2086 retval = PyObject_Call(callable, args, NULL);
2087
2088 Py_DECREF(args);
2089
2090 return retval;
2091}
2092
Tim Peters6d6c1a32001-08-02 04:15:00 +00002093PyObject *
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002094PyObject_CallFunction(PyObject *callable, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002095{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002096 va_list va;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002097 PyObject *args;
Guido van Rossume15dee51995-07-18 14:12:02 +00002098
Fred Drakeb92cf062001-10-27 06:16:31 +00002099 if (callable == NULL)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002100 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002101
Fred Drakeb92cf062001-10-27 06:16:31 +00002102 if (format && *format) {
2103 va_start(va, format);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002104 args = Py_VaBuildValue(format, va);
Fred Drakeb92cf062001-10-27 06:16:31 +00002105 va_end(va);
2106 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002107 else
2108 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002109
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002110 return call_function_tail(callable, args);
2111}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002112
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002113PyObject *
2114_PyObject_CallFunction_SizeT(PyObject *callable, char *format, ...)
2115{
2116 va_list va;
2117 PyObject *args;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002118
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002119 if (callable == NULL)
2120 return null_error();
2121
2122 if (format && *format) {
2123 va_start(va, format);
2124 args = _Py_VaBuildValue_SizeT(format, va);
2125 va_end(va);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002126 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002127 else
2128 args = PyTuple_New(0);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002129
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002130 return call_function_tail(callable, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002131}
2132
2133PyObject *
Guido van Rossume15dee51995-07-18 14:12:02 +00002134PyObject_CallMethod(PyObject *o, char *name, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002135{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002136 va_list va;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002137 PyObject *args;
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002138 PyObject *func = NULL;
2139 PyObject *retval = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002140
Fred Drakeb92cf062001-10-27 06:16:31 +00002141 if (o == NULL || name == NULL)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002142 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002143
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002144 func = PyObject_GetAttrString(o, name);
2145 if (func == NULL) {
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002146 PyErr_SetString(PyExc_AttributeError, name);
2147 return 0;
2148 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002149
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002150 if (!PyCallable_Check(func)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +00002151 type_error("attribute of type '%.200s' is not callable", func);
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002152 goto exit;
2153 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002154
Fred Drakeb92cf062001-10-27 06:16:31 +00002155 if (format && *format) {
2156 va_start(va, format);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002157 args = Py_VaBuildValue(format, va);
Fred Drakeb92cf062001-10-27 06:16:31 +00002158 va_end(va);
2159 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002160 else
2161 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002162
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002163 retval = call_function_tail(func, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002164
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002165 exit:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002166 /* args gets consumed in call_function_tail */
2167 Py_XDECREF(func);
2168
2169 return retval;
2170}
2171
2172PyObject *
2173_PyObject_CallMethod_SizeT(PyObject *o, char *name, char *format, ...)
2174{
2175 va_list va;
2176 PyObject *args;
2177 PyObject *func = NULL;
2178 PyObject *retval = NULL;
2179
2180 if (o == NULL || name == NULL)
2181 return null_error();
2182
2183 func = PyObject_GetAttrString(o, name);
2184 if (func == NULL) {
2185 PyErr_SetString(PyExc_AttributeError, name);
2186 return 0;
2187 }
2188
2189 if (!PyCallable_Check(func)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +00002190 type_error("attribute of type '%.200s' is not callable", func);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002191 goto exit;
2192 }
2193
2194 if (format && *format) {
2195 va_start(va, format);
2196 args = _Py_VaBuildValue_SizeT(format, va);
2197 va_end(va);
2198 }
2199 else
2200 args = PyTuple_New(0);
2201
2202 retval = call_function_tail(func, args);
2203
2204 exit:
2205 /* args gets consumed in call_function_tail */
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002206 Py_XDECREF(func);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002207
2208 return retval;
Guido van Rossume15dee51995-07-18 14:12:02 +00002209}
Guido van Rossum823649d2001-03-21 18:40:58 +00002210
2211
Fred Drakeb421b8c2001-10-26 16:21:32 +00002212static PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002213objargs_mktuple(va_list va)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002214{
2215 int i, n = 0;
2216 va_list countva;
2217 PyObject *result, *tmp;
2218
2219#ifdef VA_LIST_IS_ARRAY
2220 memcpy(countva, va, sizeof(va_list));
2221#else
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002222#ifdef __va_copy
2223 __va_copy(countva, va);
2224#else
Fred Drakeb421b8c2001-10-26 16:21:32 +00002225 countva = va;
2226#endif
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002227#endif
Fred Drakeb421b8c2001-10-26 16:21:32 +00002228
2229 while (((PyObject *)va_arg(countva, PyObject *)) != NULL)
2230 ++n;
2231 result = PyTuple_New(n);
2232 if (result != NULL && n > 0) {
2233 for (i = 0; i < n; ++i) {
2234 tmp = (PyObject *)va_arg(va, PyObject *);
2235 PyTuple_SET_ITEM(result, i, tmp);
2236 Py_INCREF(tmp);
2237 }
2238 }
2239 return result;
2240}
2241
2242PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002243PyObject_CallMethodObjArgs(PyObject *callable, PyObject *name, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002244{
2245 PyObject *args, *tmp;
2246 va_list vargs;
2247
2248 if (callable == NULL || name == NULL)
2249 return null_error();
2250
2251 callable = PyObject_GetAttr(callable, name);
2252 if (callable == NULL)
2253 return NULL;
2254
2255 /* count the args */
2256 va_start(vargs, name);
Fred Drakeb0c079e2001-10-28 02:39:03 +00002257 args = objargs_mktuple(vargs);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002258 va_end(vargs);
2259 if (args == NULL) {
2260 Py_DECREF(callable);
2261 return NULL;
2262 }
2263 tmp = PyObject_Call(callable, args, NULL);
2264 Py_DECREF(args);
2265 Py_DECREF(callable);
2266
2267 return tmp;
2268}
2269
2270PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002271PyObject_CallFunctionObjArgs(PyObject *callable, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002272{
2273 PyObject *args, *tmp;
2274 va_list vargs;
2275
2276 if (callable == NULL)
2277 return null_error();
2278
2279 /* count the args */
2280 va_start(vargs, callable);
Fred Drakeb0c079e2001-10-28 02:39:03 +00002281 args = objargs_mktuple(vargs);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002282 va_end(vargs);
2283 if (args == NULL)
2284 return NULL;
2285 tmp = PyObject_Call(callable, args, NULL);
2286 Py_DECREF(args);
2287
2288 return tmp;
2289}
2290
2291
Guido van Rossum823649d2001-03-21 18:40:58 +00002292/* isinstance(), issubclass() */
2293
Barry Warsawf16951c2002-04-23 22:45:44 +00002294/* abstract_get_bases() has logically 4 return states, with a sort of 0th
2295 * state that will almost never happen.
2296 *
2297 * 0. creating the __bases__ static string could get a MemoryError
2298 * 1. getattr(cls, '__bases__') could raise an AttributeError
2299 * 2. getattr(cls, '__bases__') could raise some other exception
2300 * 3. getattr(cls, '__bases__') could return a tuple
2301 * 4. getattr(cls, '__bases__') could return something other than a tuple
2302 *
2303 * Only state #3 is a non-error state and only it returns a non-NULL object
2304 * (it returns the retrieved tuple).
2305 *
2306 * Any raised AttributeErrors are masked by clearing the exception and
2307 * returning NULL. If an object other than a tuple comes out of __bases__,
2308 * then again, the return value is NULL. So yes, these two situations
2309 * produce exactly the same results: NULL is returned and no error is set.
2310 *
2311 * If some exception other than AttributeError is raised, then NULL is also
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002312 * returned, but the exception is not cleared. That's because we want the
Barry Warsawf16951c2002-04-23 22:45:44 +00002313 * exception to be propagated along.
2314 *
2315 * Callers are expected to test for PyErr_Occurred() when the return value
2316 * is NULL to decide whether a valid exception should be propagated or not.
2317 * When there's no exception to propagate, it's customary for the caller to
2318 * set a TypeError.
2319 */
Neil Schemenauer6b471292001-10-18 03:18:43 +00002320static PyObject *
2321abstract_get_bases(PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002322{
2323 static PyObject *__bases__ = NULL;
2324 PyObject *bases;
Guido van Rossum823649d2001-03-21 18:40:58 +00002325
2326 if (__bases__ == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002327 __bases__ = PyUnicode_FromString("__bases__");
Guido van Rossum823649d2001-03-21 18:40:58 +00002328 if (__bases__ == NULL)
Neil Schemenauer6b471292001-10-18 03:18:43 +00002329 return NULL;
Guido van Rossum823649d2001-03-21 18:40:58 +00002330 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002331 Py_ALLOW_RECURSION
Neil Schemenauer6b471292001-10-18 03:18:43 +00002332 bases = PyObject_GetAttr(cls, __bases__);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002333 Py_END_ALLOW_RECURSION
Barry Warsawf16951c2002-04-23 22:45:44 +00002334 if (bases == NULL) {
2335 if (PyErr_ExceptionMatches(PyExc_AttributeError))
2336 PyErr_Clear();
Neil Schemenauer6b471292001-10-18 03:18:43 +00002337 return NULL;
Guido van Rossum823649d2001-03-21 18:40:58 +00002338 }
Barry Warsawf16951c2002-04-23 22:45:44 +00002339 if (!PyTuple_Check(bases)) {
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002340 Py_DECREF(bases);
Barry Warsawf16951c2002-04-23 22:45:44 +00002341 return NULL;
2342 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002343 return bases;
2344}
2345
2346
2347static int
2348abstract_issubclass(PyObject *derived, PyObject *cls)
2349{
2350 PyObject *bases;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002351 Py_ssize_t i, n;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002352 int r = 0;
2353
2354
Guido van Rossum823649d2001-03-21 18:40:58 +00002355 if (derived == cls)
2356 return 1;
2357
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002358 if (PyTuple_Check(cls)) {
2359 /* Not a general sequence -- that opens up the road to
2360 recursion and stack overflow. */
2361 n = PyTuple_GET_SIZE(cls);
2362 for (i = 0; i < n; i++) {
2363 if (derived == PyTuple_GET_ITEM(cls, i))
2364 return 1;
2365 }
2366 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002367 bases = abstract_get_bases(derived);
Barry Warsawf16951c2002-04-23 22:45:44 +00002368 if (bases == NULL) {
2369 if (PyErr_Occurred())
2370 return -1;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002371 return 0;
Barry Warsawf16951c2002-04-23 22:45:44 +00002372 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002373 n = PyTuple_GET_SIZE(bases);
2374 for (i = 0; i < n; i++) {
Neil Schemenauer6b471292001-10-18 03:18:43 +00002375 r = abstract_issubclass(PyTuple_GET_ITEM(bases, i), cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002376 if (r != 0)
2377 break;
2378 }
2379
2380 Py_DECREF(bases);
2381
2382 return r;
2383}
2384
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002385static int
2386check_class(PyObject *cls, const char *error)
2387{
2388 PyObject *bases = abstract_get_bases(cls);
2389 if (bases == NULL) {
2390 /* Do not mask errors. */
2391 if (!PyErr_Occurred())
2392 PyErr_SetString(PyExc_TypeError, error);
2393 return 0;
2394 }
2395 Py_DECREF(bases);
2396 return -1;
2397}
2398
Brett Cannon4f653312004-03-20 22:52:14 +00002399static int
2400recursive_isinstance(PyObject *inst, PyObject *cls, int recursion_depth)
Guido van Rossum823649d2001-03-21 18:40:58 +00002401{
2402 PyObject *icls;
2403 static PyObject *__class__ = NULL;
2404 int retval = 0;
2405
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002406 if (__class__ == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002407 __class__ = PyUnicode_FromString("__class__");
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002408 if (__class__ == NULL)
2409 return -1;
2410 }
2411
Guido van Rossum45aecf42006-03-15 04:58:47 +00002412 if (PyType_Check(cls)) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00002413 retval = PyObject_TypeCheck(inst, (PyTypeObject *)cls);
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002414 if (retval == 0) {
2415 PyObject *c = PyObject_GetAttr(inst, __class__);
2416 if (c == NULL) {
2417 PyErr_Clear();
2418 }
2419 else {
Guido van Rossume5b130b2003-02-12 03:36:05 +00002420 if (c != (PyObject *)(inst->ob_type) &&
2421 PyType_Check(c))
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002422 retval = PyType_IsSubtype(
2423 (PyTypeObject *)c,
2424 (PyTypeObject *)cls);
2425 Py_DECREF(c);
2426 }
2427 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002428 }
Guido van Rossum03290ec2001-10-07 20:54:12 +00002429 else if (PyTuple_Check(cls)) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00002430 Py_ssize_t i, n;
Guido van Rossum03290ec2001-10-07 20:54:12 +00002431
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002432 if (!recursion_depth) {
2433 PyErr_SetString(PyExc_RuntimeError,
2434 "nest level of tuple too deep");
2435 return -1;
2436 }
Brett Cannon4f653312004-03-20 22:52:14 +00002437
Guido van Rossum03290ec2001-10-07 20:54:12 +00002438 n = PyTuple_GET_SIZE(cls);
2439 for (i = 0; i < n; i++) {
Brett Cannon4f653312004-03-20 22:52:14 +00002440 retval = recursive_isinstance(
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002441 inst,
2442 PyTuple_GET_ITEM(cls, i),
2443 recursion_depth-1);
Guido van Rossum03290ec2001-10-07 20:54:12 +00002444 if (retval != 0)
2445 break;
2446 }
Guido van Rossum03290ec2001-10-07 20:54:12 +00002447 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002448 else {
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002449 if (!check_class(cls,
2450 "isinstance() arg 2 must be a class, type,"
2451 " or tuple of classes and types"))
Neil Schemenauer6b471292001-10-18 03:18:43 +00002452 return -1;
Guido van Rossum823649d2001-03-21 18:40:58 +00002453 icls = PyObject_GetAttr(inst, __class__);
Neil Schemenauer6b471292001-10-18 03:18:43 +00002454 if (icls == NULL) {
2455 PyErr_Clear();
2456 retval = 0;
Guido van Rossum823649d2001-03-21 18:40:58 +00002457 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002458 else {
2459 retval = abstract_issubclass(icls, cls);
2460 Py_DECREF(icls);
2461 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002462 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002463
Guido van Rossum823649d2001-03-21 18:40:58 +00002464 return retval;
2465}
2466
2467int
Brett Cannon4f653312004-03-20 22:52:14 +00002468PyObject_IsInstance(PyObject *inst, PyObject *cls)
2469{
Guido van Rossumadee45e2007-05-25 17:55:52 +00002470 PyObject *t, *v, *tb;
Guido van Rossume7ba4952007-06-06 23:52:48 +00002471 PyObject *checker;
Guido van Rossumadee45e2007-05-25 17:55:52 +00002472 PyErr_Fetch(&t, &v, &tb);
Guido van Rossume7ba4952007-06-06 23:52:48 +00002473 checker = PyObject_GetAttrString(cls, "__instancecheck__");
Guido van Rossumadee45e2007-05-25 17:55:52 +00002474 PyErr_Restore(t, v, tb);
2475 if (checker != NULL) {
2476 PyObject *res;
2477 int ok = -1;
Guido van Rossum29478ef2007-05-29 00:39:44 +00002478 if (Py_EnterRecursiveCall(" in __instancecheck__")) {
2479 Py_DECREF(checker);
Guido van Rossumadee45e2007-05-25 17:55:52 +00002480 return ok;
Guido van Rossum29478ef2007-05-29 00:39:44 +00002481 }
Guido van Rossumadee45e2007-05-25 17:55:52 +00002482 res = PyObject_CallFunctionObjArgs(checker, inst, NULL);
2483 Py_LeaveRecursiveCall();
2484 Py_DECREF(checker);
2485 if (res != NULL) {
2486 ok = PyObject_IsTrue(res);
2487 Py_DECREF(res);
2488 }
2489 return ok;
2490 }
2491 return recursive_isinstance(inst, cls, Py_GetRecursionLimit());
Brett Cannon4f653312004-03-20 22:52:14 +00002492}
2493
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002494static int
Brett Cannon4f653312004-03-20 22:52:14 +00002495recursive_issubclass(PyObject *derived, PyObject *cls, int recursion_depth)
Guido van Rossum823649d2001-03-21 18:40:58 +00002496{
2497 int retval;
2498
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002499 {
Guido van Rossumf6c9ba82003-02-10 16:05:43 +00002500 if (!check_class(derived,
2501 "issubclass() arg 1 must be a class"))
Neil Schemenauer6b471292001-10-18 03:18:43 +00002502 return -1;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002503
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002504 if (PyTuple_Check(cls)) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00002505 Py_ssize_t i;
2506 Py_ssize_t n = PyTuple_GET_SIZE(cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002507
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002508 if (!recursion_depth) {
2509 PyErr_SetString(PyExc_RuntimeError,
2510 "nest level of tuple too deep");
2511 return -1;
2512 }
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002513 for (i = 0; i < n; ++i) {
Brett Cannon4f653312004-03-20 22:52:14 +00002514 retval = recursive_issubclass(
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002515 derived,
2516 PyTuple_GET_ITEM(cls, i),
2517 recursion_depth-1);
Guido van Rossumf6c9ba82003-02-10 16:05:43 +00002518 if (retval != 0) {
2519 /* either found it, or got an error */
Walter Dörwald7e5c6a02002-12-12 19:14:08 +00002520 return retval;
Guido van Rossumf6c9ba82003-02-10 16:05:43 +00002521 }
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002522 }
Walter Dörwald7e5c6a02002-12-12 19:14:08 +00002523 return 0;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002524 }
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002525 else {
2526 if (!check_class(cls,
2527 "issubclass() arg 2 must be a class"
2528 " or tuple of classes"))
2529 return -1;
2530 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002531
2532 retval = abstract_issubclass(derived, cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002533 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002534
2535 return retval;
2536}
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002537
Brett Cannon4f653312004-03-20 22:52:14 +00002538int
2539PyObject_IsSubclass(PyObject *derived, PyObject *cls)
2540{
Guido van Rossumadee45e2007-05-25 17:55:52 +00002541 PyObject *t, *v, *tb;
Guido van Rossume7ba4952007-06-06 23:52:48 +00002542 PyObject *checker;
Guido van Rossumadee45e2007-05-25 17:55:52 +00002543 PyErr_Fetch(&t, &v, &tb);
Guido van Rossume7ba4952007-06-06 23:52:48 +00002544 checker = PyObject_GetAttrString(cls, "__subclasscheck__");
Guido van Rossumadee45e2007-05-25 17:55:52 +00002545 PyErr_Restore(t, v, tb);
2546 if (checker != NULL) {
2547 PyObject *res;
2548 int ok = -1;
2549 if (Py_EnterRecursiveCall(" in __subclasscheck__"))
2550 return ok;
2551 res = PyObject_CallFunctionObjArgs(checker, derived, NULL);
2552 Py_LeaveRecursiveCall();
2553 Py_DECREF(checker);
2554 if (res != NULL) {
2555 ok = PyObject_IsTrue(res);
2556 Py_DECREF(res);
2557 }
2558 return ok;
2559 }
2560 return recursive_issubclass(derived, cls, Py_GetRecursionLimit());
Brett Cannon4f653312004-03-20 22:52:14 +00002561}
2562
2563
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002564PyObject *
2565PyObject_GetIter(PyObject *o)
2566{
2567 PyTypeObject *t = o->ob_type;
2568 getiterfunc f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00002569 f = t->tp_iter;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002570 if (f == NULL) {
2571 if (PySequence_Check(o))
Guido van Rossum213c7a62001-04-23 14:08:49 +00002572 return PySeqIter_New(o);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002573 return type_error("'%.200s' object is not iterable", o);
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002574 }
Guido van Rossum213c7a62001-04-23 14:08:49 +00002575 else {
2576 PyObject *res = (*f)(o);
2577 if (res != NULL && !PyIter_Check(res)) {
2578 PyErr_Format(PyExc_TypeError,
2579 "iter() returned non-iterator "
2580 "of type '%.100s'",
2581 res->ob_type->tp_name);
2582 Py_DECREF(res);
2583 res = NULL;
2584 }
2585 return res;
2586 }
2587}
2588
Tim Petersf4848da2001-05-05 00:14:56 +00002589/* Return next item.
2590 * If an error occurs, return NULL. PyErr_Occurred() will be true.
2591 * If the iteration terminates normally, return NULL and clear the
2592 * PyExc_StopIteration exception (if it was set). PyErr_Occurred()
2593 * will be false.
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002594 * Else return the next object. PyErr_Occurred() will be false.
Tim Petersf4848da2001-05-05 00:14:56 +00002595 */
Guido van Rossum213c7a62001-04-23 14:08:49 +00002596PyObject *
2597PyIter_Next(PyObject *iter)
2598{
Tim Petersf4848da2001-05-05 00:14:56 +00002599 PyObject *result;
Raymond Hettinger8049dde2003-03-01 01:44:32 +00002600 assert(PyIter_Check(iter));
Tim Petersf4848da2001-05-05 00:14:56 +00002601 result = (*iter->ob_type->tp_iternext)(iter);
2602 if (result == NULL &&
2603 PyErr_Occurred() &&
2604 PyErr_ExceptionMatches(PyExc_StopIteration))
2605 PyErr_Clear();
2606 return result;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002607}