blob: e36469cd0178009b8c10750f0f9211ec96f51fbb [file] [log] [blame]
Guido van Rossum12d12c51993-10-26 17:58:25 +00001/* Range object implementation */
2
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003#include "Python.h"
Thomas Woutersefafcea2001-07-09 12:30:54 +00004
Guido van Rossum805365e2007-05-07 22:24:25 +00005/* Support objects whose length is > PY_SSIZE_T_MAX.
6
7 This could be sped up for small PyLongs if they fit in an Py_ssize_t.
8 This only matters on Win64. Though we could use PY_LONG_LONG which
9 would presumably help perf.
10*/
11
Guido van Rossum12d12c51993-10-26 17:58:25 +000012typedef struct {
Guido van Rossum805365e2007-05-07 22:24:25 +000013 PyObject_HEAD
14 PyObject *start;
15 PyObject *stop;
16 PyObject *step;
Guido van Rossum12d12c51993-10-26 17:58:25 +000017} rangeobject;
18
Guido van Rossum805365e2007-05-07 22:24:25 +000019/* Helper function for validating step. Always returns a new reference or
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000020 NULL on error.
Guido van Rossum805365e2007-05-07 22:24:25 +000021*/
22static PyObject *
23validate_step(PyObject *step)
Raymond Hettingerc4c453f2002-06-05 23:12:45 +000024{
Guido van Rossum805365e2007-05-07 22:24:25 +000025 /* No step specified, use a step of 1. */
26 if (!step)
Christian Heimes217cfd12007-12-02 14:31:20 +000027 return PyLong_FromLong(1);
Guido van Rossum805365e2007-05-07 22:24:25 +000028
29 step = PyNumber_Index(step);
30 if (step) {
31 Py_ssize_t istep = PyNumber_AsSsize_t(step, NULL);
32 if (istep == -1 && PyErr_Occurred()) {
33 /* Ignore OverflowError, we know the value isn't 0. */
34 PyErr_Clear();
35 }
36 else if (istep == 0) {
37 PyErr_SetString(PyExc_ValueError,
38 "range() arg 3 must not be zero");
39 Py_CLEAR(step);
40 }
41 }
42
43 return step;
Raymond Hettingerc4c453f2002-06-05 23:12:45 +000044}
45
Guido van Rossum805365e2007-05-07 22:24:25 +000046/* XXX(nnorwitz): should we error check if the user passes any empty ranges?
47 range(-10)
48 range(0, -5)
49 range(0, 5, -1)
50*/
Raymond Hettingerc4c453f2002-06-05 23:12:45 +000051static PyObject *
52range_new(PyTypeObject *type, PyObject *args, PyObject *kw)
53{
Guido van Rossum805365e2007-05-07 22:24:25 +000054 rangeobject *obj = NULL;
55 PyObject *start = NULL, *stop = NULL, *step = NULL;
Raymond Hettingerc4c453f2002-06-05 23:12:45 +000056
Guido van Rossum805365e2007-05-07 22:24:25 +000057 if (!_PyArg_NoKeywords("range()", kw))
58 return NULL;
Georg Brandl02c42872005-08-26 06:42:30 +000059
Guido van Rossum805365e2007-05-07 22:24:25 +000060 if (PyTuple_Size(args) <= 1) {
61 if (!PyArg_UnpackTuple(args, "range", 1, 1, &stop))
Raymond Hettinger94f55832009-06-12 18:40:16 +000062 return NULL;
Guido van Rossum805365e2007-05-07 22:24:25 +000063 stop = PyNumber_Index(stop);
64 if (!stop)
Raymond Hettinger94f55832009-06-12 18:40:16 +000065 return NULL;
Christian Heimes217cfd12007-12-02 14:31:20 +000066 start = PyLong_FromLong(0);
Raymond Hettinger94f55832009-06-12 18:40:16 +000067 if (!start) {
68 Py_DECREF(stop);
69 return NULL;
70 }
Christian Heimes217cfd12007-12-02 14:31:20 +000071 step = PyLong_FromLong(1);
Raymond Hettinger94f55832009-06-12 18:40:16 +000072 if (!step) {
73 Py_DECREF(stop);
74 Py_DECREF(start);
75 return NULL;
76 }
Guido van Rossum805365e2007-05-07 22:24:25 +000077 }
78 else {
79 if (!PyArg_UnpackTuple(args, "range", 2, 3,
80 &start, &stop, &step))
Raymond Hettinger94f55832009-06-12 18:40:16 +000081 return NULL;
Tim Petersfeec4532004-08-08 07:17:39 +000082
Guido van Rossum805365e2007-05-07 22:24:25 +000083 /* Convert borrowed refs to owned refs */
84 start = PyNumber_Index(start);
Raymond Hettinger94f55832009-06-12 18:40:16 +000085 if (!start)
86 return NULL;
Guido van Rossum805365e2007-05-07 22:24:25 +000087 stop = PyNumber_Index(stop);
Raymond Hettinger94f55832009-06-12 18:40:16 +000088 if (!stop) {
89 Py_DECREF(start);
90 return NULL;
91 }
92 step = validate_step(step); /* Caution, this can clear exceptions */
93 if (!step) {
94 Py_DECREF(start);
95 Py_DECREF(stop);
96 return NULL;
97 }
Guido van Rossum805365e2007-05-07 22:24:25 +000098 }
99
100 obj = PyObject_New(rangeobject, &PyRange_Type);
101 if (obj == NULL)
102 goto Fail;
103 obj->start = start;
104 obj->stop = stop;
105 obj->step = step;
106 return (PyObject *) obj;
107
108Fail:
109 Py_XDECREF(start);
110 Py_XDECREF(stop);
111 Py_XDECREF(step);
112 return NULL;
Raymond Hettingerc4c453f2002-06-05 23:12:45 +0000113}
114
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000115PyDoc_STRVAR(range_doc,
Guido van Rossum805365e2007-05-07 22:24:25 +0000116"range([start,] stop[, step]) -> range object\n\
Raymond Hettingerc4c453f2002-06-05 23:12:45 +0000117\n\
Guido van Rossum805365e2007-05-07 22:24:25 +0000118Returns an iterator that generates the numbers in the range on demand.");
Raymond Hettingerc4c453f2002-06-05 23:12:45 +0000119
Guido van Rossum805365e2007-05-07 22:24:25 +0000120static void
121range_dealloc(rangeobject *r)
Guido van Rossum12d12c51993-10-26 17:58:25 +0000122{
Guido van Rossum805365e2007-05-07 22:24:25 +0000123 Py_DECREF(r->start);
124 Py_DECREF(r->stop);
125 Py_DECREF(r->step);
Amaury Forgeot d'Arcb7f17e42007-11-15 20:52:21 +0000126 PyObject_Del(r);
Guido van Rossum805365e2007-05-07 22:24:25 +0000127}
128
Mark Dickinson732166d2009-06-28 22:08:40 +0000129/* Return number of items in range (lo, hi, step) as a PyLong object,
130 * when arguments are PyLong objects. Arguments MUST return 1 with
131 * PyLong_Check(). Return NULL when there is an error.
Guido van Rossum805365e2007-05-07 22:24:25 +0000132 */
133static PyObject*
134range_length_obj(rangeobject *r)
135{
136 /* -------------------------------------------------------------
137 Algorithm is equal to that of get_len_of_range(), but it operates
Benjamin Petersona47af9c2009-06-24 21:14:38 +0000138 on PyObjects (which are assumed to be PyLong objects).
Guido van Rossum805365e2007-05-07 22:24:25 +0000139 ---------------------------------------------------------------*/
Mark Dickinson211c6252009-02-01 10:28:51 +0000140 int cmp_result;
Guido van Rossum805365e2007-05-07 22:24:25 +0000141 PyObject *lo, *hi;
142 PyObject *step = NULL;
143 PyObject *diff = NULL;
144 PyObject *one = NULL;
145 PyObject *tmp1 = NULL, *tmp2 = NULL, *result;
146 /* holds sub-expression evaluations */
147
148 PyObject *zero = PyLong_FromLong(0);
149 if (zero == NULL)
150 return NULL;
Mark Dickinson211c6252009-02-01 10:28:51 +0000151 cmp_result = PyObject_RichCompareBool(r->step, zero, Py_GT);
Guido van Rossum805365e2007-05-07 22:24:25 +0000152 Py_DECREF(zero);
Mark Dickinson211c6252009-02-01 10:28:51 +0000153 if (cmp_result == -1)
Guido van Rossum805365e2007-05-07 22:24:25 +0000154 return NULL;
155
Mark Dickinson211c6252009-02-01 10:28:51 +0000156 if (cmp_result == 1) {
Guido van Rossum805365e2007-05-07 22:24:25 +0000157 lo = r->start;
158 hi = r->stop;
159 step = r->step;
160 Py_INCREF(step);
161 } else {
162 lo = r->stop;
163 hi = r->start;
164 step = PyNumber_Negative(r->step);
165 if (!step)
166 return NULL;
167 }
168
169 /* if (lo >= hi), return length of 0. */
Mark Dickinson211c6252009-02-01 10:28:51 +0000170 if (PyObject_RichCompareBool(lo, hi, Py_GE) == 1) {
Guido van Rossum805365e2007-05-07 22:24:25 +0000171 Py_XDECREF(step);
172 return PyLong_FromLong(0);
173 }
174
175 if ((one = PyLong_FromLong(1L)) == NULL)
176 goto Fail;
177
178 if ((tmp1 = PyNumber_Subtract(hi, lo)) == NULL)
179 goto Fail;
180
181 if ((diff = PyNumber_Subtract(tmp1, one)) == NULL)
182 goto Fail;
183
184 if ((tmp2 = PyNumber_FloorDivide(diff, step)) == NULL)
185 goto Fail;
186
187 if ((result = PyNumber_Add(tmp2, one)) == NULL)
188 goto Fail;
189
190 Py_DECREF(tmp2);
191 Py_DECREF(diff);
192 Py_DECREF(step);
193 Py_DECREF(tmp1);
194 Py_DECREF(one);
195 return result;
196
197 Fail:
198 Py_XDECREF(tmp2);
199 Py_XDECREF(diff);
200 Py_XDECREF(step);
201 Py_XDECREF(tmp1);
202 Py_XDECREF(one);
203 return NULL;
Guido van Rossum12d12c51993-10-26 17:58:25 +0000204}
205
Martin v. Löwis18e16552006-02-15 17:27:45 +0000206static Py_ssize_t
Fred Drake45cfbcc2000-07-09 06:21:27 +0000207range_length(rangeobject *r)
Guido van Rossum12d12c51993-10-26 17:58:25 +0000208{
Guido van Rossum805365e2007-05-07 22:24:25 +0000209 PyObject *len = range_length_obj(r);
210 Py_ssize_t result = -1;
211 if (len) {
212 result = PyLong_AsSsize_t(len);
213 Py_DECREF(len);
214 }
215 return result;
216}
217
218/* range(...)[x] is necessary for: seq[:] = range(...) */
219
220static PyObject *
221range_item(rangeobject *r, Py_ssize_t i)
222{
223 Py_ssize_t len = range_length(r);
224 PyObject *rem, *incr, *result;
225
226 /* XXX(nnorwitz): should negative indices be supported? */
227 /* XXX(nnorwitz): should support range[x] where x > PY_SSIZE_T_MAX? */
228 if (i < 0 || i >= len) {
229 if (!PyErr_Occurred())
230 PyErr_SetString(PyExc_IndexError,
Walter Dörwald4ad94212007-05-21 18:01:17 +0000231 "range object index out of range");
Benjamin Petersondf0a5cb2008-04-25 21:15:37 +0000232 return NULL;
233 }
Guido van Rossum805365e2007-05-07 22:24:25 +0000234
235 /* XXX(nnorwitz): optimize for short ints. */
Raymond Hettingerad3f3322008-02-09 04:13:49 +0000236 rem = PyLong_FromSsize_t(i);
Guido van Rossum805365e2007-05-07 22:24:25 +0000237 if (!rem)
238 return NULL;
239 incr = PyNumber_Multiply(rem, r->step);
240 Py_DECREF(rem);
241 if (!incr)
242 return NULL;
243 result = PyNumber_Add(r->start, incr);
244 Py_DECREF(incr);
245 return result;
Guido van Rossum7d6aa511993-12-21 22:50:31 +0000246}
247
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000248static PyObject *
Fred Drake45cfbcc2000-07-09 06:21:27 +0000249range_repr(rangeobject *r)
Guido van Rossum12d12c51993-10-26 17:58:25 +0000250{
Walter Dörwald03b43d82007-05-21 10:43:34 +0000251 Py_ssize_t istep;
Tim Petersd976ab72004-08-08 06:29:10 +0000252
Guido van Rossum805365e2007-05-07 22:24:25 +0000253 /* Check for special case values for printing. We don't always
Walter Dörwald03b43d82007-05-21 10:43:34 +0000254 need the step value. We don't care about errors
Guido van Rossum805365e2007-05-07 22:24:25 +0000255 (it means overflow), so clear the errors. */
Guido van Rossum805365e2007-05-07 22:24:25 +0000256 istep = PyNumber_AsSsize_t(r->step, NULL);
257 if (istep != 1 || (istep == -1 && PyErr_Occurred())) {
258 PyErr_Clear();
Guido van Rossum805365e2007-05-07 22:24:25 +0000259 }
260
Walter Dörwald03b43d82007-05-21 10:43:34 +0000261 if (istep == 1)
Walter Dörwald850e5162007-05-20 08:19:54 +0000262 return PyUnicode_FromFormat("range(%R, %R)", r->start, r->stop);
263 else
264 return PyUnicode_FromFormat("range(%R, %R, %R)",
265 r->start, r->stop, r->step);
Thomas Woutersefafcea2001-07-09 12:30:54 +0000266}
267
Alexandre Vassalotti75056072008-06-10 04:03:04 +0000268/* Pickling support */
269static PyObject *
270range_reduce(rangeobject *r, PyObject *args)
271{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000272 return Py_BuildValue("(O(OOO))", Py_TYPE(r),
Alexandre Vassalotti75056072008-06-10 04:03:04 +0000273 r->start, r->stop, r->step);
274}
275
Mark Dickinson3e124ae2009-09-22 21:47:24 +0000276static int
277range_contains(rangeobject *r, PyObject *ob) {
Mark Dickinson418f81d2009-09-24 20:04:23 +0000278 if (PyLong_CheckExact(ob) || PyBool_Check(ob)) {
Mark Dickinson3e124ae2009-09-22 21:47:24 +0000279 int cmp1, cmp2, cmp3;
280 PyObject *tmp1 = NULL;
281 PyObject *tmp2 = NULL;
282 PyObject *zero = NULL;
283 int result = -1;
284
285 zero = PyLong_FromLong(0);
286 if (zero == NULL) /* MemoryError in int(0) */
287 goto end;
288
289 /* Check if the value can possibly be in the range. */
290
291 cmp1 = PyObject_RichCompareBool(r->step, zero, Py_GT);
292 if (cmp1 == -1)
293 goto end;
294 if (cmp1 == 1) { /* positive steps: start <= ob < stop */
295 cmp2 = PyObject_RichCompareBool(r->start, ob, Py_LE);
296 cmp3 = PyObject_RichCompareBool(ob, r->stop, Py_LT);
297 }
298 else { /* negative steps: stop < ob <= start */
299 cmp2 = PyObject_RichCompareBool(ob, r->start, Py_LE);
300 cmp3 = PyObject_RichCompareBool(r->stop, ob, Py_LT);
301 }
302
303 if (cmp2 == -1 || cmp3 == -1) /* TypeError */
304 goto end;
305 if (cmp2 == 0 || cmp3 == 0) { /* ob outside of range */
306 result = 0;
307 goto end;
308 }
309
310 /* Check that the stride does not invalidate ob's membership. */
311 tmp1 = PyNumber_Subtract(ob, r->start);
312 if (tmp1 == NULL)
313 goto end;
314 tmp2 = PyNumber_Remainder(tmp1, r->step);
315 if (tmp2 == NULL)
316 goto end;
317 /* result = (int(ob) - start % step) == 0 */
318 result = PyObject_RichCompareBool(tmp2, zero, Py_EQ);
319 end:
320 Py_XDECREF(tmp1);
321 Py_XDECREF(tmp2);
322 Py_XDECREF(zero);
323 return result;
324 }
325 /* Fall back to iterative search. */
326 return (int)_PySequence_IterSearch((PyObject*)r, ob,
327 PY_ITERSEARCH_CONTAINS);
328}
329
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000330static PySequenceMethods range_as_sequence = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000331 (lenfunc)range_length, /* sq_length */
332 0, /* sq_concat */
333 0, /* sq_repeat */
Guido van Rossum805365e2007-05-07 22:24:25 +0000334 (ssizeargfunc)range_item, /* sq_item */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000335 0, /* sq_slice */
Mark Dickinson3e124ae2009-09-22 21:47:24 +0000336 0, /* sq_ass_item */
337 0, /* sq_ass_slice */
338 (objobjproc)range_contains, /* sq_contains */
Guido van Rossum12d12c51993-10-26 17:58:25 +0000339};
340
Jeremy Hylton938ace62002-07-17 16:30:39 +0000341static PyObject * range_iter(PyObject *seq);
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000342static PyObject * range_reverse(PyObject *seq);
343
344PyDoc_STRVAR(reverse_doc,
345"Returns a reverse iterator.");
346
347static PyMethodDef range_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000348 {"__reversed__", (PyCFunction)range_reverse, METH_NOARGS,
349 reverse_doc},
350 {"__reduce__", (PyCFunction)range_reduce, METH_VARARGS},
351 {NULL, NULL} /* sentinel */
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000352};
Raymond Hettinger48165d42002-06-05 20:08:48 +0000353
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000354PyTypeObject PyRange_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000355 PyVarObject_HEAD_INIT(&PyType_Type, 0)
356 "range", /* Name of this type */
357 sizeof(rangeobject), /* Basic object size */
358 0, /* Item size for varobject */
359 (destructor)range_dealloc, /* tp_dealloc */
360 0, /* tp_print */
361 0, /* tp_getattr */
362 0, /* tp_setattr */
363 0, /* tp_reserved */
364 (reprfunc)range_repr, /* tp_repr */
365 0, /* tp_as_number */
366 &range_as_sequence, /* tp_as_sequence */
367 0, /* tp_as_mapping */
368 0, /* tp_hash */
369 0, /* tp_call */
370 0, /* tp_str */
371 PyObject_GenericGetAttr, /* tp_getattro */
372 0, /* tp_setattro */
373 0, /* tp_as_buffer */
374 Py_TPFLAGS_DEFAULT, /* tp_flags */
375 range_doc, /* tp_doc */
376 0, /* tp_traverse */
377 0, /* tp_clear */
378 0, /* tp_richcompare */
379 0, /* tp_weaklistoffset */
380 range_iter, /* tp_iter */
381 0, /* tp_iternext */
382 range_methods, /* tp_methods */
383 0, /* tp_members */
384 0, /* tp_getset */
385 0, /* tp_base */
386 0, /* tp_dict */
387 0, /* tp_descr_get */
388 0, /* tp_descr_set */
389 0, /* tp_dictoffset */
390 0, /* tp_init */
391 0, /* tp_alloc */
392 range_new, /* tp_new */
Guido van Rossum12d12c51993-10-26 17:58:25 +0000393};
Raymond Hettinger48165d42002-06-05 20:08:48 +0000394
Walter Dörwald4ad94212007-05-21 18:01:17 +0000395/*********************** range Iterator **************************/
Raymond Hettinger48165d42002-06-05 20:08:48 +0000396
Guido van Rossum805365e2007-05-07 22:24:25 +0000397/* There are 2 types of iterators, one for C longs, the other for
398 Python longs (ie, PyObjects). This should make iteration fast
399 in the normal case, but possible for any numeric value.
400*/
401
Raymond Hettinger48165d42002-06-05 20:08:48 +0000402typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000403 PyObject_HEAD
404 long index;
405 long start;
406 long step;
407 long len;
Raymond Hettinger48165d42002-06-05 20:08:48 +0000408} rangeiterobject;
409
Raymond Hettinger85c20a42003-11-06 14:06:48 +0000410static PyObject *
Raymond Hettinger48165d42002-06-05 20:08:48 +0000411rangeiter_next(rangeiterobject *r)
412{
Guido van Rossum805365e2007-05-07 22:24:25 +0000413 if (r->index < r->len)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000414 /* cast to unsigned to avoid possible signed overflow
Mark Dickinsonb43dbc22009-11-15 12:56:08 +0000415 in intermediate calculations. */
416 return PyLong_FromLong((long)(r->start +
417 (unsigned long)(r->index++) * r->step));
Guido van Rossum805365e2007-05-07 22:24:25 +0000418 return NULL;
Raymond Hettinger48165d42002-06-05 20:08:48 +0000419}
420
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000421static PyObject *
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000422rangeiter_len(rangeiterobject *r)
423{
Christian Heimes217cfd12007-12-02 14:31:20 +0000424 return PyLong_FromLong(r->len - r->index);
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000425}
426
Guido van Rossum805365e2007-05-07 22:24:25 +0000427typedef struct {
428 PyObject_HEAD
429 PyObject *index;
430 PyObject *start;
431 PyObject *step;
432 PyObject *len;
433} longrangeiterobject;
434
435static PyObject *
436longrangeiter_len(longrangeiterobject *r, PyObject *no_args)
437{
438 return PyNumber_Subtract(r->len, r->index);
439}
Guido van Rossum317e7742007-05-08 15:18:31 +0000440
Guido van Rossum805365e2007-05-07 22:24:25 +0000441static PyObject *rangeiter_new(PyTypeObject *, PyObject *args, PyObject *kw);
442
443PyDoc_STRVAR(length_hint_doc,
444 "Private method returning an estimate of len(list(it)).");
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000445
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000446static PyMethodDef rangeiter_methods[] = {
Guido van Rossum805365e2007-05-07 22:24:25 +0000447 {"__length_hint__", (PyCFunction)rangeiter_len, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000448 length_hint_doc},
449 {NULL, NULL} /* sentinel */
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000450};
Raymond Hettingeref9bf402004-03-10 10:10:42 +0000451
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000452PyTypeObject PyRangeIter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000453 PyVarObject_HEAD_INIT(&PyType_Type, 0)
454 "range_iterator", /* tp_name */
455 sizeof(rangeiterobject), /* tp_basicsize */
456 0, /* tp_itemsize */
457 /* methods */
458 (destructor)PyObject_Del, /* tp_dealloc */
459 0, /* tp_print */
460 0, /* tp_getattr */
461 0, /* tp_setattr */
462 0, /* tp_reserved */
463 0, /* tp_repr */
464 0, /* tp_as_number */
465 0, /* tp_as_sequence */
466 0, /* tp_as_mapping */
467 0, /* tp_hash */
468 0, /* tp_call */
469 0, /* tp_str */
470 PyObject_GenericGetAttr, /* tp_getattro */
471 0, /* tp_setattro */
472 0, /* tp_as_buffer */
473 Py_TPFLAGS_DEFAULT, /* tp_flags */
474 0, /* tp_doc */
475 0, /* tp_traverse */
476 0, /* tp_clear */
477 0, /* tp_richcompare */
478 0, /* tp_weaklistoffset */
479 PyObject_SelfIter, /* tp_iter */
480 (iternextfunc)rangeiter_next, /* tp_iternext */
481 rangeiter_methods, /* tp_methods */
482 0, /* tp_members */
483 0, /* tp_getset */
484 0, /* tp_base */
485 0, /* tp_dict */
486 0, /* tp_descr_get */
487 0, /* tp_descr_set */
488 0, /* tp_dictoffset */
489 0, /* tp_init */
490 0, /* tp_alloc */
491 rangeiter_new, /* tp_new */
Guido van Rossum805365e2007-05-07 22:24:25 +0000492};
493
Mark Dickinsond550c9a2009-11-15 09:57:26 +0000494/* Return number of items in range (lo, hi, step). step != 0
495 * required. The result always fits in an unsigned long.
Guido van Rossum805365e2007-05-07 22:24:25 +0000496 */
Mark Dickinsond550c9a2009-11-15 09:57:26 +0000497static unsigned long
Guido van Rossum805365e2007-05-07 22:24:25 +0000498get_len_of_range(long lo, long hi, long step)
499{
500 /* -------------------------------------------------------------
Mark Dickinsond550c9a2009-11-15 09:57:26 +0000501 If step > 0 and lo >= hi, or step < 0 and lo <= hi, the range is empty.
502 Else for step > 0, if n values are in the range, the last one is
Guido van Rossum805365e2007-05-07 22:24:25 +0000503 lo + (n-1)*step, which must be <= hi-1. Rearranging,
504 n <= (hi - lo - 1)/step + 1, so taking the floor of the RHS gives
505 the proper value. Since lo < hi in this case, hi-lo-1 >= 0, so
506 the RHS is non-negative and so truncation is the same as the
507 floor. Letting M be the largest positive long, the worst case
508 for the RHS numerator is hi=M, lo=-M-1, and then
509 hi-lo-1 = M-(-M-1)-1 = 2*M. Therefore unsigned long has enough
Mark Dickinsond550c9a2009-11-15 09:57:26 +0000510 precision to compute the RHS exactly. The analysis for step < 0
511 is similar.
Guido van Rossum805365e2007-05-07 22:24:25 +0000512 ---------------------------------------------------------------*/
Mark Dickinsond550c9a2009-11-15 09:57:26 +0000513 assert(step != 0);
514 if (step > 0 && lo < hi)
515 return 1UL + (hi - 1UL - lo) / step;
516 else if (step < 0 && lo > hi)
517 return 1UL + (lo - 1UL - hi) / (0UL - step);
518 else
519 return 0UL;
Guido van Rossum805365e2007-05-07 22:24:25 +0000520}
521
Mark Dickinsond550c9a2009-11-15 09:57:26 +0000522/* Initialize a rangeiter object. If the length of the rangeiter object
523 is not representable as a C long, OverflowError is raised. */
524
Guido van Rossum805365e2007-05-07 22:24:25 +0000525static PyObject *
526int_range_iter(long start, long stop, long step)
527{
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000528 rangeiterobject *it = PyObject_New(rangeiterobject, &PyRangeIter_Type);
Mark Dickinsond550c9a2009-11-15 09:57:26 +0000529 unsigned long ulen;
Guido van Rossum805365e2007-05-07 22:24:25 +0000530 if (it == NULL)
531 return NULL;
532 it->start = start;
533 it->step = step;
Mark Dickinsond550c9a2009-11-15 09:57:26 +0000534 ulen = get_len_of_range(start, stop, step);
535 if (ulen > (unsigned long)LONG_MAX) {
Benjamin Peterson36fbb732009-11-16 00:34:25 +0000536 Py_DECREF(it);
Mark Dickinsond550c9a2009-11-15 09:57:26 +0000537 PyErr_SetString(PyExc_OverflowError,
538 "range too large to represent as a range_iterator");
539 return NULL;
540 }
541 it->len = (long)ulen;
Guido van Rossum805365e2007-05-07 22:24:25 +0000542 it->index = 0;
543 return (PyObject *)it;
544}
545
546static PyObject *
547rangeiter_new(PyTypeObject *type, PyObject *args, PyObject *kw)
548{
549 long start, stop, step;
550
551 if (!_PyArg_NoKeywords("rangeiter()", kw))
552 return NULL;
553
554 if (!PyArg_ParseTuple(args, "lll;rangeiter() requires 3 int arguments",
555 &start, &stop, &step))
556 return NULL;
557
558 return int_range_iter(start, stop, step);
559}
560
561static PyMethodDef longrangeiter_methods[] = {
562 {"__length_hint__", (PyCFunction)longrangeiter_len, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000563 length_hint_doc},
564 {NULL, NULL} /* sentinel */
Guido van Rossum805365e2007-05-07 22:24:25 +0000565};
566
567static void
568longrangeiter_dealloc(longrangeiterobject *r)
569{
570 Py_XDECREF(r->index);
Guido van Rossum317e7742007-05-08 15:18:31 +0000571 Py_XDECREF(r->start);
572 Py_XDECREF(r->step);
573 Py_XDECREF(r->len);
Amaury Forgeot d'Arcb7f17e42007-11-15 20:52:21 +0000574 PyObject_Del(r);
Guido van Rossum805365e2007-05-07 22:24:25 +0000575}
576
577static PyObject *
578longrangeiter_next(longrangeiterobject *r)
579{
580 PyObject *one, *product, *new_index, *result;
581 if (PyObject_RichCompareBool(r->index, r->len, Py_LT) != 1)
582 return NULL;
583
584 one = PyLong_FromLong(1);
585 if (!one)
586 return NULL;
587
Guido van Rossum805365e2007-05-07 22:24:25 +0000588 new_index = PyNumber_Add(r->index, one);
589 Py_DECREF(one);
Benjamin Peterson36fbb732009-11-16 00:34:25 +0000590 if (!new_index)
591 return NULL;
592
593 product = PyNumber_Multiply(r->index, r->step);
594 if (!product) {
595 Py_DECREF(new_index);
Guido van Rossum805365e2007-05-07 22:24:25 +0000596 return NULL;
597 }
598
599 result = PyNumber_Add(r->start, product);
600 Py_DECREF(product);
601 if (result) {
602 Py_DECREF(r->index);
603 r->index = new_index;
604 }
Benjamin Peterson36fbb732009-11-16 00:34:25 +0000605 else {
606 Py_DECREF(new_index);
607 }
Guido van Rossum805365e2007-05-07 22:24:25 +0000608
609 return result;
610}
611
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000612PyTypeObject PyLongRangeIter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000613 PyVarObject_HEAD_INIT(&PyType_Type, 0)
614 "longrange_iterator", /* tp_name */
615 sizeof(longrangeiterobject), /* tp_basicsize */
616 0, /* tp_itemsize */
617 /* methods */
618 (destructor)longrangeiter_dealloc, /* tp_dealloc */
619 0, /* tp_print */
620 0, /* tp_getattr */
621 0, /* tp_setattr */
622 0, /* tp_reserved */
623 0, /* tp_repr */
624 0, /* tp_as_number */
625 0, /* tp_as_sequence */
626 0, /* tp_as_mapping */
627 0, /* tp_hash */
628 0, /* tp_call */
629 0, /* tp_str */
630 PyObject_GenericGetAttr, /* tp_getattro */
631 0, /* tp_setattro */
632 0, /* tp_as_buffer */
633 Py_TPFLAGS_DEFAULT, /* tp_flags */
634 0, /* tp_doc */
635 0, /* tp_traverse */
636 0, /* tp_clear */
637 0, /* tp_richcompare */
638 0, /* tp_weaklistoffset */
639 PyObject_SelfIter, /* tp_iter */
640 (iternextfunc)longrangeiter_next, /* tp_iternext */
641 longrangeiter_methods, /* tp_methods */
642 0,
Raymond Hettinger48165d42002-06-05 20:08:48 +0000643};
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000644
645static PyObject *
646range_iter(PyObject *seq)
647{
Guido van Rossum805365e2007-05-07 22:24:25 +0000648 rangeobject *r = (rangeobject *)seq;
649 longrangeiterobject *it;
Martin v. Löwis84451042007-12-20 22:57:23 +0000650 long lstart, lstop, lstep;
Mark Dickinsond550c9a2009-11-15 09:57:26 +0000651 PyObject *int_it;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000652
Guido van Rossum805365e2007-05-07 22:24:25 +0000653 assert(PyRange_Check(seq));
Martin v. Löwis84451042007-12-20 22:57:23 +0000654
Mark Dickinsond550c9a2009-11-15 09:57:26 +0000655 /* If all three fields and the length convert to long, use the int
656 * version */
Martin v. Löwis84451042007-12-20 22:57:23 +0000657 lstart = PyLong_AsLong(r->start);
Mark Dickinsond550c9a2009-11-15 09:57:26 +0000658 if (lstart == -1 && PyErr_Occurred()) {
659 PyErr_Clear();
660 goto long_range;
Martin v. Löwis84451042007-12-20 22:57:23 +0000661 }
Mark Dickinsond550c9a2009-11-15 09:57:26 +0000662 lstop = PyLong_AsLong(r->stop);
663 if (lstop == -1 && PyErr_Occurred()) {
664 PyErr_Clear();
665 goto long_range;
666 }
667 lstep = PyLong_AsLong(r->step);
668 if (lstep == -1 && PyErr_Occurred()) {
669 PyErr_Clear();
670 goto long_range;
671 }
Mark Dickinsond550c9a2009-11-15 09:57:26 +0000672 int_it = int_range_iter(lstart, lstop, lstep);
673 if (int_it == NULL && PyErr_ExceptionMatches(PyExc_OverflowError)) {
674 PyErr_Clear();
675 goto long_range;
676 }
677 return (PyObject *)int_it;
678
679 long_range:
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000680 it = PyObject_New(longrangeiterobject, &PyLongRangeIter_Type);
Guido van Rossum805365e2007-05-07 22:24:25 +0000681 if (it == NULL)
682 return NULL;
Guido van Rossum317e7742007-05-08 15:18:31 +0000683
684 /* Do all initialization here, so we can DECREF on failure. */
Guido van Rossum805365e2007-05-07 22:24:25 +0000685 it->start = r->start;
Guido van Rossum317e7742007-05-08 15:18:31 +0000686 it->step = r->step;
687 Py_INCREF(it->start);
688 Py_INCREF(it->step);
689
690 it->len = it->index = NULL;
691
Mark Dickinsoneb36d312009-06-24 18:36:46 +0000692 it->len = range_length_obj(r);
693 if (!it->len)
Guido van Rossum805365e2007-05-07 22:24:25 +0000694 goto create_failure;
Guido van Rossum805365e2007-05-07 22:24:25 +0000695 it->index = PyLong_FromLong(0);
696 if (!it->index)
697 goto create_failure;
698
Guido van Rossum805365e2007-05-07 22:24:25 +0000699 return (PyObject *)it;
700
701create_failure:
Guido van Rossum317e7742007-05-08 15:18:31 +0000702 Py_DECREF(it);
Guido van Rossum805365e2007-05-07 22:24:25 +0000703 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000704}
705
706static PyObject *
707range_reverse(PyObject *seq)
708{
Guido van Rossum805365e2007-05-07 22:24:25 +0000709 rangeobject *range = (rangeobject*) seq;
710 longrangeiterobject *it;
711 PyObject *one, *sum, *diff, *len = NULL, *product;
Mark Dickinsond550c9a2009-11-15 09:57:26 +0000712 long lstart, lstop, lstep, new_start, new_stop;
713 unsigned long ulen;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000714
Guido van Rossum805365e2007-05-07 22:24:25 +0000715 assert(PyRange_Check(seq));
Martin v. Löwis84451042007-12-20 22:57:23 +0000716
Mark Dickinsond550c9a2009-11-15 09:57:26 +0000717 /* reversed(range(start, stop, step)) can be expressed as
718 range(start+(n-1)*step, start-step, -step), where n is the number of
719 integers in the range.
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000720
Mark Dickinsond550c9a2009-11-15 09:57:26 +0000721 If each of start, stop, step, -step, start-step, and the length
722 of the iterator is representable as a C long, use the int
723 version. This excludes some cases where the reversed range is
724 representable as a range_iterator, but it's good enough for
725 common cases and it makes the checks simple. */
726
727 lstart = PyLong_AsLong(range->start);
728 if (lstart == -1 && PyErr_Occurred()) {
729 PyErr_Clear();
730 goto long_range;
731 }
732 lstop = PyLong_AsLong(range->stop);
733 if (lstop == -1 && PyErr_Occurred()) {
734 PyErr_Clear();
735 goto long_range;
736 }
737 lstep = PyLong_AsLong(range->step);
738 if (lstep == -1 && PyErr_Occurred()) {
739 PyErr_Clear();
740 goto long_range;
741 }
742 /* check for possible overflow of -lstep */
743 if (lstep == LONG_MIN)
744 goto long_range;
745
746 /* check for overflow of lstart - lstep:
747
748 for lstep > 0, need only check whether lstart - lstep < LONG_MIN.
749 for lstep < 0, need only check whether lstart - lstep > LONG_MAX
750
751 Rearrange these inequalities as:
752
753 lstart - LONG_MIN < lstep (lstep > 0)
754 LONG_MAX - lstart < -lstep (lstep < 0)
755
756 and compute both sides as unsigned longs, to avoid the
757 possibility of undefined behaviour due to signed overflow. */
758
759 if (lstep > 0) {
760 if ((unsigned long)lstart - LONG_MIN < (unsigned long)lstep)
761 goto long_range;
762 }
763 else {
764 if (LONG_MAX - (unsigned long)lstart < 0UL - lstep)
765 goto long_range;
766 }
767
Mark Dickinsond550c9a2009-11-15 09:57:26 +0000768 ulen = get_len_of_range(lstart, lstop, lstep);
769 if (ulen > (unsigned long)LONG_MAX)
770 goto long_range;
771
772 new_stop = lstart - lstep;
773 new_start = (long)(new_stop + ulen * lstep);
774 return int_range_iter(new_start, new_stop, -lstep);
775
776long_range:
Christian Heimesa22e8bd2007-11-29 22:35:39 +0000777 it = PyObject_New(longrangeiterobject, &PyLongRangeIter_Type);
Guido van Rossum805365e2007-05-07 22:24:25 +0000778 if (it == NULL)
779 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000780
Guido van Rossum805365e2007-05-07 22:24:25 +0000781 /* start + (len - 1) * step */
782 len = range_length_obj(range);
783 if (!len)
784 goto create_failure;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000785
Benjamin Peterson36fbb732009-11-16 00:34:25 +0000786 /* Steal reference to len. */
787 it->len = len;
788
Guido van Rossum805365e2007-05-07 22:24:25 +0000789 one = PyLong_FromLong(1);
790 if (!one)
791 goto create_failure;
792
793 diff = PyNumber_Subtract(len, one);
794 Py_DECREF(one);
795 if (!diff)
796 goto create_failure;
797
Mark Dickinsond550c9a2009-11-15 09:57:26 +0000798 product = PyNumber_Multiply(diff, range->step);
799 Py_DECREF(diff);
Guido van Rossum805365e2007-05-07 22:24:25 +0000800 if (!product)
801 goto create_failure;
802
803 sum = PyNumber_Add(range->start, product);
804 Py_DECREF(product);
805 it->start = sum;
806 if (!it->start)
807 goto create_failure;
Mark Dickinsond550c9a2009-11-15 09:57:26 +0000808
Guido van Rossum805365e2007-05-07 22:24:25 +0000809 it->step = PyNumber_Negative(range->step);
Benjamin Peterson36fbb732009-11-16 00:34:25 +0000810 if (!it->step)
Mark Dickinsond550c9a2009-11-15 09:57:26 +0000811 goto create_failure;
Guido van Rossum805365e2007-05-07 22:24:25 +0000812
813 it->index = PyLong_FromLong(0);
Benjamin Peterson36fbb732009-11-16 00:34:25 +0000814 if (!it->index)
815 goto create_failure;
Guido van Rossum805365e2007-05-07 22:24:25 +0000816
817 return (PyObject *)it;
818
819create_failure:
Benjamin Peterson36fbb732009-11-16 00:34:25 +0000820 Py_DECREF(it);
Guido van Rossum805365e2007-05-07 22:24:25 +0000821 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000822}