blob: cec38f03153f4e4293eb0b17a6ea1db634e2d379 [file] [log] [blame]
Guido van Rossum12d12c51993-10-26 17:58:25 +00001
2/* Range object implementation */
3
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004#include "Python.h"
Fred Drake0b796fa2000-11-08 19:42:43 +00005#include "structmember.h"
6#include <string.h>
Guido van Rossum12d12c51993-10-26 17:58:25 +00007
8typedef struct {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00009 PyObject_HEAD
Guido van Rossum12d12c51993-10-26 17:58:25 +000010 long start;
11 long step;
12 long len;
Guido van Rossum7d6aa511993-12-21 22:50:31 +000013 int reps;
Guido van Rossum65e0b992001-01-15 18:58:56 +000014 long totlen;
Guido van Rossum12d12c51993-10-26 17:58:25 +000015} rangeobject;
16
Guido van Rossum65e0b992001-01-15 18:58:56 +000017static int
18long_mul(long i, long j, long *kk)
19{
20 PyObject *a;
21 PyObject *b;
22 PyObject *c;
23
24 if ((a = PyInt_FromLong(i)) == NULL)
25 return 0;
26
27 if ((b = PyInt_FromLong(j)) == NULL)
28 return 0;
29
30 c = PyNumber_Multiply(a, b);
31
32 Py_DECREF(a);
33 Py_DECREF(b);
34
35 if (c == NULL)
36 return 0;
37
38 *kk = PyInt_AS_LONG(c);
39 Py_DECREF(c);
40
41 if (*kk > INT_MAX) {
42 PyErr_SetString(PyExc_OverflowError,
43 "integer multiplication");
44 return 0;
45 }
46 else
47 return 1;
48}
Guido van Rossum12d12c51993-10-26 17:58:25 +000049
Guido van Rossumc0b618a1997-05-02 03:12:38 +000050PyObject *
Fred Drake45cfbcc2000-07-09 06:21:27 +000051PyRange_New(long start, long len, long step, int reps)
Guido van Rossum12d12c51993-10-26 17:58:25 +000052{
Guido van Rossum65e0b992001-01-15 18:58:56 +000053 long totlen = -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +000054 rangeobject *obj = PyObject_NEW(rangeobject, &PyRange_Type);
Guido van Rossum12d12c51993-10-26 17:58:25 +000055
Guido van Rossum9e8f4ea2000-12-14 14:59:53 +000056 if (obj == NULL)
57 return NULL;
58
Guido van Rossum65e0b992001-01-15 18:58:56 +000059 if (len == 0 || reps <= 0) {
60 start = 0;
61 len = 0;
62 step = 1;
63 reps = 1;
64 totlen = 0;
65 }
66 else {
67 long last = start + (len - 1) * step;
68 if ((step > 0) ?
69 (last > (PyInt_GetMax() - step))
70 :(last < (-1 - PyInt_GetMax() - step))) {
71 PyErr_SetString(PyExc_OverflowError,
72 "integer addition");
73 return NULL;
74 }
75 if (! long_mul(len, (long) reps, &totlen)) {
76 if(!PyErr_ExceptionMatches(PyExc_OverflowError))
77 return NULL;
78 PyErr_Clear();
79 totlen = -1;
80 }
81 }
82
Guido van Rossum12d12c51993-10-26 17:58:25 +000083 obj->start = start;
84 obj->len = len;
85 obj->step = step;
Guido van Rossum7d6aa511993-12-21 22:50:31 +000086 obj->reps = reps;
Guido van Rossum65e0b992001-01-15 18:58:56 +000087 obj->totlen = totlen;
Guido van Rossum12d12c51993-10-26 17:58:25 +000088
Guido van Rossumc0b618a1997-05-02 03:12:38 +000089 return (PyObject *) obj;
Guido van Rossum12d12c51993-10-26 17:58:25 +000090}
91
92static void
Fred Drake45cfbcc2000-07-09 06:21:27 +000093range_dealloc(rangeobject *r)
Guido van Rossum12d12c51993-10-26 17:58:25 +000094{
Guido van Rossumb18618d2000-05-03 23:44:39 +000095 PyObject_DEL(r);
Guido van Rossum12d12c51993-10-26 17:58:25 +000096}
97
Guido van Rossumc0b618a1997-05-02 03:12:38 +000098static PyObject *
Fred Drake45cfbcc2000-07-09 06:21:27 +000099range_item(rangeobject *r, int i)
Guido van Rossum12d12c51993-10-26 17:58:25 +0000100{
Guido van Rossum65e0b992001-01-15 18:58:56 +0000101 if (i < 0 || i >= r->totlen)
102 if (r->totlen!=-1) {
103 PyErr_SetString(PyExc_IndexError,
Guido van Rossum5dadf7e1999-01-09 21:40:35 +0000104 "xrange object index out of range");
Guido van Rossum65e0b992001-01-15 18:58:56 +0000105 return NULL;
106 }
Guido van Rossum12d12c51993-10-26 17:58:25 +0000107
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000108 return PyInt_FromLong(r->start + (i % r->len) * r->step);
Guido van Rossum12d12c51993-10-26 17:58:25 +0000109}
110
111static int
Fred Drake45cfbcc2000-07-09 06:21:27 +0000112range_length(rangeobject *r)
Guido van Rossum12d12c51993-10-26 17:58:25 +0000113{
Guido van Rossum65e0b992001-01-15 18:58:56 +0000114 if (r->totlen == -1)
115 PyErr_SetString(PyExc_OverflowError,
116 "xrange object has too many items");
117 return r->totlen;
Guido van Rossum7d6aa511993-12-21 22:50:31 +0000118}
119
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000120static PyObject *
Fred Drake45cfbcc2000-07-09 06:21:27 +0000121range_repr(rangeobject *r)
Guido van Rossum12d12c51993-10-26 17:58:25 +0000122{
Tim Peters72d421b2000-08-04 03:05:40 +0000123 /* buffers must be big enough to hold 3 longs + an int +
124 * a bit of "(xrange(...) * ...)" text.
125 */
126 char buf1[250];
127 char buf2[250];
Fred Drake2b83b462000-08-03 17:43:02 +0000128
Tim Peters72d421b2000-08-04 03:05:40 +0000129 if (r->start == 0 && r->step == 1)
Fred Drakec76e0e52000-08-04 02:34:41 +0000130 sprintf(buf1, "xrange(%ld)", r->start + r->len * r->step);
Tim Peters72d421b2000-08-04 03:05:40 +0000131
132 else if (r->step == 1)
133 sprintf(buf1, "xrange(%ld, %ld)",
134 r->start,
135 r->start + r->len * r->step);
136
137 else
138 sprintf(buf1, "xrange(%ld, %ld, %ld)",
Fred Drakec76e0e52000-08-04 02:34:41 +0000139 r->start,
140 r->start + r->len * r->step,
141 r->step);
Tim Peters72d421b2000-08-04 03:05:40 +0000142
143 if (r->reps != 1)
Fred Drakec76e0e52000-08-04 02:34:41 +0000144 sprintf(buf2, "(%s * %d)", buf1, r->reps);
Tim Peters72d421b2000-08-04 03:05:40 +0000145
Fred Drake2b83b462000-08-03 17:43:02 +0000146 return PyString_FromString(r->reps == 1 ? buf1 : buf2);
Guido van Rossum12d12c51993-10-26 17:58:25 +0000147}
148
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000149static PyObject *
Fred Drake45cfbcc2000-07-09 06:21:27 +0000150range_concat(rangeobject *r, PyObject *obj)
Guido van Rossum7d6aa511993-12-21 22:50:31 +0000151{
Guido van Rossum5dadf7e1999-01-09 21:40:35 +0000152 PyErr_SetString(PyExc_TypeError, "cannot concatenate xrange objects");
Guido van Rossum7d6aa511993-12-21 22:50:31 +0000153 return NULL;
154}
155
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000156static PyObject *
Fred Drake45cfbcc2000-07-09 06:21:27 +0000157range_repeat(rangeobject *r, int n)
Guido van Rossum7d6aa511993-12-21 22:50:31 +0000158{
Guido van Rossum65e0b992001-01-15 18:58:56 +0000159 long lreps = 0;
160
161 if (n <= 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000162 return (PyObject *) PyRange_New(0, 0, 1, 1);
Guido van Rossum7d6aa511993-12-21 22:50:31 +0000163
164 else if (n == 1) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000165 Py_INCREF(r);
166 return (PyObject *) r;
Guido van Rossum7d6aa511993-12-21 22:50:31 +0000167 }
168
Guido van Rossum65e0b992001-01-15 18:58:56 +0000169 else if (! long_mul((long) r->reps, (long) n, &lreps))
170 return NULL;
171
Guido van Rossum7d6aa511993-12-21 22:50:31 +0000172 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000173 return (PyObject *) PyRange_New(
Guido van Rossum7d6aa511993-12-21 22:50:31 +0000174 r->start,
175 r->len,
176 r->step,
Guido van Rossum65e0b992001-01-15 18:58:56 +0000177 (int) lreps);
Guido van Rossum7d6aa511993-12-21 22:50:31 +0000178}
179
Guido van Rossum12d12c51993-10-26 17:58:25 +0000180static int
Fred Drake45cfbcc2000-07-09 06:21:27 +0000181range_compare(rangeobject *r1, rangeobject *r2)
Guido van Rossum12d12c51993-10-26 17:58:25 +0000182{
183 if (r1->start != r2->start)
184 return r1->start - r2->start;
185
186 else if (r1->step != r2->step)
187 return r1->step - r2->step;
188
189 else if (r1->len != r2->len)
190 return r1->len - r2->len;
Guido van Rossum7d6aa511993-12-21 22:50:31 +0000191
192 else
193 return r1->reps - r2->reps;
Guido van Rossum12d12c51993-10-26 17:58:25 +0000194}
195
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000196static PyObject *
Fred Drake45cfbcc2000-07-09 06:21:27 +0000197range_slice(rangeobject *r, int low, int high)
Guido van Rossum12d12c51993-10-26 17:58:25 +0000198{
Guido van Rossum7d6aa511993-12-21 22:50:31 +0000199 if (r->reps != 1) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000200 PyErr_SetString(PyExc_TypeError,
Guido van Rossum5dadf7e1999-01-09 21:40:35 +0000201 "cannot slice a replicated xrange");
Guido van Rossum7d6aa511993-12-21 22:50:31 +0000202 return NULL;
203 }
204 if (low < 0)
205 low = 0;
206 else if (low > r->len)
207 low = r->len;
208 if (high < 0)
209 high = 0;
210 if (high < low)
211 high = low;
212 else if (high > r->len)
213 high = r->len;
214
215 if (low == 0 && high == r->len) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000216 Py_INCREF(r);
217 return (PyObject *) r;
Guido van Rossum7d6aa511993-12-21 22:50:31 +0000218 }
219
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000220 return (PyObject *) PyRange_New(
Guido van Rossum7d6aa511993-12-21 22:50:31 +0000221 low * r->step + r->start,
222 high - low,
223 r->step,
224 1);
Guido van Rossum2586bf01993-11-01 16:21:44 +0000225}
Guido van Rossum12d12c51993-10-26 17:58:25 +0000226
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000227static PyObject *
Fred Drake45cfbcc2000-07-09 06:21:27 +0000228range_tolist(rangeobject *self, PyObject *args)
Guido van Rossum2586bf01993-11-01 16:21:44 +0000229{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000230 PyObject *thelist;
Guido van Rossum7d6aa511993-12-21 22:50:31 +0000231 int j;
Guido van Rossum7d6aa511993-12-21 22:50:31 +0000232
Fred Drake2b83b462000-08-03 17:43:02 +0000233 if (! PyArg_ParseTuple(args, ":tolist"))
Guido van Rossum7d6aa511993-12-21 22:50:31 +0000234 return NULL;
235
Guido van Rossum65e0b992001-01-15 18:58:56 +0000236 if (self->totlen == -1)
237 return PyErr_NoMemory();
238
239 if ((thelist = PyList_New(self->totlen)) == NULL)
Guido van Rossum7d6aa511993-12-21 22:50:31 +0000240 return NULL;
241
Guido van Rossum65e0b992001-01-15 18:58:56 +0000242 for (j = 0; j < self->totlen; ++j)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000243 if ((PyList_SetItem(thelist, j, (PyObject *) PyInt_FromLong(
244 self->start + (j % self->len) * self->step))) < 0)
Guido van Rossum7d6aa511993-12-21 22:50:31 +0000245 return NULL;
246
247 return thelist;
Guido van Rossum2586bf01993-11-01 16:21:44 +0000248}
249
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000250static PyObject *
Fred Drake45cfbcc2000-07-09 06:21:27 +0000251range_getattr(rangeobject *r, char *name)
Guido van Rossum2586bf01993-11-01 16:21:44 +0000252{
Fred Drake0b796fa2000-11-08 19:42:43 +0000253 PyObject *result;
254
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000255 static PyMethodDef range_methods[] = {
Fred Drake2b83b462000-08-03 17:43:02 +0000256 {"tolist", (PyCFunction)range_tolist, METH_VARARGS,
257 "tolist() -> list\n"
258 "Return a list object with the same values."},
Guido van Rossum7d6aa511993-12-21 22:50:31 +0000259 {NULL, NULL}
260 };
Fred Drake0b796fa2000-11-08 19:42:43 +0000261 static struct memberlist range_members[] = {
262 {"step", T_LONG, offsetof(rangeobject, step), RO},
263 {"start", T_LONG, offsetof(rangeobject, start), RO},
264 {"stop", T_LONG, 0, RO},
265 {NULL, 0, 0, 0}
266 };
Guido van Rossum7d6aa511993-12-21 22:50:31 +0000267
Fred Drake0b796fa2000-11-08 19:42:43 +0000268 result = Py_FindMethod(range_methods, (PyObject *) r, name);
269 if (result == NULL) {
270 PyErr_Clear();
271 if (strcmp("stop", name) == 0)
272 result = PyInt_FromLong(r->start + (r->len * r->step));
273 else
274 result = PyMember_Get((char *)r, range_members, name);
275 }
276 return result;
Guido van Rossum12d12c51993-10-26 17:58:25 +0000277}
278
Fred Drake56780252000-06-15 14:50:20 +0000279static int
Fred Drake45cfbcc2000-07-09 06:21:27 +0000280range_contains(rangeobject *r, PyObject *obj)
Fred Drake56780252000-06-15 14:50:20 +0000281{
282 long num = PyInt_AsLong(obj);
Tim Peters72d421b2000-08-04 03:05:40 +0000283
Fred Drake56780252000-06-15 14:50:20 +0000284 if (num < 0 && PyErr_Occurred())
285 return -1;
Tim Peters72d421b2000-08-04 03:05:40 +0000286
Fred Drake0b796fa2000-11-08 19:42:43 +0000287 if (r->step > 0) {
288 if ((num < r->start) || ((num - r->start) % r->step))
289 return 0;
290 if (num >= (r->start + (r->len * r->step)))
291 return 0;
292 }
293 else {
294 if ((num > r->start) || ((num - r->start) % r->step))
295 return 0;
296 if (num <= (r->start + (r->len * r->step)))
297 return 0;
298 }
Fred Drake56780252000-06-15 14:50:20 +0000299 return 1;
300}
301
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000302static PySequenceMethods range_as_sequence = {
Fred Drake0b796fa2000-11-08 19:42:43 +0000303 (inquiry)range_length, /*sq_length*/
Guido van Rossum03093a21994-09-28 15:51:32 +0000304 (binaryfunc)range_concat, /*sq_concat*/
305 (intargfunc)range_repeat, /*sq_repeat*/
306 (intargfunc)range_item, /*sq_item*/
307 (intintargfunc)range_slice, /*sq_slice*/
Fred Drake0b796fa2000-11-08 19:42:43 +0000308 0, /*sq_ass_item*/
309 0, /*sq_ass_slice*/
Fred Drake56780252000-06-15 14:50:20 +0000310 (objobjproc)range_contains, /*sq_contains*/
Guido van Rossum12d12c51993-10-26 17:58:25 +0000311};
312
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000313PyTypeObject PyRange_Type = {
314 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum12d12c51993-10-26 17:58:25 +0000315 0, /* Number of items for varobject */
Guido van Rossum2586bf01993-11-01 16:21:44 +0000316 "xrange", /* Name of this type */
Guido van Rossum12d12c51993-10-26 17:58:25 +0000317 sizeof(rangeobject), /* Basic object size */
318 0, /* Item size for varobject */
Guido van Rossum03093a21994-09-28 15:51:32 +0000319 (destructor)range_dealloc, /*tp_dealloc*/
Fred Drake2b83b462000-08-03 17:43:02 +0000320 0, /*tp_print*/
Guido van Rossum03093a21994-09-28 15:51:32 +0000321 (getattrfunc)range_getattr, /*tp_getattr*/
Guido van Rossum12d12c51993-10-26 17:58:25 +0000322 0, /*tp_setattr*/
Guido van Rossum03093a21994-09-28 15:51:32 +0000323 (cmpfunc)range_compare, /*tp_compare*/
Fred Drake2b83b462000-08-03 17:43:02 +0000324 (reprfunc)range_repr, /*tp_repr*/
Guido van Rossum12d12c51993-10-26 17:58:25 +0000325 0, /*tp_as_number*/
326 &range_as_sequence, /*tp_as_sequence*/
327 0, /*tp_as_mapping*/
Fred Drake56780252000-06-15 14:50:20 +0000328 0, /*tp_hash*/
329 0, /*tp_call*/
330 0, /*tp_str*/
331 0, /*tp_getattro*/
332 0, /*tp_setattro*/
333 0, /*tp_as_buffer*/
334 Py_TPFLAGS_DEFAULT, /*tp_flags*/
Guido van Rossum12d12c51993-10-26 17:58:25 +0000335};