blob: a407dd597fd4fac95e13e2fd4d0e5bfb309ffb1c [file] [log] [blame]
Guido van Rossum05311482001-04-20 21:06:46 +00001/* Iterator objects */
2
3#include "Python.h"
4
5typedef struct {
6 PyObject_HEAD
7 long it_index;
Guido van Rossum613bed32002-07-16 20:24:46 +00008 PyObject *it_seq; /* Set to NULL when iterator is exhausted */
Guido van Rossum213c7a62001-04-23 14:08:49 +00009} seqiterobject;
Guido van Rossum05311482001-04-20 21:06:46 +000010
11PyObject *
Guido van Rossum213c7a62001-04-23 14:08:49 +000012PySeqIter_New(PyObject *seq)
Guido van Rossum05311482001-04-20 21:06:46 +000013{
Guido van Rossum213c7a62001-04-23 14:08:49 +000014 seqiterobject *it;
Martin v. Löwis01f94bd2002-05-08 08:44:21 +000015
16 if (!PySequence_Check(seq)) {
17 PyErr_BadInternalCall();
18 return NULL;
19 }
Neil Schemenauerdbf409f2002-03-18 20:43:51 +000020 it = PyObject_GC_New(seqiterobject, &PySeqIter_Type);
Guido van Rossum05311482001-04-20 21:06:46 +000021 if (it == NULL)
22 return NULL;
23 it->it_index = 0;
24 Py_INCREF(seq);
25 it->it_seq = seq;
Neil Schemenauerdbf409f2002-03-18 20:43:51 +000026 _PyObject_GC_TRACK(it);
Guido van Rossum05311482001-04-20 21:06:46 +000027 return (PyObject *)it;
28}
Guido van Rossum613bed32002-07-16 20:24:46 +000029
Guido van Rossum05311482001-04-20 21:06:46 +000030static void
Guido van Rossum213c7a62001-04-23 14:08:49 +000031iter_dealloc(seqiterobject *it)
Guido van Rossum05311482001-04-20 21:06:46 +000032{
Neil Schemenauerdbf409f2002-03-18 20:43:51 +000033 _PyObject_GC_UNTRACK(it);
Guido van Rossum613bed32002-07-16 20:24:46 +000034 Py_XDECREF(it->it_seq);
Neil Schemenauerdbf409f2002-03-18 20:43:51 +000035 PyObject_GC_Del(it);
Guido van Rossum05311482001-04-20 21:06:46 +000036}
37
Neil Schemenauer7eac9b72001-07-12 13:27:25 +000038static int
39iter_traverse(seqiterobject *it, visitproc visit, void *arg)
40{
Guido van Rossum613bed32002-07-16 20:24:46 +000041 if (it->it_seq == NULL)
42 return 0;
Neil Schemenauer7eac9b72001-07-12 13:27:25 +000043 return visit(it->it_seq, arg);
44}
45
Guido van Rossum05311482001-04-20 21:06:46 +000046static PyObject *
Guido van Rossum213c7a62001-04-23 14:08:49 +000047iter_iternext(PyObject *iterator)
48{
49 seqiterobject *it;
50 PyObject *seq;
Raymond Hettinger48923c52002-08-09 01:30:17 +000051 PyObject *result;
Guido van Rossum213c7a62001-04-23 14:08:49 +000052
53 assert(PySeqIter_Check(iterator));
54 it = (seqiterobject *)iterator;
55 seq = it->it_seq;
Guido van Rossum613bed32002-07-16 20:24:46 +000056 if (seq == NULL)
57 return NULL;
Guido van Rossum213c7a62001-04-23 14:08:49 +000058
Raymond Hettinger48923c52002-08-09 01:30:17 +000059 result = PySequence_GetItem(seq, it->it_index);
60 if (result != NULL) {
61 it->it_index++;
62 return result;
63 }
64 if (PyErr_ExceptionMatches(PyExc_IndexError) ||
65 PyErr_ExceptionMatches(PyExc_StopIteration))
66 {
67 PyErr_Clear();
Guido van Rossum613bed32002-07-16 20:24:46 +000068 Py_DECREF(seq);
69 it->it_seq = NULL;
Martin v. Löwis01f94bd2002-05-08 08:44:21 +000070 }
Raymond Hettinger48923c52002-08-09 01:30:17 +000071 return NULL;
Guido van Rossum213c7a62001-04-23 14:08:49 +000072}
73
Raymond Hettinger435bf582004-03-18 22:43:10 +000074static int
75iter_len(seqiterobject *it)
76{
77 if (it->it_seq)
78 return PyObject_Size(it->it_seq) - it->it_index;
79 return 0;
80}
81
82static PySequenceMethods iter_as_sequence = {
83 (inquiry)iter_len, /* sq_length */
84 0, /* sq_concat */
85};
86
Guido van Rossum213c7a62001-04-23 14:08:49 +000087PyTypeObject PySeqIter_Type = {
Guido van Rossum05311482001-04-20 21:06:46 +000088 PyObject_HEAD_INIT(&PyType_Type)
89 0, /* ob_size */
90 "iterator", /* tp_name */
Neil Schemenauerdbf409f2002-03-18 20:43:51 +000091 sizeof(seqiterobject), /* tp_basicsize */
Guido van Rossum05311482001-04-20 21:06:46 +000092 0, /* tp_itemsize */
93 /* methods */
94 (destructor)iter_dealloc, /* tp_dealloc */
95 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +000096 0, /* tp_getattr */
Guido van Rossum05311482001-04-20 21:06:46 +000097 0, /* tp_setattr */
98 0, /* tp_compare */
99 0, /* tp_repr */
100 0, /* tp_as_number */
Raymond Hettinger435bf582004-03-18 22:43:10 +0000101 &iter_as_sequence, /* tp_as_sequence */
Guido van Rossum05311482001-04-20 21:06:46 +0000102 0, /* tp_as_mapping */
103 0, /* tp_hash */
104 0, /* tp_call */
105 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000106 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum05311482001-04-20 21:06:46 +0000107 0, /* tp_setattro */
108 0, /* tp_as_buffer */
Neil Schemenauerdbf409f2002-03-18 20:43:51 +0000109 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
Guido van Rossum05311482001-04-20 21:06:46 +0000110 0, /* tp_doc */
Neil Schemenauer7eac9b72001-07-12 13:27:25 +0000111 (traverseproc)iter_traverse, /* tp_traverse */
Guido van Rossum05311482001-04-20 21:06:46 +0000112 0, /* tp_clear */
113 0, /* tp_richcompare */
114 0, /* tp_weaklistoffset */
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000115 PyObject_SelfIter, /* tp_iter */
Guido van Rossum213c7a62001-04-23 14:08:49 +0000116 (iternextfunc)iter_iternext, /* tp_iternext */
Guido van Rossum613bed32002-07-16 20:24:46 +0000117 0, /* tp_methods */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000118 0, /* tp_members */
119 0, /* tp_getset */
120 0, /* tp_base */
121 0, /* tp_dict */
122 0, /* tp_descr_get */
123 0, /* tp_descr_set */
Guido van Rossum05311482001-04-20 21:06:46 +0000124};
125
126/* -------------------------------------- */
127
128typedef struct {
129 PyObject_HEAD
Guido van Rossum613bed32002-07-16 20:24:46 +0000130 PyObject *it_callable; /* Set to NULL when iterator is exhausted */
131 PyObject *it_sentinel; /* Set to NULL when iterator is exhausted */
Guido van Rossum05311482001-04-20 21:06:46 +0000132} calliterobject;
133
134PyObject *
135PyCallIter_New(PyObject *callable, PyObject *sentinel)
136{
137 calliterobject *it;
Neil Schemenauerdbf409f2002-03-18 20:43:51 +0000138 it = PyObject_GC_New(calliterobject, &PyCallIter_Type);
Guido van Rossum05311482001-04-20 21:06:46 +0000139 if (it == NULL)
140 return NULL;
141 Py_INCREF(callable);
142 it->it_callable = callable;
143 Py_INCREF(sentinel);
144 it->it_sentinel = sentinel;
Neil Schemenauerdbf409f2002-03-18 20:43:51 +0000145 _PyObject_GC_TRACK(it);
Guido van Rossum05311482001-04-20 21:06:46 +0000146 return (PyObject *)it;
147}
148static void
149calliter_dealloc(calliterobject *it)
150{
Neil Schemenauerdbf409f2002-03-18 20:43:51 +0000151 _PyObject_GC_UNTRACK(it);
Guido van Rossum613bed32002-07-16 20:24:46 +0000152 Py_XDECREF(it->it_callable);
153 Py_XDECREF(it->it_sentinel);
Neil Schemenauerdbf409f2002-03-18 20:43:51 +0000154 PyObject_GC_Del(it);
Guido van Rossum05311482001-04-20 21:06:46 +0000155}
Guido van Rossum213c7a62001-04-23 14:08:49 +0000156
Neil Schemenauer7eac9b72001-07-12 13:27:25 +0000157static int
158calliter_traverse(calliterobject *it, visitproc visit, void *arg)
159{
160 int err;
Guido van Rossum613bed32002-07-16 20:24:46 +0000161 if (it->it_callable != NULL && (err = visit(it->it_callable, arg)))
Neil Schemenauer7eac9b72001-07-12 13:27:25 +0000162 return err;
Guido van Rossum613bed32002-07-16 20:24:46 +0000163 if (it->it_sentinel != NULL && (err = visit(it->it_sentinel, arg)))
Neil Schemenauer7eac9b72001-07-12 13:27:25 +0000164 return err;
165 return 0;
166}
167
Guido van Rossum05311482001-04-20 21:06:46 +0000168static PyObject *
Guido van Rossum213c7a62001-04-23 14:08:49 +0000169calliter_iternext(calliterobject *it)
170{
Guido van Rossum613bed32002-07-16 20:24:46 +0000171 if (it->it_callable != NULL) {
Guido van Rossum84b2bed2002-08-16 17:01:09 +0000172 PyObject *args = PyTuple_New(0);
173 PyObject *result;
174 if (args == NULL)
175 return NULL;
176 result = PyObject_Call(it->it_callable, args, NULL);
177 Py_DECREF(args);
Guido van Rossum613bed32002-07-16 20:24:46 +0000178 if (result != NULL) {
179 int ok;
180 ok = PyObject_RichCompareBool(result,
181 it->it_sentinel,
182 Py_EQ);
183 if (ok == 0)
184 return result; /* Common case, fast path */
Guido van Rossum213c7a62001-04-23 14:08:49 +0000185 Py_DECREF(result);
Guido van Rossum613bed32002-07-16 20:24:46 +0000186 if (ok > 0) {
187 Py_DECREF(it->it_callable);
188 it->it_callable = NULL;
189 Py_DECREF(it->it_sentinel);
190 it->it_sentinel = NULL;
191 }
192 }
193 else if (PyErr_ExceptionMatches(PyExc_StopIteration)) {
194 PyErr_Clear();
195 Py_DECREF(it->it_callable);
196 it->it_callable = NULL;
197 Py_DECREF(it->it_sentinel);
198 it->it_sentinel = NULL;
Guido van Rossum213c7a62001-04-23 14:08:49 +0000199 }
200 }
Guido van Rossum613bed32002-07-16 20:24:46 +0000201 return NULL;
Guido van Rossum213c7a62001-04-23 14:08:49 +0000202}
203
Guido van Rossum05311482001-04-20 21:06:46 +0000204PyTypeObject PyCallIter_Type = {
205 PyObject_HEAD_INIT(&PyType_Type)
206 0, /* ob_size */
207 "callable-iterator", /* tp_name */
Neil Schemenauerdbf409f2002-03-18 20:43:51 +0000208 sizeof(calliterobject), /* tp_basicsize */
Guido van Rossum05311482001-04-20 21:06:46 +0000209 0, /* tp_itemsize */
210 /* methods */
211 (destructor)calliter_dealloc, /* tp_dealloc */
212 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000213 0, /* tp_getattr */
Guido van Rossum05311482001-04-20 21:06:46 +0000214 0, /* tp_setattr */
215 0, /* tp_compare */
216 0, /* tp_repr */
217 0, /* tp_as_number */
218 0, /* tp_as_sequence */
219 0, /* tp_as_mapping */
220 0, /* tp_hash */
221 0, /* tp_call */
222 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000223 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum05311482001-04-20 21:06:46 +0000224 0, /* tp_setattro */
225 0, /* tp_as_buffer */
Neil Schemenauerdbf409f2002-03-18 20:43:51 +0000226 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
Walter Dörwald03f6c542003-06-25 13:12:18 +0000227 0, /* tp_doc */
228 (traverseproc)calliter_traverse, /* tp_traverse */
229 0, /* tp_clear */
Guido van Rossum05311482001-04-20 21:06:46 +0000230 0, /* tp_richcompare */
231 0, /* tp_weaklistoffset */
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000232 PyObject_SelfIter, /* tp_iter */
Guido van Rossum213c7a62001-04-23 14:08:49 +0000233 (iternextfunc)calliter_iternext, /* tp_iternext */
Guido van Rossum613bed32002-07-16 20:24:46 +0000234 0, /* tp_methods */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000235 0, /* tp_members */
236 0, /* tp_getset */
237 0, /* tp_base */
238 0, /* tp_dict */
239 0, /* tp_descr_get */
240 0, /* tp_descr_set */
Guido van Rossum05311482001-04-20 21:06:46 +0000241};