blob: 25e4e11154a937bbcd825036e8ff4975a2981981 [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{
Raymond Hettinger7892b1c2004-04-12 18:10:01 +000077 int seqsize, len;
78
79 if (it->it_seq) {
80 seqsize = PySequence_Size(it->it_seq);
81 if (seqsize == -1)
82 return -1;
83 len = seqsize - it->it_index;
84 if (len >= 0)
85 return len;
86 }
Raymond Hettinger435bf582004-03-18 22:43:10 +000087 return 0;
88}
89
90static PySequenceMethods iter_as_sequence = {
91 (inquiry)iter_len, /* sq_length */
92 0, /* sq_concat */
93};
94
Guido van Rossum213c7a62001-04-23 14:08:49 +000095PyTypeObject PySeqIter_Type = {
Guido van Rossum05311482001-04-20 21:06:46 +000096 PyObject_HEAD_INIT(&PyType_Type)
97 0, /* ob_size */
98 "iterator", /* tp_name */
Neil Schemenauerdbf409f2002-03-18 20:43:51 +000099 sizeof(seqiterobject), /* tp_basicsize */
Guido van Rossum05311482001-04-20 21:06:46 +0000100 0, /* tp_itemsize */
101 /* methods */
102 (destructor)iter_dealloc, /* tp_dealloc */
103 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000104 0, /* tp_getattr */
Guido van Rossum05311482001-04-20 21:06:46 +0000105 0, /* tp_setattr */
106 0, /* tp_compare */
107 0, /* tp_repr */
108 0, /* tp_as_number */
Raymond Hettinger435bf582004-03-18 22:43:10 +0000109 &iter_as_sequence, /* tp_as_sequence */
Guido van Rossum05311482001-04-20 21:06:46 +0000110 0, /* tp_as_mapping */
111 0, /* tp_hash */
112 0, /* tp_call */
113 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000114 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum05311482001-04-20 21:06:46 +0000115 0, /* tp_setattro */
116 0, /* tp_as_buffer */
Neil Schemenauerdbf409f2002-03-18 20:43:51 +0000117 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
Guido van Rossum05311482001-04-20 21:06:46 +0000118 0, /* tp_doc */
Neil Schemenauer7eac9b72001-07-12 13:27:25 +0000119 (traverseproc)iter_traverse, /* tp_traverse */
Guido van Rossum05311482001-04-20 21:06:46 +0000120 0, /* tp_clear */
121 0, /* tp_richcompare */
122 0, /* tp_weaklistoffset */
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000123 PyObject_SelfIter, /* tp_iter */
Guido van Rossum213c7a62001-04-23 14:08:49 +0000124 (iternextfunc)iter_iternext, /* tp_iternext */
Guido van Rossum613bed32002-07-16 20:24:46 +0000125 0, /* tp_methods */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000126 0, /* tp_members */
127 0, /* tp_getset */
128 0, /* tp_base */
129 0, /* tp_dict */
130 0, /* tp_descr_get */
131 0, /* tp_descr_set */
Guido van Rossum05311482001-04-20 21:06:46 +0000132};
133
134/* -------------------------------------- */
135
136typedef struct {
137 PyObject_HEAD
Guido van Rossum613bed32002-07-16 20:24:46 +0000138 PyObject *it_callable; /* Set to NULL when iterator is exhausted */
139 PyObject *it_sentinel; /* Set to NULL when iterator is exhausted */
Guido van Rossum05311482001-04-20 21:06:46 +0000140} calliterobject;
141
142PyObject *
143PyCallIter_New(PyObject *callable, PyObject *sentinel)
144{
145 calliterobject *it;
Neil Schemenauerdbf409f2002-03-18 20:43:51 +0000146 it = PyObject_GC_New(calliterobject, &PyCallIter_Type);
Guido van Rossum05311482001-04-20 21:06:46 +0000147 if (it == NULL)
148 return NULL;
149 Py_INCREF(callable);
150 it->it_callable = callable;
151 Py_INCREF(sentinel);
152 it->it_sentinel = sentinel;
Neil Schemenauerdbf409f2002-03-18 20:43:51 +0000153 _PyObject_GC_TRACK(it);
Guido van Rossum05311482001-04-20 21:06:46 +0000154 return (PyObject *)it;
155}
156static void
157calliter_dealloc(calliterobject *it)
158{
Neil Schemenauerdbf409f2002-03-18 20:43:51 +0000159 _PyObject_GC_UNTRACK(it);
Guido van Rossum613bed32002-07-16 20:24:46 +0000160 Py_XDECREF(it->it_callable);
161 Py_XDECREF(it->it_sentinel);
Neil Schemenauerdbf409f2002-03-18 20:43:51 +0000162 PyObject_GC_Del(it);
Guido van Rossum05311482001-04-20 21:06:46 +0000163}
Guido van Rossum213c7a62001-04-23 14:08:49 +0000164
Neil Schemenauer7eac9b72001-07-12 13:27:25 +0000165static int
166calliter_traverse(calliterobject *it, visitproc visit, void *arg)
167{
168 int err;
Guido van Rossum613bed32002-07-16 20:24:46 +0000169 if (it->it_callable != NULL && (err = visit(it->it_callable, arg)))
Neil Schemenauer7eac9b72001-07-12 13:27:25 +0000170 return err;
Guido van Rossum613bed32002-07-16 20:24:46 +0000171 if (it->it_sentinel != NULL && (err = visit(it->it_sentinel, arg)))
Neil Schemenauer7eac9b72001-07-12 13:27:25 +0000172 return err;
173 return 0;
174}
175
Guido van Rossum05311482001-04-20 21:06:46 +0000176static PyObject *
Guido van Rossum213c7a62001-04-23 14:08:49 +0000177calliter_iternext(calliterobject *it)
178{
Guido van Rossum613bed32002-07-16 20:24:46 +0000179 if (it->it_callable != NULL) {
Guido van Rossum84b2bed2002-08-16 17:01:09 +0000180 PyObject *args = PyTuple_New(0);
181 PyObject *result;
182 if (args == NULL)
183 return NULL;
184 result = PyObject_Call(it->it_callable, args, NULL);
185 Py_DECREF(args);
Guido van Rossum613bed32002-07-16 20:24:46 +0000186 if (result != NULL) {
187 int ok;
188 ok = PyObject_RichCompareBool(result,
189 it->it_sentinel,
190 Py_EQ);
191 if (ok == 0)
192 return result; /* Common case, fast path */
Guido van Rossum213c7a62001-04-23 14:08:49 +0000193 Py_DECREF(result);
Guido van Rossum613bed32002-07-16 20:24:46 +0000194 if (ok > 0) {
195 Py_DECREF(it->it_callable);
196 it->it_callable = NULL;
197 Py_DECREF(it->it_sentinel);
198 it->it_sentinel = NULL;
199 }
200 }
201 else if (PyErr_ExceptionMatches(PyExc_StopIteration)) {
202 PyErr_Clear();
203 Py_DECREF(it->it_callable);
204 it->it_callable = NULL;
205 Py_DECREF(it->it_sentinel);
206 it->it_sentinel = NULL;
Guido van Rossum213c7a62001-04-23 14:08:49 +0000207 }
208 }
Guido van Rossum613bed32002-07-16 20:24:46 +0000209 return NULL;
Guido van Rossum213c7a62001-04-23 14:08:49 +0000210}
211
Guido van Rossum05311482001-04-20 21:06:46 +0000212PyTypeObject PyCallIter_Type = {
213 PyObject_HEAD_INIT(&PyType_Type)
214 0, /* ob_size */
215 "callable-iterator", /* tp_name */
Neil Schemenauerdbf409f2002-03-18 20:43:51 +0000216 sizeof(calliterobject), /* tp_basicsize */
Guido van Rossum05311482001-04-20 21:06:46 +0000217 0, /* tp_itemsize */
218 /* methods */
219 (destructor)calliter_dealloc, /* tp_dealloc */
220 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000221 0, /* tp_getattr */
Guido van Rossum05311482001-04-20 21:06:46 +0000222 0, /* tp_setattr */
223 0, /* tp_compare */
224 0, /* tp_repr */
225 0, /* tp_as_number */
226 0, /* tp_as_sequence */
227 0, /* tp_as_mapping */
228 0, /* tp_hash */
229 0, /* tp_call */
230 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000231 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum05311482001-04-20 21:06:46 +0000232 0, /* tp_setattro */
233 0, /* tp_as_buffer */
Neil Schemenauerdbf409f2002-03-18 20:43:51 +0000234 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
Walter Dörwald03f6c542003-06-25 13:12:18 +0000235 0, /* tp_doc */
236 (traverseproc)calliter_traverse, /* tp_traverse */
237 0, /* tp_clear */
Guido van Rossum05311482001-04-20 21:06:46 +0000238 0, /* tp_richcompare */
239 0, /* tp_weaklistoffset */
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000240 PyObject_SelfIter, /* tp_iter */
Guido van Rossum213c7a62001-04-23 14:08:49 +0000241 (iternextfunc)calliter_iternext, /* tp_iternext */
Guido van Rossum613bed32002-07-16 20:24:46 +0000242 0, /* tp_methods */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000243 0, /* tp_members */
244 0, /* tp_getset */
245 0, /* tp_base */
246 0, /* tp_dict */
247 0, /* tp_descr_get */
248 0, /* tp_descr_set */
Guido van Rossum05311482001-04-20 21:06:46 +0000249};