blob: cd31dc15d5725d1ed4f634c30a9876405bcc04b4 [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{
Raymond Hettingere8b0f042003-05-28 14:05:34 +000052 int err;
53
54 if (en->en_sit) {
55 err = visit(en->en_sit, arg);
56 if (err)
57 return err;
58 }
59 if (en->en_result) {
60 err = visit(en->en_result, arg);
61 if (err)
62 return err;
63 }
Guido van Rossum7dab2422002-04-26 19:40:56 +000064 return 0;
65}
66
67static PyObject *
68enum_next(enumobject *en)
69{
Guido van Rossum7dab2422002-04-26 19:40:56 +000070 PyObject *next_index;
Guido van Rossumca5ed5b2002-07-16 21:02:42 +000071 PyObject *next_item;
Raymond Hettingere8b0f042003-05-28 14:05:34 +000072 PyObject *result = en->en_result;
73 PyObject *it = en->en_sit;
Guido van Rossum7dab2422002-04-26 19:40:56 +000074
Raymond Hettingere8b0f042003-05-28 14:05:34 +000075 next_item = (*it->ob_type->tp_iternext)(it);
76 if (next_item == NULL)
Guido van Rossumca5ed5b2002-07-16 21:02:42 +000077 return NULL;
78
79 next_index = PyInt_FromLong(en->en_index);
80 if (next_index == NULL) {
Raymond Hettingere8b0f042003-05-28 14:05:34 +000081 Py_DECREF(next_item);
Guido van Rossum7dab2422002-04-26 19:40:56 +000082 return NULL;
83 }
Raymond Hettingere8b0f042003-05-28 14:05:34 +000084 en->en_index++;
85
86 if (result->ob_refcnt == 1) {
87 Py_INCREF(result);
88 Py_DECREF(PyTuple_GET_ITEM(result, 0));
89 Py_DECREF(PyTuple_GET_ITEM(result, 1));
90 } else {
91 result = PyTuple_New(2);
92 if (result == NULL) {
93 Py_DECREF(next_index);
94 Py_DECREF(next_item);
95 return NULL;
96 }
97 }
Guido van Rossumca5ed5b2002-07-16 21:02:42 +000098 PyTuple_SET_ITEM(result, 0, next_index);
Guido van Rossum7dab2422002-04-26 19:40:56 +000099 PyTuple_SET_ITEM(result, 1, next_item);
100 return result;
101}
102
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000103PyDoc_STRVAR(enum_doc,
Jeremy Hyltonfbbe3472003-04-21 20:26:25 +0000104"enumerate(iterable) -> iterator for index, value of iterable\n"
105"\n"
106"Return an enumerate object. iterable must be an other object that supports\n"
107"iteration. The enumerate object yields pairs containing a count (from\n"
108"zero) and a value yielded by the iterable argument. enumerate is useful\n"
109"for obtaining an indexed list: (0, seq[0]), (1, seq[1]), (2, seq[2]), ...");
Guido van Rossum7dab2422002-04-26 19:40:56 +0000110
111PyTypeObject PyEnum_Type = {
112 PyObject_HEAD_INIT(&PyType_Type)
113 0, /* ob_size */
114 "enumerate", /* tp_name */
115 sizeof(enumobject), /* tp_basicsize */
116 0, /* tp_itemsize */
117 /* methods */
118 (destructor)enum_dealloc, /* tp_dealloc */
119 0, /* tp_print */
120 0, /* tp_getattr */
121 0, /* tp_setattr */
122 0, /* tp_compare */
123 0, /* tp_repr */
124 0, /* tp_as_number */
125 0, /* tp_as_sequence */
126 0, /* tp_as_mapping */
127 0, /* tp_hash */
128 0, /* tp_call */
129 0, /* tp_str */
130 PyObject_GenericGetAttr, /* tp_getattro */
131 0, /* tp_setattro */
132 0, /* tp_as_buffer */
133 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
134 Py_TPFLAGS_BASETYPE, /* tp_flags */
135 enum_doc, /* tp_doc */
136 (traverseproc)enum_traverse, /* tp_traverse */
137 0, /* tp_clear */
138 0, /* tp_richcompare */
139 0, /* tp_weaklistoffset */
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000140 PyObject_SelfIter, /* tp_iter */
Guido van Rossum7dab2422002-04-26 19:40:56 +0000141 (iternextfunc)enum_next, /* tp_iternext */
Guido van Rossumca5ed5b2002-07-16 21:02:42 +0000142 0, /* tp_methods */
Guido van Rossum7dab2422002-04-26 19:40:56 +0000143 0, /* tp_members */
144 0, /* tp_getset */
145 0, /* tp_base */
146 0, /* tp_dict */
147 0, /* tp_descr_get */
148 0, /* tp_descr_set */
149 0, /* tp_dictoffset */
150 0, /* tp_init */
151 PyType_GenericAlloc, /* tp_alloc */
152 enum_new, /* tp_new */
153 PyObject_GC_Del, /* tp_free */
154};
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000155
156/* Reversed Object ***************************************************************/
157
158typedef struct {
159 PyObject_HEAD
Martin v. Löwiseb079f12006-02-16 14:32:27 +0000160 Py_ssize_t index;
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000161 PyObject* seq;
162} reversedobject;
163
164static PyObject *
165reversed_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
166{
Martin v. Löwiseb079f12006-02-16 14:32:27 +0000167 Py_ssize_t n;
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000168 PyObject *seq;
169 reversedobject *ro;
170
171 if (!PyArg_UnpackTuple(args, "reversed", 1, 1, &seq))
172 return NULL;
173
Raymond Hettingerc058fd12004-02-07 02:45:22 +0000174 if (PyObject_HasAttrString(seq, "__reversed__"))
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000175 return PyObject_CallMethod(seq, "__reversed__", NULL);
176
177 if (!PySequence_Check(seq)) {
178 PyErr_SetString(PyExc_TypeError,
179 "argument to reversed() must be a sequence");
180 return NULL;
181 }
182
183 n = PySequence_Size(seq);
184 if (n == -1)
185 return NULL;
186
187 ro = (reversedobject *)type->tp_alloc(type, 0);
188 if (ro == NULL)
189 return NULL;
190
191 ro->index = n-1;
192 Py_INCREF(seq);
193 ro->seq = seq;
194 return (PyObject *)ro;
195}
196
197static void
198reversed_dealloc(reversedobject *ro)
199{
200 PyObject_GC_UnTrack(ro);
201 Py_XDECREF(ro->seq);
202 ro->ob_type->tp_free(ro);
203}
204
205static int
206reversed_traverse(reversedobject *ro, visitproc visit, void *arg)
207{
208 if (ro->seq)
209 return visit((PyObject *)(ro->seq), arg);
210 return 0;
211}
212
213static PyObject *
214reversed_next(reversedobject *ro)
215{
216 PyObject *item;
Martin v. Löwis725507b2006-03-07 12:08:51 +0000217 Py_ssize_t index = ro->index;
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000218
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000219 if (index >= 0) {
220 item = PySequence_GetItem(ro->seq, index);
221 if (item != NULL) {
222 ro->index--;
223 return item;
224 }
Raymond Hettinger7892b1c2004-04-12 18:10:01 +0000225 if (PyErr_ExceptionMatches(PyExc_IndexError) ||
226 PyErr_ExceptionMatches(PyExc_StopIteration))
227 PyErr_Clear();
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000228 }
229 ro->index = -1;
Raymond Hettinger75ccea32004-09-01 07:02:44 +0000230 Py_CLEAR(ro->seq);
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000231 return NULL;
Raymond Hettinger029dba52004-02-10 09:33:39 +0000232}
233
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000234PyDoc_STRVAR(reversed_doc,
Raymond Hettingerd2afee42004-08-25 19:42:12 +0000235"reversed(sequence) -> reverse iterator over values of the sequence\n"
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000236"\n"
237"Return a reverse iterator");
238
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000239static PyObject *
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000240reversed_len(reversedobject *ro)
241{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000242 Py_ssize_t position, seqsize;
Raymond Hettinger7892b1c2004-04-12 18:10:01 +0000243
244 if (ro->seq == NULL)
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000245 return PyInt_FromLong(0);
Raymond Hettinger7892b1c2004-04-12 18:10:01 +0000246 seqsize = PySequence_Size(ro->seq);
247 if (seqsize == -1)
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000248 return NULL;
Raymond Hettinger7892b1c2004-04-12 18:10:01 +0000249 position = ro->index + 1;
Martin v. Löwiseb079f12006-02-16 14:32:27 +0000250 return PyInt_FromSsize_t((seqsize < position) ? 0 : position);
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000251}
252
Armin Rigof5b3e362006-02-11 21:32:43 +0000253PyDoc_STRVAR(length_hint_doc, "Private method returning an estimate of len(list(it)).");
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000254
255static PyMethodDef reversediter_methods[] = {
Armin Rigof5b3e362006-02-11 21:32:43 +0000256 {"__length_hint__", (PyCFunction)reversed_len, METH_NOARGS, length_hint_doc},
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000257 {NULL, NULL} /* sentinel */
Raymond Hettinger06353f72004-02-08 10:49:42 +0000258};
259
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000260PyTypeObject PyReversed_Type = {
261 PyObject_HEAD_INIT(&PyType_Type)
262 0, /* ob_size */
263 "reversed", /* tp_name */
264 sizeof(reversedobject), /* tp_basicsize */
265 0, /* tp_itemsize */
266 /* methods */
267 (destructor)reversed_dealloc, /* tp_dealloc */
268 0, /* tp_print */
269 0, /* tp_getattr */
270 0, /* tp_setattr */
271 0, /* tp_compare */
272 0, /* tp_repr */
273 0, /* tp_as_number */
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000274 0, /* tp_as_sequence */
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000275 0, /* tp_as_mapping */
276 0, /* tp_hash */
277 0, /* tp_call */
278 0, /* tp_str */
279 PyObject_GenericGetAttr, /* tp_getattro */
280 0, /* tp_setattro */
281 0, /* tp_as_buffer */
282 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
283 Py_TPFLAGS_BASETYPE, /* tp_flags */
284 reversed_doc, /* tp_doc */
285 (traverseproc)reversed_traverse,/* tp_traverse */
286 0, /* tp_clear */
287 0, /* tp_richcompare */
288 0, /* tp_weaklistoffset */
289 PyObject_SelfIter, /* tp_iter */
290 (iternextfunc)reversed_next, /* tp_iternext */
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000291 reversediter_methods, /* tp_methods */
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000292 0, /* tp_members */
293 0, /* tp_getset */
294 0, /* tp_base */
295 0, /* tp_dict */
296 0, /* tp_descr_get */
297 0, /* tp_descr_set */
298 0, /* tp_dictoffset */
299 0, /* tp_init */
300 PyType_GenericAlloc, /* tp_alloc */
301 reversed_new, /* tp_new */
302 PyObject_GC_Del, /* tp_free */
303};