blob: a456c9dafd704e436b2943a8ab44e4f9f9ef5755 [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 Hettinger9f0e1ea2007-02-07 23:57:05 +000065 if (en->en_index == LONG_MAX) {
66 PyErr_SetString(PyExc_OverflowError,
67 "enumerate() is limited to LONG_MAX items");
68 return NULL;
69 }
70
Raymond Hettingere8b0f042003-05-28 14:05:34 +000071 next_item = (*it->ob_type->tp_iternext)(it);
72 if (next_item == NULL)
Guido van Rossumca5ed5b2002-07-16 21:02:42 +000073 return NULL;
74
75 next_index = PyInt_FromLong(en->en_index);
76 if (next_index == NULL) {
Raymond Hettingere8b0f042003-05-28 14:05:34 +000077 Py_DECREF(next_item);
Guido van Rossum7dab2422002-04-26 19:40:56 +000078 return NULL;
79 }
Raymond Hettingere8b0f042003-05-28 14:05:34 +000080 en->en_index++;
81
82 if (result->ob_refcnt == 1) {
83 Py_INCREF(result);
84 Py_DECREF(PyTuple_GET_ITEM(result, 0));
85 Py_DECREF(PyTuple_GET_ITEM(result, 1));
86 } else {
87 result = PyTuple_New(2);
88 if (result == NULL) {
89 Py_DECREF(next_index);
90 Py_DECREF(next_item);
91 return NULL;
92 }
93 }
Guido van Rossumca5ed5b2002-07-16 21:02:42 +000094 PyTuple_SET_ITEM(result, 0, next_index);
Guido van Rossum7dab2422002-04-26 19:40:56 +000095 PyTuple_SET_ITEM(result, 1, next_item);
96 return result;
97}
98
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000099PyDoc_STRVAR(enum_doc,
Jeremy Hyltonfbbe3472003-04-21 20:26:25 +0000100"enumerate(iterable) -> iterator for index, value of iterable\n"
101"\n"
102"Return an enumerate object. iterable must be an other object that supports\n"
103"iteration. The enumerate object yields pairs containing a count (from\n"
104"zero) and a value yielded by the iterable argument. enumerate is useful\n"
105"for obtaining an indexed list: (0, seq[0]), (1, seq[1]), (2, seq[2]), ...");
Guido van Rossum7dab2422002-04-26 19:40:56 +0000106
107PyTypeObject PyEnum_Type = {
108 PyObject_HEAD_INIT(&PyType_Type)
109 0, /* ob_size */
110 "enumerate", /* tp_name */
111 sizeof(enumobject), /* tp_basicsize */
112 0, /* tp_itemsize */
113 /* methods */
114 (destructor)enum_dealloc, /* tp_dealloc */
115 0, /* tp_print */
116 0, /* tp_getattr */
117 0, /* tp_setattr */
118 0, /* tp_compare */
119 0, /* tp_repr */
120 0, /* tp_as_number */
121 0, /* tp_as_sequence */
122 0, /* tp_as_mapping */
123 0, /* tp_hash */
124 0, /* tp_call */
125 0, /* tp_str */
126 PyObject_GenericGetAttr, /* tp_getattro */
127 0, /* tp_setattro */
128 0, /* tp_as_buffer */
129 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
130 Py_TPFLAGS_BASETYPE, /* tp_flags */
131 enum_doc, /* tp_doc */
132 (traverseproc)enum_traverse, /* tp_traverse */
133 0, /* tp_clear */
134 0, /* tp_richcompare */
135 0, /* tp_weaklistoffset */
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000136 PyObject_SelfIter, /* tp_iter */
Guido van Rossum7dab2422002-04-26 19:40:56 +0000137 (iternextfunc)enum_next, /* tp_iternext */
Guido van Rossumca5ed5b2002-07-16 21:02:42 +0000138 0, /* tp_methods */
Guido van Rossum7dab2422002-04-26 19:40:56 +0000139 0, /* tp_members */
140 0, /* tp_getset */
141 0, /* tp_base */
142 0, /* tp_dict */
143 0, /* tp_descr_get */
144 0, /* tp_descr_set */
145 0, /* tp_dictoffset */
146 0, /* tp_init */
147 PyType_GenericAlloc, /* tp_alloc */
148 enum_new, /* tp_new */
149 PyObject_GC_Del, /* tp_free */
150};
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000151
152/* Reversed Object ***************************************************************/
153
154typedef struct {
155 PyObject_HEAD
Martin v. Löwiseb079f12006-02-16 14:32:27 +0000156 Py_ssize_t index;
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000157 PyObject* seq;
158} reversedobject;
159
160static PyObject *
161reversed_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
162{
Martin v. Löwiseb079f12006-02-16 14:32:27 +0000163 Py_ssize_t n;
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000164 PyObject *seq;
165 reversedobject *ro;
166
167 if (!PyArg_UnpackTuple(args, "reversed", 1, 1, &seq))
168 return NULL;
169
Raymond Hettingerc058fd12004-02-07 02:45:22 +0000170 if (PyObject_HasAttrString(seq, "__reversed__"))
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000171 return PyObject_CallMethod(seq, "__reversed__", NULL);
172
173 if (!PySequence_Check(seq)) {
174 PyErr_SetString(PyExc_TypeError,
175 "argument to reversed() must be a sequence");
176 return NULL;
177 }
178
179 n = PySequence_Size(seq);
180 if (n == -1)
181 return NULL;
182
183 ro = (reversedobject *)type->tp_alloc(type, 0);
184 if (ro == NULL)
185 return NULL;
186
187 ro->index = n-1;
188 Py_INCREF(seq);
189 ro->seq = seq;
190 return (PyObject *)ro;
191}
192
193static void
194reversed_dealloc(reversedobject *ro)
195{
196 PyObject_GC_UnTrack(ro);
197 Py_XDECREF(ro->seq);
198 ro->ob_type->tp_free(ro);
199}
200
201static int
202reversed_traverse(reversedobject *ro, visitproc visit, void *arg)
203{
Thomas Woutersc6e55062006-04-15 21:47:09 +0000204 Py_VISIT(ro->seq);
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000205 return 0;
206}
207
208static PyObject *
209reversed_next(reversedobject *ro)
210{
211 PyObject *item;
Martin v. Löwis725507b2006-03-07 12:08:51 +0000212 Py_ssize_t index = ro->index;
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000213
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000214 if (index >= 0) {
215 item = PySequence_GetItem(ro->seq, index);
216 if (item != NULL) {
217 ro->index--;
218 return item;
219 }
Raymond Hettinger7892b1c2004-04-12 18:10:01 +0000220 if (PyErr_ExceptionMatches(PyExc_IndexError) ||
221 PyErr_ExceptionMatches(PyExc_StopIteration))
222 PyErr_Clear();
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000223 }
224 ro->index = -1;
Raymond Hettinger75ccea32004-09-01 07:02:44 +0000225 Py_CLEAR(ro->seq);
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000226 return NULL;
Raymond Hettinger029dba52004-02-10 09:33:39 +0000227}
228
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000229PyDoc_STRVAR(reversed_doc,
Raymond Hettingerd2afee42004-08-25 19:42:12 +0000230"reversed(sequence) -> reverse iterator over values of the sequence\n"
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000231"\n"
232"Return a reverse iterator");
233
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000234static PyObject *
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000235reversed_len(reversedobject *ro)
236{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000237 Py_ssize_t position, seqsize;
Raymond Hettinger7892b1c2004-04-12 18:10:01 +0000238
239 if (ro->seq == NULL)
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000240 return PyInt_FromLong(0);
Raymond Hettinger7892b1c2004-04-12 18:10:01 +0000241 seqsize = PySequence_Size(ro->seq);
242 if (seqsize == -1)
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000243 return NULL;
Raymond Hettinger7892b1c2004-04-12 18:10:01 +0000244 position = ro->index + 1;
Martin v. Löwiseb079f12006-02-16 14:32:27 +0000245 return PyInt_FromSsize_t((seqsize < position) ? 0 : position);
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000246}
247
Armin Rigof5b3e362006-02-11 21:32:43 +0000248PyDoc_STRVAR(length_hint_doc, "Private method returning an estimate of len(list(it)).");
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000249
250static PyMethodDef reversediter_methods[] = {
Armin Rigof5b3e362006-02-11 21:32:43 +0000251 {"__length_hint__", (PyCFunction)reversed_len, METH_NOARGS, length_hint_doc},
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000252 {NULL, NULL} /* sentinel */
Raymond Hettinger06353f72004-02-08 10:49:42 +0000253};
254
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000255PyTypeObject PyReversed_Type = {
256 PyObject_HEAD_INIT(&PyType_Type)
257 0, /* ob_size */
258 "reversed", /* tp_name */
259 sizeof(reversedobject), /* tp_basicsize */
260 0, /* tp_itemsize */
261 /* methods */
262 (destructor)reversed_dealloc, /* tp_dealloc */
263 0, /* tp_print */
264 0, /* tp_getattr */
265 0, /* tp_setattr */
266 0, /* tp_compare */
267 0, /* tp_repr */
268 0, /* tp_as_number */
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000269 0, /* tp_as_sequence */
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000270 0, /* tp_as_mapping */
271 0, /* tp_hash */
272 0, /* tp_call */
273 0, /* tp_str */
274 PyObject_GenericGetAttr, /* tp_getattro */
275 0, /* tp_setattro */
276 0, /* tp_as_buffer */
277 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
278 Py_TPFLAGS_BASETYPE, /* tp_flags */
279 reversed_doc, /* tp_doc */
280 (traverseproc)reversed_traverse,/* tp_traverse */
281 0, /* tp_clear */
282 0, /* tp_richcompare */
283 0, /* tp_weaklistoffset */
284 PyObject_SelfIter, /* tp_iter */
285 (iternextfunc)reversed_next, /* tp_iternext */
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000286 reversediter_methods, /* tp_methods */
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000287 0, /* tp_members */
288 0, /* tp_getset */
289 0, /* tp_base */
290 0, /* tp_dict */
291 0, /* tp_descr_get */
292 0, /* tp_descr_set */
293 0, /* tp_dictoffset */
294 0, /* tp_init */
295 PyType_GenericAlloc, /* tp_alloc */
296 reversed_new, /* tp_new */
297 PyObject_GC_Del, /* tp_free */
298};