blob: a8f43e07386b8464c4fe0f7b5ee9bfe75b2da056 [file] [log] [blame]
Guido van Rossum7dab2422002-04-26 19:40:56 +00001/* enumerate object */
2
3#include "Python.h"
4
5typedef struct {
6 PyObject_HEAD
7 long en_index; /* current index of enumeration */
8 PyObject* en_sit; /* secondary iterator of enumeration */
Raymond Hettingere8b0f042003-05-28 14:05:34 +00009 PyObject* en_result; /* result tuple */
Guido van Rossum7dab2422002-04-26 19:40:56 +000010} enumobject;
11
Guido van Rossum7dab2422002-04-26 19:40:56 +000012static PyObject *
13enum_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
14{
15 enumobject *en;
16 PyObject *seq = NULL;
Martin v. Löwis15e62742006-02-27 16:46:16 +000017 static char *kwlist[] = {"sequence", 0};
Guido van Rossum7dab2422002-04-26 19:40:56 +000018
19 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O:enumerate", kwlist,
20 &seq))
21 return NULL;
22
23 en = (enumobject *)type->tp_alloc(type, 0);
24 if (en == NULL)
25 return NULL;
26 en->en_index = 0;
27 en->en_sit = PyObject_GetIter(seq);
28 if (en->en_sit == NULL) {
29 Py_DECREF(en);
30 return NULL;
31 }
Raymond Hettinger54a831b2003-11-02 05:37:44 +000032 en->en_result = PyTuple_Pack(2, Py_None, Py_None);
Raymond Hettingere8b0f042003-05-28 14:05:34 +000033 if (en->en_result == NULL) {
Raymond Hettingere8b0f042003-05-28 14:05:34 +000034 Py_DECREF(en);
35 return NULL;
36 }
Guido van Rossum7dab2422002-04-26 19:40:56 +000037 return (PyObject *)en;
38}
39
40static void
41enum_dealloc(enumobject *en)
42{
43 PyObject_GC_UnTrack(en);
44 Py_XDECREF(en->en_sit);
Raymond Hettingere8b0f042003-05-28 14:05:34 +000045 Py_XDECREF(en->en_result);
Guido van Rossum7dab2422002-04-26 19:40:56 +000046 en->ob_type->tp_free(en);
47}
48
49static int
50enum_traverse(enumobject *en, visitproc visit, void *arg)
51{
Thomas Woutersc6e55062006-04-15 21:47:09 +000052 Py_VISIT(en->en_sit);
53 Py_VISIT(en->en_result);
Guido van Rossum7dab2422002-04-26 19:40:56 +000054 return 0;
55}
56
57static PyObject *
58enum_next(enumobject *en)
59{
Guido van Rossum7dab2422002-04-26 19:40:56 +000060 PyObject *next_index;
Guido van Rossumca5ed5b2002-07-16 21:02:42 +000061 PyObject *next_item;
Raymond Hettingere8b0f042003-05-28 14:05:34 +000062 PyObject *result = en->en_result;
63 PyObject *it = en->en_sit;
Guido van Rossum7dab2422002-04-26 19:40:56 +000064
Raymond Hettingere8b0f042003-05-28 14:05:34 +000065 next_item = (*it->ob_type->tp_iternext)(it);
66 if (next_item == NULL)
Guido van Rossumca5ed5b2002-07-16 21:02:42 +000067 return NULL;
68
69 next_index = PyInt_FromLong(en->en_index);
70 if (next_index == NULL) {
Raymond Hettingere8b0f042003-05-28 14:05:34 +000071 Py_DECREF(next_item);
Guido van Rossum7dab2422002-04-26 19:40:56 +000072 return NULL;
73 }
Raymond Hettingere8b0f042003-05-28 14:05:34 +000074 en->en_index++;
75
76 if (result->ob_refcnt == 1) {
77 Py_INCREF(result);
78 Py_DECREF(PyTuple_GET_ITEM(result, 0));
79 Py_DECREF(PyTuple_GET_ITEM(result, 1));
80 } else {
81 result = PyTuple_New(2);
82 if (result == NULL) {
83 Py_DECREF(next_index);
84 Py_DECREF(next_item);
85 return NULL;
86 }
87 }
Guido van Rossumca5ed5b2002-07-16 21:02:42 +000088 PyTuple_SET_ITEM(result, 0, next_index);
Guido van Rossum7dab2422002-04-26 19:40:56 +000089 PyTuple_SET_ITEM(result, 1, next_item);
90 return result;
91}
92
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000093PyDoc_STRVAR(enum_doc,
Jeremy Hyltonfbbe3472003-04-21 20:26:25 +000094"enumerate(iterable) -> iterator for index, value of iterable\n"
95"\n"
96"Return an enumerate object. iterable must be an other object that supports\n"
97"iteration. The enumerate object yields pairs containing a count (from\n"
98"zero) and a value yielded by the iterable argument. enumerate is useful\n"
99"for obtaining an indexed list: (0, seq[0]), (1, seq[1]), (2, seq[2]), ...");
Guido van Rossum7dab2422002-04-26 19:40:56 +0000100
101PyTypeObject PyEnum_Type = {
102 PyObject_HEAD_INIT(&PyType_Type)
103 0, /* ob_size */
104 "enumerate", /* tp_name */
105 sizeof(enumobject), /* tp_basicsize */
106 0, /* tp_itemsize */
107 /* methods */
108 (destructor)enum_dealloc, /* tp_dealloc */
109 0, /* tp_print */
110 0, /* tp_getattr */
111 0, /* tp_setattr */
112 0, /* tp_compare */
113 0, /* tp_repr */
114 0, /* tp_as_number */
115 0, /* tp_as_sequence */
116 0, /* tp_as_mapping */
117 0, /* tp_hash */
118 0, /* tp_call */
119 0, /* tp_str */
120 PyObject_GenericGetAttr, /* tp_getattro */
121 0, /* tp_setattro */
122 0, /* tp_as_buffer */
123 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
124 Py_TPFLAGS_BASETYPE, /* tp_flags */
125 enum_doc, /* tp_doc */
126 (traverseproc)enum_traverse, /* tp_traverse */
127 0, /* tp_clear */
128 0, /* tp_richcompare */
129 0, /* tp_weaklistoffset */
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000130 PyObject_SelfIter, /* tp_iter */
Guido van Rossum7dab2422002-04-26 19:40:56 +0000131 (iternextfunc)enum_next, /* tp_iternext */
Guido van Rossumca5ed5b2002-07-16 21:02:42 +0000132 0, /* tp_methods */
Guido van Rossum7dab2422002-04-26 19:40:56 +0000133 0, /* tp_members */
134 0, /* tp_getset */
135 0, /* tp_base */
136 0, /* tp_dict */
137 0, /* tp_descr_get */
138 0, /* tp_descr_set */
139 0, /* tp_dictoffset */
140 0, /* tp_init */
141 PyType_GenericAlloc, /* tp_alloc */
142 enum_new, /* tp_new */
143 PyObject_GC_Del, /* tp_free */
144};
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000145
146/* Reversed Object ***************************************************************/
147
148typedef struct {
149 PyObject_HEAD
Martin v. Löwiseb079f12006-02-16 14:32:27 +0000150 Py_ssize_t index;
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000151 PyObject* seq;
152} reversedobject;
153
154static PyObject *
155reversed_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
156{
Martin v. Löwiseb079f12006-02-16 14:32:27 +0000157 Py_ssize_t n;
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000158 PyObject *seq;
159 reversedobject *ro;
160
161 if (!PyArg_UnpackTuple(args, "reversed", 1, 1, &seq))
162 return NULL;
163
Raymond Hettingerc058fd12004-02-07 02:45:22 +0000164 if (PyObject_HasAttrString(seq, "__reversed__"))
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000165 return PyObject_CallMethod(seq, "__reversed__", NULL);
166
167 if (!PySequence_Check(seq)) {
168 PyErr_SetString(PyExc_TypeError,
169 "argument to reversed() must be a sequence");
170 return NULL;
171 }
172
173 n = PySequence_Size(seq);
174 if (n == -1)
175 return NULL;
176
177 ro = (reversedobject *)type->tp_alloc(type, 0);
178 if (ro == NULL)
179 return NULL;
180
181 ro->index = n-1;
182 Py_INCREF(seq);
183 ro->seq = seq;
184 return (PyObject *)ro;
185}
186
187static void
188reversed_dealloc(reversedobject *ro)
189{
190 PyObject_GC_UnTrack(ro);
191 Py_XDECREF(ro->seq);
192 ro->ob_type->tp_free(ro);
193}
194
195static int
196reversed_traverse(reversedobject *ro, visitproc visit, void *arg)
197{
Thomas Woutersc6e55062006-04-15 21:47:09 +0000198 Py_VISIT(ro->seq);
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000199 return 0;
200}
201
202static PyObject *
203reversed_next(reversedobject *ro)
204{
205 PyObject *item;
Martin v. Löwis725507b2006-03-07 12:08:51 +0000206 Py_ssize_t index = ro->index;
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000207
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000208 if (index >= 0) {
209 item = PySequence_GetItem(ro->seq, index);
210 if (item != NULL) {
211 ro->index--;
212 return item;
213 }
Raymond Hettinger7892b1c2004-04-12 18:10:01 +0000214 if (PyErr_ExceptionMatches(PyExc_IndexError) ||
215 PyErr_ExceptionMatches(PyExc_StopIteration))
216 PyErr_Clear();
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000217 }
218 ro->index = -1;
Raymond Hettinger75ccea32004-09-01 07:02:44 +0000219 Py_CLEAR(ro->seq);
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000220 return NULL;
Raymond Hettinger029dba52004-02-10 09:33:39 +0000221}
222
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000223PyDoc_STRVAR(reversed_doc,
Raymond Hettingerd2afee42004-08-25 19:42:12 +0000224"reversed(sequence) -> reverse iterator over values of the sequence\n"
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000225"\n"
226"Return a reverse iterator");
227
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000228static PyObject *
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000229reversed_len(reversedobject *ro)
230{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000231 Py_ssize_t position, seqsize;
Raymond Hettinger7892b1c2004-04-12 18:10:01 +0000232
233 if (ro->seq == NULL)
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000234 return PyInt_FromLong(0);
Raymond Hettinger7892b1c2004-04-12 18:10:01 +0000235 seqsize = PySequence_Size(ro->seq);
236 if (seqsize == -1)
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000237 return NULL;
Raymond Hettinger7892b1c2004-04-12 18:10:01 +0000238 position = ro->index + 1;
Martin v. Löwiseb079f12006-02-16 14:32:27 +0000239 return PyInt_FromSsize_t((seqsize < position) ? 0 : position);
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000240}
241
Armin Rigof5b3e362006-02-11 21:32:43 +0000242PyDoc_STRVAR(length_hint_doc, "Private method returning an estimate of len(list(it)).");
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000243
244static PyMethodDef reversediter_methods[] = {
Armin Rigof5b3e362006-02-11 21:32:43 +0000245 {"__length_hint__", (PyCFunction)reversed_len, METH_NOARGS, length_hint_doc},
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000246 {NULL, NULL} /* sentinel */
Raymond Hettinger06353f72004-02-08 10:49:42 +0000247};
248
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000249PyTypeObject PyReversed_Type = {
250 PyObject_HEAD_INIT(&PyType_Type)
251 0, /* ob_size */
252 "reversed", /* tp_name */
253 sizeof(reversedobject), /* tp_basicsize */
254 0, /* tp_itemsize */
255 /* methods */
256 (destructor)reversed_dealloc, /* tp_dealloc */
257 0, /* tp_print */
258 0, /* tp_getattr */
259 0, /* tp_setattr */
260 0, /* tp_compare */
261 0, /* tp_repr */
262 0, /* tp_as_number */
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000263 0, /* tp_as_sequence */
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000264 0, /* tp_as_mapping */
265 0, /* tp_hash */
266 0, /* tp_call */
267 0, /* tp_str */
268 PyObject_GenericGetAttr, /* tp_getattro */
269 0, /* tp_setattro */
270 0, /* tp_as_buffer */
271 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
272 Py_TPFLAGS_BASETYPE, /* tp_flags */
273 reversed_doc, /* tp_doc */
274 (traverseproc)reversed_traverse,/* tp_traverse */
275 0, /* tp_clear */
276 0, /* tp_richcompare */
277 0, /* tp_weaklistoffset */
278 PyObject_SelfIter, /* tp_iter */
279 (iternextfunc)reversed_next, /* tp_iternext */
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000280 reversediter_methods, /* tp_methods */
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000281 0, /* tp_members */
282 0, /* tp_getset */
283 0, /* tp_base */
284 0, /* tp_dict */
285 0, /* tp_descr_get */
286 0, /* tp_descr_set */
287 0, /* tp_dictoffset */
288 0, /* tp_init */
289 PyType_GenericAlloc, /* tp_alloc */
290 reversed_new, /* tp_new */
291 PyObject_GC_Del, /* tp_free */
292};