blob: 6997fdccf702b2f5026c27f289709f2ec02162f1 [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);
Martin v. Löwis68192102007-07-21 06:55:02 +000046 Py_Type(en)->tp_free(en);
Guido van Rossum7dab2422002-04-26 19:40:56 +000047}
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 Hettinger6d121f12007-02-08 00:07:32 +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
Martin v. Löwis68192102007-07-21 06:55:02 +000071 next_item = (*Py_Type(it)->tp_iternext)(it);
Raymond Hettingere8b0f042003-05-28 14:05:34 +000072 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 = {
Martin v. Löwis68192102007-07-21 06:55:02 +0000108 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossum7dab2422002-04-26 19:40:56 +0000109 "enumerate", /* tp_name */
110 sizeof(enumobject), /* tp_basicsize */
111 0, /* tp_itemsize */
112 /* methods */
113 (destructor)enum_dealloc, /* tp_dealloc */
114 0, /* tp_print */
115 0, /* tp_getattr */
116 0, /* tp_setattr */
117 0, /* tp_compare */
118 0, /* tp_repr */
119 0, /* tp_as_number */
120 0, /* tp_as_sequence */
121 0, /* tp_as_mapping */
122 0, /* tp_hash */
123 0, /* tp_call */
124 0, /* tp_str */
125 PyObject_GenericGetAttr, /* tp_getattro */
126 0, /* tp_setattro */
127 0, /* tp_as_buffer */
128 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
129 Py_TPFLAGS_BASETYPE, /* tp_flags */
130 enum_doc, /* tp_doc */
131 (traverseproc)enum_traverse, /* tp_traverse */
132 0, /* tp_clear */
133 0, /* tp_richcompare */
134 0, /* tp_weaklistoffset */
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000135 PyObject_SelfIter, /* tp_iter */
Guido van Rossum7dab2422002-04-26 19:40:56 +0000136 (iternextfunc)enum_next, /* tp_iternext */
Guido van Rossumca5ed5b2002-07-16 21:02:42 +0000137 0, /* tp_methods */
Guido van Rossum7dab2422002-04-26 19:40:56 +0000138 0, /* tp_members */
139 0, /* tp_getset */
140 0, /* tp_base */
141 0, /* tp_dict */
142 0, /* tp_descr_get */
143 0, /* tp_descr_set */
144 0, /* tp_dictoffset */
145 0, /* tp_init */
146 PyType_GenericAlloc, /* tp_alloc */
147 enum_new, /* tp_new */
148 PyObject_GC_Del, /* tp_free */
149};
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000150
151/* Reversed Object ***************************************************************/
152
153typedef struct {
154 PyObject_HEAD
Martin v. Löwiseb079f12006-02-16 14:32:27 +0000155 Py_ssize_t index;
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000156 PyObject* seq;
157} reversedobject;
158
159static PyObject *
160reversed_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
161{
Martin v. Löwiseb079f12006-02-16 14:32:27 +0000162 Py_ssize_t n;
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000163 PyObject *seq;
164 reversedobject *ro;
165
166 if (!PyArg_UnpackTuple(args, "reversed", 1, 1, &seq))
167 return NULL;
168
Raymond Hettingerc058fd12004-02-07 02:45:22 +0000169 if (PyObject_HasAttrString(seq, "__reversed__"))
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000170 return PyObject_CallMethod(seq, "__reversed__", NULL);
171
172 if (!PySequence_Check(seq)) {
173 PyErr_SetString(PyExc_TypeError,
174 "argument to reversed() must be a sequence");
175 return NULL;
176 }
177
178 n = PySequence_Size(seq);
179 if (n == -1)
180 return NULL;
181
182 ro = (reversedobject *)type->tp_alloc(type, 0);
183 if (ro == NULL)
184 return NULL;
185
186 ro->index = n-1;
187 Py_INCREF(seq);
188 ro->seq = seq;
189 return (PyObject *)ro;
190}
191
192static void
193reversed_dealloc(reversedobject *ro)
194{
195 PyObject_GC_UnTrack(ro);
196 Py_XDECREF(ro->seq);
Martin v. Löwis68192102007-07-21 06:55:02 +0000197 Py_Type(ro)->tp_free(ro);
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000198}
199
200static int
201reversed_traverse(reversedobject *ro, visitproc visit, void *arg)
202{
Thomas Woutersc6e55062006-04-15 21:47:09 +0000203 Py_VISIT(ro->seq);
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000204 return 0;
205}
206
207static PyObject *
208reversed_next(reversedobject *ro)
209{
210 PyObject *item;
Martin v. Löwis725507b2006-03-07 12:08:51 +0000211 Py_ssize_t index = ro->index;
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000212
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000213 if (index >= 0) {
214 item = PySequence_GetItem(ro->seq, index);
215 if (item != NULL) {
216 ro->index--;
217 return item;
218 }
Raymond Hettinger7892b1c2004-04-12 18:10:01 +0000219 if (PyErr_ExceptionMatches(PyExc_IndexError) ||
220 PyErr_ExceptionMatches(PyExc_StopIteration))
221 PyErr_Clear();
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000222 }
223 ro->index = -1;
Raymond Hettinger75ccea32004-09-01 07:02:44 +0000224 Py_CLEAR(ro->seq);
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000225 return NULL;
Raymond Hettinger029dba52004-02-10 09:33:39 +0000226}
227
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000228PyDoc_STRVAR(reversed_doc,
Raymond Hettingerd2afee42004-08-25 19:42:12 +0000229"reversed(sequence) -> reverse iterator over values of the sequence\n"
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000230"\n"
231"Return a reverse iterator");
232
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000233static PyObject *
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000234reversed_len(reversedobject *ro)
235{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000236 Py_ssize_t position, seqsize;
Raymond Hettinger7892b1c2004-04-12 18:10:01 +0000237
238 if (ro->seq == NULL)
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000239 return PyInt_FromLong(0);
Raymond Hettinger7892b1c2004-04-12 18:10:01 +0000240 seqsize = PySequence_Size(ro->seq);
241 if (seqsize == -1)
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000242 return NULL;
Raymond Hettinger7892b1c2004-04-12 18:10:01 +0000243 position = ro->index + 1;
Martin v. Löwiseb079f12006-02-16 14:32:27 +0000244 return PyInt_FromSsize_t((seqsize < position) ? 0 : position);
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000245}
246
Armin Rigof5b3e362006-02-11 21:32:43 +0000247PyDoc_STRVAR(length_hint_doc, "Private method returning an estimate of len(list(it)).");
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000248
249static PyMethodDef reversediter_methods[] = {
Armin Rigof5b3e362006-02-11 21:32:43 +0000250 {"__length_hint__", (PyCFunction)reversed_len, METH_NOARGS, length_hint_doc},
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000251 {NULL, NULL} /* sentinel */
Raymond Hettinger06353f72004-02-08 10:49:42 +0000252};
253
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000254PyTypeObject PyReversed_Type = {
Martin v. Löwis68192102007-07-21 06:55:02 +0000255 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000256 "reversed", /* tp_name */
257 sizeof(reversedobject), /* tp_basicsize */
258 0, /* tp_itemsize */
259 /* methods */
260 (destructor)reversed_dealloc, /* tp_dealloc */
261 0, /* tp_print */
262 0, /* tp_getattr */
263 0, /* tp_setattr */
264 0, /* tp_compare */
265 0, /* tp_repr */
266 0, /* tp_as_number */
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000267 0, /* tp_as_sequence */
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000268 0, /* tp_as_mapping */
269 0, /* tp_hash */
270 0, /* tp_call */
271 0, /* tp_str */
272 PyObject_GenericGetAttr, /* tp_getattro */
273 0, /* tp_setattro */
274 0, /* tp_as_buffer */
275 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
276 Py_TPFLAGS_BASETYPE, /* tp_flags */
277 reversed_doc, /* tp_doc */
278 (traverseproc)reversed_traverse,/* tp_traverse */
279 0, /* tp_clear */
280 0, /* tp_richcompare */
281 0, /* tp_weaklistoffset */
282 PyObject_SelfIter, /* tp_iter */
283 (iternextfunc)reversed_next, /* tp_iternext */
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000284 reversediter_methods, /* tp_methods */
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000285 0, /* tp_members */
286 0, /* tp_getset */
287 0, /* tp_base */
288 0, /* tp_dict */
289 0, /* tp_descr_get */
290 0, /* tp_descr_set */
291 0, /* tp_dictoffset */
292 0, /* tp_init */
293 PyType_GenericAlloc, /* tp_alloc */
294 reversed_new, /* tp_new */
295 PyObject_GC_Del, /* tp_free */
296};