Guido van Rossum | 0531148 | 2001-04-20 21:06:46 +0000 | [diff] [blame] | 1 | /* Iterator objects */ |
| 2 | |
| 3 | #include "Python.h" |
Victor Stinner | bcda8f1 | 2018-11-21 22:27:47 +0100 | [diff] [blame] | 4 | #include "pycore_object.h" |
Victor Stinner | 621cebe | 2018-11-12 16:53:38 +0100 | [diff] [blame] | 5 | #include "pycore_pymem.h" |
| 6 | #include "pycore_pystate.h" |
Guido van Rossum | 0531148 | 2001-04-20 21:06:46 +0000 | [diff] [blame] | 7 | |
| 8 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 9 | PyObject_HEAD |
Victor Stinner | e0b99ba | 2013-06-04 23:02:46 +0200 | [diff] [blame] | 10 | Py_ssize_t it_index; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 11 | PyObject *it_seq; /* Set to NULL when iterator is exhausted */ |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 12 | } seqiterobject; |
Guido van Rossum | 0531148 | 2001-04-20 21:06:46 +0000 | [diff] [blame] | 13 | |
| 14 | PyObject * |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 15 | PySeqIter_New(PyObject *seq) |
Guido van Rossum | 0531148 | 2001-04-20 21:06:46 +0000 | [diff] [blame] | 16 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 17 | seqiterobject *it; |
Martin v. Löwis | 01f94bd | 2002-05-08 08:44:21 +0000 | [diff] [blame] | 18 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 19 | if (!PySequence_Check(seq)) { |
| 20 | PyErr_BadInternalCall(); |
| 21 | return NULL; |
| 22 | } |
| 23 | it = PyObject_GC_New(seqiterobject, &PySeqIter_Type); |
| 24 | if (it == NULL) |
| 25 | return NULL; |
| 26 | it->it_index = 0; |
| 27 | Py_INCREF(seq); |
| 28 | it->it_seq = seq; |
| 29 | _PyObject_GC_TRACK(it); |
| 30 | return (PyObject *)it; |
Guido van Rossum | 0531148 | 2001-04-20 21:06:46 +0000 | [diff] [blame] | 31 | } |
Guido van Rossum | 613bed3 | 2002-07-16 20:24:46 +0000 | [diff] [blame] | 32 | |
Guido van Rossum | 0531148 | 2001-04-20 21:06:46 +0000 | [diff] [blame] | 33 | static void |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 34 | iter_dealloc(seqiterobject *it) |
Guido van Rossum | 0531148 | 2001-04-20 21:06:46 +0000 | [diff] [blame] | 35 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 36 | _PyObject_GC_UNTRACK(it); |
| 37 | Py_XDECREF(it->it_seq); |
| 38 | PyObject_GC_Del(it); |
Guido van Rossum | 0531148 | 2001-04-20 21:06:46 +0000 | [diff] [blame] | 39 | } |
| 40 | |
Neil Schemenauer | 7eac9b7 | 2001-07-12 13:27:25 +0000 | [diff] [blame] | 41 | static int |
| 42 | iter_traverse(seqiterobject *it, visitproc visit, void *arg) |
| 43 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 44 | Py_VISIT(it->it_seq); |
| 45 | return 0; |
Neil Schemenauer | 7eac9b7 | 2001-07-12 13:27:25 +0000 | [diff] [blame] | 46 | } |
| 47 | |
Guido van Rossum | 0531148 | 2001-04-20 21:06:46 +0000 | [diff] [blame] | 48 | static PyObject * |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 49 | iter_iternext(PyObject *iterator) |
| 50 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 51 | seqiterobject *it; |
| 52 | PyObject *seq; |
| 53 | PyObject *result; |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 54 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 55 | assert(PySeqIter_Check(iterator)); |
| 56 | it = (seqiterobject *)iterator; |
| 57 | seq = it->it_seq; |
| 58 | if (seq == NULL) |
| 59 | return NULL; |
Serhiy Storchaka | 4faf5c5 | 2015-05-21 20:50:25 +0300 | [diff] [blame] | 60 | if (it->it_index == PY_SSIZE_T_MAX) { |
| 61 | PyErr_SetString(PyExc_OverflowError, |
| 62 | "iter index too large"); |
| 63 | return NULL; |
| 64 | } |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 65 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 66 | result = PySequence_GetItem(seq, it->it_index); |
| 67 | if (result != NULL) { |
| 68 | it->it_index++; |
| 69 | return result; |
| 70 | } |
| 71 | if (PyErr_ExceptionMatches(PyExc_IndexError) || |
| 72 | PyErr_ExceptionMatches(PyExc_StopIteration)) |
| 73 | { |
| 74 | PyErr_Clear(); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 75 | it->it_seq = NULL; |
Serhiy Storchaka | fbb1c5e | 2016-03-30 20:40:02 +0300 | [diff] [blame] | 76 | Py_DECREF(seq); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 77 | } |
| 78 | return NULL; |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 79 | } |
| 80 | |
Raymond Hettinger | 6b27cda | 2005-09-24 21:23:05 +0000 | [diff] [blame] | 81 | static PyObject * |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 82 | iter_len(seqiterobject *it, PyObject *Py_UNUSED(ignored)) |
Raymond Hettinger | 435bf58 | 2004-03-18 22:43:10 +0000 | [diff] [blame] | 83 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 84 | Py_ssize_t seqsize, len; |
Raymond Hettinger | 7892b1c | 2004-04-12 18:10:01 +0000 | [diff] [blame] | 85 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 86 | if (it->it_seq) { |
Armin Ronacher | aa9a79d | 2012-10-06 14:03:24 +0200 | [diff] [blame] | 87 | if (_PyObject_HasLen(it->it_seq)) { |
| 88 | seqsize = PySequence_Size(it->it_seq); |
| 89 | if (seqsize == -1) |
| 90 | return NULL; |
| 91 | } |
| 92 | else { |
Armin Ronacher | 23c5bb4 | 2012-10-06 14:30:32 +0200 | [diff] [blame] | 93 | Py_RETURN_NOTIMPLEMENTED; |
Armin Ronacher | aa9a79d | 2012-10-06 14:03:24 +0200 | [diff] [blame] | 94 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 95 | len = seqsize - it->it_index; |
| 96 | if (len >= 0) |
| 97 | return PyLong_FromSsize_t(len); |
| 98 | } |
| 99 | return PyLong_FromLong(0); |
Raymond Hettinger | 435bf58 | 2004-03-18 22:43:10 +0000 | [diff] [blame] | 100 | } |
| 101 | |
Armin Rigo | f5b3e36 | 2006-02-11 21:32:43 +0000 | [diff] [blame] | 102 | PyDoc_STRVAR(length_hint_doc, "Private method returning an estimate of len(list(it))."); |
Raymond Hettinger | 6b27cda | 2005-09-24 21:23:05 +0000 | [diff] [blame] | 103 | |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 104 | static PyObject * |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 105 | iter_reduce(seqiterobject *it, PyObject *Py_UNUSED(ignored)) |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 106 | { |
| 107 | if (it->it_seq != NULL) |
Antoine Pitrou | a701388 | 2012-04-05 00:04:20 +0200 | [diff] [blame] | 108 | return Py_BuildValue("N(O)n", _PyObject_GetBuiltin("iter"), |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 109 | it->it_seq, it->it_index); |
| 110 | else |
Antoine Pitrou | a701388 | 2012-04-05 00:04:20 +0200 | [diff] [blame] | 111 | return Py_BuildValue("N(())", _PyObject_GetBuiltin("iter")); |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 112 | } |
| 113 | |
| 114 | PyDoc_STRVAR(reduce_doc, "Return state information for pickling."); |
| 115 | |
| 116 | static PyObject * |
| 117 | iter_setstate(seqiterobject *it, PyObject *state) |
| 118 | { |
| 119 | Py_ssize_t index = PyLong_AsSsize_t(state); |
| 120 | if (index == -1 && PyErr_Occurred()) |
| 121 | return NULL; |
| 122 | if (it->it_seq != NULL) { |
| 123 | if (index < 0) |
| 124 | index = 0; |
| 125 | it->it_index = index; |
| 126 | } |
| 127 | Py_RETURN_NONE; |
| 128 | } |
| 129 | |
| 130 | PyDoc_STRVAR(setstate_doc, "Set state information for unpickling."); |
| 131 | |
Raymond Hettinger | 6b27cda | 2005-09-24 21:23:05 +0000 | [diff] [blame] | 132 | static PyMethodDef seqiter_methods[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 133 | {"__length_hint__", (PyCFunction)iter_len, METH_NOARGS, length_hint_doc}, |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 134 | {"__reduce__", (PyCFunction)iter_reduce, METH_NOARGS, reduce_doc}, |
| 135 | {"__setstate__", (PyCFunction)iter_setstate, METH_O, setstate_doc}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 136 | {NULL, NULL} /* sentinel */ |
Raymond Hettinger | 435bf58 | 2004-03-18 22:43:10 +0000 | [diff] [blame] | 137 | }; |
| 138 | |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 139 | PyTypeObject PySeqIter_Type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 140 | PyVarObject_HEAD_INIT(&PyType_Type, 0) |
| 141 | "iterator", /* tp_name */ |
| 142 | sizeof(seqiterobject), /* tp_basicsize */ |
| 143 | 0, /* tp_itemsize */ |
| 144 | /* methods */ |
| 145 | (destructor)iter_dealloc, /* tp_dealloc */ |
| 146 | 0, /* tp_print */ |
| 147 | 0, /* tp_getattr */ |
| 148 | 0, /* tp_setattr */ |
| 149 | 0, /* tp_reserved */ |
| 150 | 0, /* tp_repr */ |
| 151 | 0, /* tp_as_number */ |
| 152 | 0, /* tp_as_sequence */ |
| 153 | 0, /* tp_as_mapping */ |
| 154 | 0, /* tp_hash */ |
| 155 | 0, /* tp_call */ |
| 156 | 0, /* tp_str */ |
| 157 | PyObject_GenericGetAttr, /* tp_getattro */ |
| 158 | 0, /* tp_setattro */ |
| 159 | 0, /* tp_as_buffer */ |
| 160 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */ |
| 161 | 0, /* tp_doc */ |
| 162 | (traverseproc)iter_traverse, /* tp_traverse */ |
| 163 | 0, /* tp_clear */ |
| 164 | 0, /* tp_richcompare */ |
| 165 | 0, /* tp_weaklistoffset */ |
| 166 | PyObject_SelfIter, /* tp_iter */ |
| 167 | iter_iternext, /* tp_iternext */ |
| 168 | seqiter_methods, /* tp_methods */ |
| 169 | 0, /* tp_members */ |
Guido van Rossum | 0531148 | 2001-04-20 21:06:46 +0000 | [diff] [blame] | 170 | }; |
| 171 | |
| 172 | /* -------------------------------------- */ |
| 173 | |
| 174 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 175 | PyObject_HEAD |
| 176 | PyObject *it_callable; /* Set to NULL when iterator is exhausted */ |
| 177 | PyObject *it_sentinel; /* Set to NULL when iterator is exhausted */ |
Guido van Rossum | 0531148 | 2001-04-20 21:06:46 +0000 | [diff] [blame] | 178 | } calliterobject; |
| 179 | |
| 180 | PyObject * |
| 181 | PyCallIter_New(PyObject *callable, PyObject *sentinel) |
| 182 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 183 | calliterobject *it; |
| 184 | it = PyObject_GC_New(calliterobject, &PyCallIter_Type); |
| 185 | if (it == NULL) |
| 186 | return NULL; |
| 187 | Py_INCREF(callable); |
| 188 | it->it_callable = callable; |
| 189 | Py_INCREF(sentinel); |
| 190 | it->it_sentinel = sentinel; |
| 191 | _PyObject_GC_TRACK(it); |
| 192 | return (PyObject *)it; |
Guido van Rossum | 0531148 | 2001-04-20 21:06:46 +0000 | [diff] [blame] | 193 | } |
| 194 | static void |
| 195 | calliter_dealloc(calliterobject *it) |
| 196 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 197 | _PyObject_GC_UNTRACK(it); |
| 198 | Py_XDECREF(it->it_callable); |
| 199 | Py_XDECREF(it->it_sentinel); |
| 200 | PyObject_GC_Del(it); |
Guido van Rossum | 0531148 | 2001-04-20 21:06:46 +0000 | [diff] [blame] | 201 | } |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 202 | |
Neil Schemenauer | 7eac9b7 | 2001-07-12 13:27:25 +0000 | [diff] [blame] | 203 | static int |
| 204 | calliter_traverse(calliterobject *it, visitproc visit, void *arg) |
| 205 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 206 | Py_VISIT(it->it_callable); |
| 207 | Py_VISIT(it->it_sentinel); |
| 208 | return 0; |
Neil Schemenauer | 7eac9b7 | 2001-07-12 13:27:25 +0000 | [diff] [blame] | 209 | } |
| 210 | |
Guido van Rossum | 0531148 | 2001-04-20 21:06:46 +0000 | [diff] [blame] | 211 | static PyObject * |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 212 | calliter_iternext(calliterobject *it) |
| 213 | { |
Victor Stinner | 99ee9c7 | 2016-08-19 18:47:10 +0200 | [diff] [blame] | 214 | PyObject *result; |
| 215 | |
| 216 | if (it->it_callable == NULL) { |
| 217 | return NULL; |
| 218 | } |
| 219 | |
Victor Stinner | 559bb6a | 2016-08-22 22:48:54 +0200 | [diff] [blame] | 220 | result = _PyObject_CallNoArg(it->it_callable); |
Victor Stinner | 99ee9c7 | 2016-08-19 18:47:10 +0200 | [diff] [blame] | 221 | if (result != NULL) { |
| 222 | int ok; |
| 223 | |
| 224 | ok = PyObject_RichCompareBool(it->it_sentinel, result, Py_EQ); |
| 225 | if (ok == 0) { |
| 226 | return result; /* Common case, fast path */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 227 | } |
Victor Stinner | 99ee9c7 | 2016-08-19 18:47:10 +0200 | [diff] [blame] | 228 | |
| 229 | Py_DECREF(result); |
| 230 | if (ok > 0) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 231 | Py_CLEAR(it->it_callable); |
| 232 | Py_CLEAR(it->it_sentinel); |
| 233 | } |
| 234 | } |
Victor Stinner | 99ee9c7 | 2016-08-19 18:47:10 +0200 | [diff] [blame] | 235 | else if (PyErr_ExceptionMatches(PyExc_StopIteration)) { |
| 236 | PyErr_Clear(); |
| 237 | Py_CLEAR(it->it_callable); |
| 238 | Py_CLEAR(it->it_sentinel); |
| 239 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 240 | return NULL; |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 241 | } |
| 242 | |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 243 | static PyObject * |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 244 | calliter_reduce(calliterobject *it, PyObject *Py_UNUSED(ignored)) |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 245 | { |
| 246 | if (it->it_callable != NULL && it->it_sentinel != NULL) |
Antoine Pitrou | a701388 | 2012-04-05 00:04:20 +0200 | [diff] [blame] | 247 | return Py_BuildValue("N(OO)", _PyObject_GetBuiltin("iter"), |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 248 | it->it_callable, it->it_sentinel); |
| 249 | else |
Antoine Pitrou | a701388 | 2012-04-05 00:04:20 +0200 | [diff] [blame] | 250 | return Py_BuildValue("N(())", _PyObject_GetBuiltin("iter")); |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 251 | } |
| 252 | |
| 253 | static PyMethodDef calliter_methods[] = { |
| 254 | {"__reduce__", (PyCFunction)calliter_reduce, METH_NOARGS, reduce_doc}, |
| 255 | {NULL, NULL} /* sentinel */ |
| 256 | }; |
| 257 | |
Guido van Rossum | 0531148 | 2001-04-20 21:06:46 +0000 | [diff] [blame] | 258 | PyTypeObject PyCallIter_Type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 259 | PyVarObject_HEAD_INIT(&PyType_Type, 0) |
| 260 | "callable_iterator", /* tp_name */ |
| 261 | sizeof(calliterobject), /* tp_basicsize */ |
| 262 | 0, /* tp_itemsize */ |
| 263 | /* methods */ |
| 264 | (destructor)calliter_dealloc, /* tp_dealloc */ |
| 265 | 0, /* tp_print */ |
| 266 | 0, /* tp_getattr */ |
| 267 | 0, /* tp_setattr */ |
| 268 | 0, /* tp_reserved */ |
| 269 | 0, /* tp_repr */ |
| 270 | 0, /* tp_as_number */ |
| 271 | 0, /* tp_as_sequence */ |
| 272 | 0, /* tp_as_mapping */ |
| 273 | 0, /* tp_hash */ |
| 274 | 0, /* tp_call */ |
| 275 | 0, /* tp_str */ |
| 276 | PyObject_GenericGetAttr, /* tp_getattro */ |
| 277 | 0, /* tp_setattro */ |
| 278 | 0, /* tp_as_buffer */ |
| 279 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */ |
| 280 | 0, /* tp_doc */ |
| 281 | (traverseproc)calliter_traverse, /* tp_traverse */ |
| 282 | 0, /* tp_clear */ |
| 283 | 0, /* tp_richcompare */ |
| 284 | 0, /* tp_weaklistoffset */ |
| 285 | PyObject_SelfIter, /* tp_iter */ |
| 286 | (iternextfunc)calliter_iternext, /* tp_iternext */ |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 287 | calliter_methods, /* tp_methods */ |
Guido van Rossum | 0531148 | 2001-04-20 21:06:46 +0000 | [diff] [blame] | 288 | }; |
Guido van Rossum | b65fb33 | 2006-08-25 23:26:40 +0000 | [diff] [blame] | 289 | |
| 290 | |