blob: f74acdcddc986235a3f8002bc9b9fa708142175a [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
12PyTypeObject PyEnum_Type;
13
14static PyObject *
15enum_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
16{
17 enumobject *en;
18 PyObject *seq = NULL;
19 static char *kwlist[] = {"sequence", 0};
20
21 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O:enumerate", kwlist,
22 &seq))
23 return NULL;
24
25 en = (enumobject *)type->tp_alloc(type, 0);
26 if (en == NULL)
27 return NULL;
28 en->en_index = 0;
29 en->en_sit = PyObject_GetIter(seq);
30 if (en->en_sit == NULL) {
31 Py_DECREF(en);
32 return NULL;
33 }
Raymond Hettinger54a831b2003-11-02 05:37:44 +000034 en->en_result = PyTuple_Pack(2, Py_None, Py_None);
Raymond Hettingere8b0f042003-05-28 14:05:34 +000035 if (en->en_result == NULL) {
36 Py_DECREF(en->en_sit);
37 Py_DECREF(en);
38 return NULL;
39 }
Guido van Rossum7dab2422002-04-26 19:40:56 +000040 return (PyObject *)en;
41}
42
43static void
44enum_dealloc(enumobject *en)
45{
46 PyObject_GC_UnTrack(en);
47 Py_XDECREF(en->en_sit);
Raymond Hettingere8b0f042003-05-28 14:05:34 +000048 Py_XDECREF(en->en_result);
Guido van Rossum7dab2422002-04-26 19:40:56 +000049 en->ob_type->tp_free(en);
50}
51
52static int
53enum_traverse(enumobject *en, visitproc visit, void *arg)
54{
Raymond Hettingere8b0f042003-05-28 14:05:34 +000055 int err;
56
57 if (en->en_sit) {
58 err = visit(en->en_sit, arg);
59 if (err)
60 return err;
61 }
62 if (en->en_result) {
63 err = visit(en->en_result, arg);
64 if (err)
65 return err;
66 }
Guido van Rossum7dab2422002-04-26 19:40:56 +000067 return 0;
68}
69
70static PyObject *
71enum_next(enumobject *en)
72{
Guido van Rossum7dab2422002-04-26 19:40:56 +000073 PyObject *next_index;
Guido van Rossumca5ed5b2002-07-16 21:02:42 +000074 PyObject *next_item;
Raymond Hettingere8b0f042003-05-28 14:05:34 +000075 PyObject *result = en->en_result;
76 PyObject *it = en->en_sit;
Guido van Rossum7dab2422002-04-26 19:40:56 +000077
Raymond Hettingere8b0f042003-05-28 14:05:34 +000078 next_item = (*it->ob_type->tp_iternext)(it);
79 if (next_item == NULL)
Guido van Rossumca5ed5b2002-07-16 21:02:42 +000080 return NULL;
81
82 next_index = PyInt_FromLong(en->en_index);
83 if (next_index == NULL) {
Raymond Hettingere8b0f042003-05-28 14:05:34 +000084 Py_DECREF(next_item);
Guido van Rossum7dab2422002-04-26 19:40:56 +000085 return NULL;
86 }
Raymond Hettingere8b0f042003-05-28 14:05:34 +000087 en->en_index++;
88
89 if (result->ob_refcnt == 1) {
90 Py_INCREF(result);
91 Py_DECREF(PyTuple_GET_ITEM(result, 0));
92 Py_DECREF(PyTuple_GET_ITEM(result, 1));
93 } else {
94 result = PyTuple_New(2);
95 if (result == NULL) {
96 Py_DECREF(next_index);
97 Py_DECREF(next_item);
98 return NULL;
99 }
100 }
Guido van Rossumca5ed5b2002-07-16 21:02:42 +0000101 PyTuple_SET_ITEM(result, 0, next_index);
Guido van Rossum7dab2422002-04-26 19:40:56 +0000102 PyTuple_SET_ITEM(result, 1, next_item);
103 return result;
104}
105
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000106PyDoc_STRVAR(enum_doc,
Jeremy Hyltonfbbe3472003-04-21 20:26:25 +0000107"enumerate(iterable) -> iterator for index, value of iterable\n"
108"\n"
109"Return an enumerate object. iterable must be an other object that supports\n"
110"iteration. The enumerate object yields pairs containing a count (from\n"
111"zero) and a value yielded by the iterable argument. enumerate is useful\n"
112"for obtaining an indexed list: (0, seq[0]), (1, seq[1]), (2, seq[2]), ...");
Guido van Rossum7dab2422002-04-26 19:40:56 +0000113
114PyTypeObject PyEnum_Type = {
115 PyObject_HEAD_INIT(&PyType_Type)
116 0, /* ob_size */
117 "enumerate", /* tp_name */
118 sizeof(enumobject), /* tp_basicsize */
119 0, /* tp_itemsize */
120 /* methods */
121 (destructor)enum_dealloc, /* tp_dealloc */
122 0, /* tp_print */
123 0, /* tp_getattr */
124 0, /* tp_setattr */
125 0, /* tp_compare */
126 0, /* tp_repr */
127 0, /* tp_as_number */
128 0, /* tp_as_sequence */
129 0, /* tp_as_mapping */
130 0, /* tp_hash */
131 0, /* tp_call */
132 0, /* tp_str */
133 PyObject_GenericGetAttr, /* tp_getattro */
134 0, /* tp_setattro */
135 0, /* tp_as_buffer */
136 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
137 Py_TPFLAGS_BASETYPE, /* tp_flags */
138 enum_doc, /* tp_doc */
139 (traverseproc)enum_traverse, /* tp_traverse */
140 0, /* tp_clear */
141 0, /* tp_richcompare */
142 0, /* tp_weaklistoffset */
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000143 PyObject_SelfIter, /* tp_iter */
Guido van Rossum7dab2422002-04-26 19:40:56 +0000144 (iternextfunc)enum_next, /* tp_iternext */
Guido van Rossumca5ed5b2002-07-16 21:02:42 +0000145 0, /* tp_methods */
Guido van Rossum7dab2422002-04-26 19:40:56 +0000146 0, /* tp_members */
147 0, /* tp_getset */
148 0, /* tp_base */
149 0, /* tp_dict */
150 0, /* tp_descr_get */
151 0, /* tp_descr_set */
152 0, /* tp_dictoffset */
153 0, /* tp_init */
154 PyType_GenericAlloc, /* tp_alloc */
155 enum_new, /* tp_new */
156 PyObject_GC_Del, /* tp_free */
157};
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000158
159/* Reversed Object ***************************************************************/
160
161typedef struct {
162 PyObject_HEAD
163 long index;
164 PyObject* seq;
165} reversedobject;
166
167static PyObject *
168reversed_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
169{
170 long n;
171 PyObject *seq;
172 reversedobject *ro;
173
174 if (!PyArg_UnpackTuple(args, "reversed", 1, 1, &seq))
175 return NULL;
176
Raymond Hettingerc058fd12004-02-07 02:45:22 +0000177 if (PyObject_HasAttrString(seq, "__reversed__"))
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000178 return PyObject_CallMethod(seq, "__reversed__", NULL);
179
180 if (!PySequence_Check(seq)) {
181 PyErr_SetString(PyExc_TypeError,
182 "argument to reversed() must be a sequence");
183 return NULL;
184 }
185
186 n = PySequence_Size(seq);
187 if (n == -1)
188 return NULL;
189
190 ro = (reversedobject *)type->tp_alloc(type, 0);
191 if (ro == NULL)
192 return NULL;
193
194 ro->index = n-1;
195 Py_INCREF(seq);
196 ro->seq = seq;
197 return (PyObject *)ro;
198}
199
200static void
201reversed_dealloc(reversedobject *ro)
202{
203 PyObject_GC_UnTrack(ro);
204 Py_XDECREF(ro->seq);
205 ro->ob_type->tp_free(ro);
206}
207
208static int
209reversed_traverse(reversedobject *ro, visitproc visit, void *arg)
210{
211 if (ro->seq)
212 return visit((PyObject *)(ro->seq), arg);
213 return 0;
214}
215
216static PyObject *
217reversed_next(reversedobject *ro)
218{
219 PyObject *item;
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000220 long index = ro->index;
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000221
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000222 if (index >= 0) {
223 item = PySequence_GetItem(ro->seq, index);
224 if (item != NULL) {
225 ro->index--;
226 return item;
227 }
Raymond Hettinger7892b1c2004-04-12 18:10:01 +0000228 if (PyErr_ExceptionMatches(PyExc_IndexError) ||
229 PyErr_ExceptionMatches(PyExc_StopIteration))
230 PyErr_Clear();
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000231 }
232 ro->index = -1;
Raymond Hettinger75ccea32004-09-01 07:02:44 +0000233 Py_CLEAR(ro->seq);
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000234 return NULL;
Raymond Hettinger029dba52004-02-10 09:33:39 +0000235}
236
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000237PyDoc_STRVAR(reversed_doc,
Raymond Hettingerd2afee42004-08-25 19:42:12 +0000238"reversed(sequence) -> reverse iterator over values of the sequence\n"
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000239"\n"
240"Return a reverse iterator");
241
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000242static PyObject *
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000243reversed_len(reversedobject *ro)
244{
Raymond Hettinger7892b1c2004-04-12 18:10:01 +0000245 int position, seqsize;
246
247 if (ro->seq == NULL)
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000248 return PyInt_FromLong(0);
Raymond Hettinger7892b1c2004-04-12 18:10:01 +0000249 seqsize = PySequence_Size(ro->seq);
250 if (seqsize == -1)
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000251 return NULL;
Raymond Hettinger7892b1c2004-04-12 18:10:01 +0000252 position = ro->index + 1;
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000253 return PyInt_FromLong((seqsize < position) ? 0 : position);
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000254}
255
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000256PyDoc_STRVAR(length_cue_doc, "Private method returning an estimate of len(list(it)).");
257
258static PyMethodDef reversediter_methods[] = {
259 {"_length_cue", (PyCFunction)reversed_len, METH_NOARGS, length_cue_doc},
260 {NULL, NULL} /* sentinel */
Raymond Hettinger06353f72004-02-08 10:49:42 +0000261};
262
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000263PyTypeObject PyReversed_Type = {
264 PyObject_HEAD_INIT(&PyType_Type)
265 0, /* ob_size */
266 "reversed", /* tp_name */
267 sizeof(reversedobject), /* tp_basicsize */
268 0, /* tp_itemsize */
269 /* methods */
270 (destructor)reversed_dealloc, /* tp_dealloc */
271 0, /* tp_print */
272 0, /* tp_getattr */
273 0, /* tp_setattr */
274 0, /* tp_compare */
275 0, /* tp_repr */
276 0, /* tp_as_number */
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000277 0, /* tp_as_sequence */
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000278 0, /* tp_as_mapping */
279 0, /* tp_hash */
280 0, /* tp_call */
281 0, /* tp_str */
282 PyObject_GenericGetAttr, /* tp_getattro */
283 0, /* tp_setattro */
284 0, /* tp_as_buffer */
285 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
286 Py_TPFLAGS_BASETYPE, /* tp_flags */
287 reversed_doc, /* tp_doc */
288 (traverseproc)reversed_traverse,/* tp_traverse */
289 0, /* tp_clear */
290 0, /* tp_richcompare */
291 0, /* tp_weaklistoffset */
292 PyObject_SelfIter, /* tp_iter */
293 (iternextfunc)reversed_next, /* tp_iternext */
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000294 reversediter_methods, /* tp_methods */
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000295 0, /* tp_members */
296 0, /* tp_getset */
297 0, /* tp_base */
298 0, /* tp_dict */
299 0, /* tp_descr_get */
300 0, /* tp_descr_set */
301 0, /* tp_dictoffset */
302 0, /* tp_init */
303 PyType_GenericAlloc, /* tp_alloc */
304 reversed_new, /* tp_new */
305 PyObject_GC_Del, /* tp_free */
306};