blob: 3915cc928b4f65ea329619195fc147628c233aea [file] [log] [blame]
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001/* List object implementation */
2
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003#include "Python.h"
4
Guido van Rossum6cd2fe01994-08-29 12:45:32 +00005#ifdef STDC_HEADERS
6#include <stddef.h>
7#else
8#include <sys/types.h> /* For size_t */
9#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000010
Guido van Rossuma46d51d1995-01-26 22:59:43 +000011static int
Fred Drakea2f55112000-07-09 15:16:51 +000012roundupsize(int n)
Guido van Rossuma46d51d1995-01-26 22:59:43 +000013{
Tim Peters65b8b842001-05-26 05:28:40 +000014 unsigned int nbits = 0;
15 unsigned int n2 = (unsigned int)n >> 5;
16
Tim Peters3b01a122002-07-19 02:35:45 +000017 /* Round up:
Tim Peters65b8b842001-05-26 05:28:40 +000018 * If n < 256, to a multiple of 8.
19 * If n < 2048, to a multiple of 64.
20 * If n < 16384, to a multiple of 512.
21 * If n < 131072, to a multiple of 4096.
22 * If n < 1048576, to a multiple of 32768.
23 * If n < 8388608, to a multiple of 262144.
24 * If n < 67108864, to a multiple of 2097152.
25 * If n < 536870912, to a multiple of 16777216.
26 * ...
27 * If n < 2**(5+3*i), to a multiple of 2**(3*i).
28 *
29 * This over-allocates proportional to the list size, making room
30 * for additional growth. The over-allocation is mild, but is
31 * enough to give linear-time amortized behavior over a long
32 * sequence of appends() in the presence of a poorly-performing
33 * system realloc() (which is a reality, e.g., across all flavors
34 * of Windows, with Win9x behavior being particularly bad -- and
35 * we've still got address space fragmentation problems on Win9x
36 * even with this scheme, although it requires much longer lists to
37 * provoke them than it used to).
38 */
39 do {
40 n2 >>= 3;
41 nbits += 3;
42 } while (n2);
43 return ((n >> nbits) + 1) << nbits;
44 }
Guido van Rossuma46d51d1995-01-26 22:59:43 +000045
Neal Norwitzd4e5be52002-05-22 23:19:17 +000046#define NRESIZE(var, type, nitems) \
47do { \
48 size_t _new_size = roundupsize(nitems); \
49 if (_new_size <= ((~(size_t)0) / sizeof(type))) \
50 PyMem_RESIZE(var, type, _new_size); \
51 else \
52 var = NULL; \
53} while (0)
Guido van Rossuma46d51d1995-01-26 22:59:43 +000054
Guido van Rossumc0b618a1997-05-02 03:12:38 +000055PyObject *
Fred Drakea2f55112000-07-09 15:16:51 +000056PyList_New(int size)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000057{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000058 PyListObject *op;
Guido van Rossum6cd2fe01994-08-29 12:45:32 +000059 size_t nbytes;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000060 if (size < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +000061 PyErr_BadInternalCall();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000062 return NULL;
63 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +000064 nbytes = size * sizeof(PyObject *);
Guido van Rossum1e28e5e1992-08-19 16:46:30 +000065 /* Check for overflow */
Guido van Rossumc0b618a1997-05-02 03:12:38 +000066 if (nbytes / sizeof(PyObject *) != (size_t)size) {
67 return PyErr_NoMemory();
Guido van Rossum1e28e5e1992-08-19 16:46:30 +000068 }
Neil Schemenauere83c00e2001-08-29 23:54:21 +000069 op = PyObject_GC_New(PyListObject, &PyList_Type);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000070 if (op == NULL) {
Neil Schemenauere83c00e2001-08-29 23:54:21 +000071 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000072 }
73 if (size <= 0) {
74 op->ob_item = NULL;
75 }
76 else {
Guido van Rossumb18618d2000-05-03 23:44:39 +000077 op->ob_item = (PyObject **) PyMem_MALLOC(nbytes);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000078 if (op->ob_item == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +000079 return PyErr_NoMemory();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000080 }
Neal Norwitz35fc7602002-06-13 21:11:11 +000081 memset(op->ob_item, 0, sizeof(*op->ob_item) * size);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000082 }
Neil Schemenauere83c00e2001-08-29 23:54:21 +000083 op->ob_size = size;
Neil Schemenauere83c00e2001-08-29 23:54:21 +000084 _PyObject_GC_TRACK(op);
Guido van Rossumc0b618a1997-05-02 03:12:38 +000085 return (PyObject *) op;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000086}
87
88int
Fred Drakea2f55112000-07-09 15:16:51 +000089PyList_Size(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000090{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000091 if (!PyList_Check(op)) {
92 PyErr_BadInternalCall();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000093 return -1;
94 }
95 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +000096 return ((PyListObject *)op) -> ob_size;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000097}
98
Guido van Rossumc0b618a1997-05-02 03:12:38 +000099static PyObject *indexerr;
Guido van Rossum929f1b81996-08-09 20:51:27 +0000100
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000101PyObject *
Fred Drakea2f55112000-07-09 15:16:51 +0000102PyList_GetItem(PyObject *op, int i)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000103{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000104 if (!PyList_Check(op)) {
105 PyErr_BadInternalCall();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000106 return NULL;
107 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000108 if (i < 0 || i >= ((PyListObject *)op) -> ob_size) {
Guido van Rossum929f1b81996-08-09 20:51:27 +0000109 if (indexerr == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000110 indexerr = PyString_FromString(
111 "list index out of range");
112 PyErr_SetObject(PyExc_IndexError, indexerr);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000113 return NULL;
114 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000115 return ((PyListObject *)op) -> ob_item[i];
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000116}
117
118int
Fred Drakea2f55112000-07-09 15:16:51 +0000119PyList_SetItem(register PyObject *op, register int i,
120 register PyObject *newitem)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000121{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000122 register PyObject *olditem;
123 register PyObject **p;
124 if (!PyList_Check(op)) {
125 Py_XDECREF(newitem);
126 PyErr_BadInternalCall();
Guido van Rossum2a9096b1990-10-21 22:15:08 +0000127 return -1;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000128 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000129 if (i < 0 || i >= ((PyListObject *)op) -> ob_size) {
130 Py_XDECREF(newitem);
131 PyErr_SetString(PyExc_IndexError,
132 "list assignment index out of range");
Guido van Rossum2a9096b1990-10-21 22:15:08 +0000133 return -1;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000134 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000135 p = ((PyListObject *)op) -> ob_item + i;
Guido van Rossum5fe60581995-03-09 12:12:50 +0000136 olditem = *p;
137 *p = newitem;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000138 Py_XDECREF(olditem);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000139 return 0;
140}
141
142static int
Fred Drakea2f55112000-07-09 15:16:51 +0000143ins1(PyListObject *self, int where, PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000144{
145 int i;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000146 PyObject **items;
Guido van Rossum2a9096b1990-10-21 22:15:08 +0000147 if (v == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000148 PyErr_BadInternalCall();
Guido van Rossum2a9096b1990-10-21 22:15:08 +0000149 return -1;
150 }
Trent Micka5846642000-08-13 22:47:45 +0000151 if (self->ob_size == INT_MAX) {
152 PyErr_SetString(PyExc_OverflowError,
153 "cannot add more objects to list");
154 return -1;
155 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000156 items = self->ob_item;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000157 NRESIZE(items, PyObject *, self->ob_size+1);
Guido van Rossum2a9096b1990-10-21 22:15:08 +0000158 if (items == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000159 PyErr_NoMemory();
Guido van Rossum2a9096b1990-10-21 22:15:08 +0000160 return -1;
161 }
Guido van Rossum3a3cca52003-04-14 20:58:14 +0000162 if (where < 0) {
163 where += self->ob_size;
164 if (where < 0)
165 where = 0;
166 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000167 if (where > self->ob_size)
168 where = self->ob_size;
169 for (i = self->ob_size; --i >= where; )
170 items[i+1] = items[i];
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000171 Py_INCREF(v);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000172 items[where] = v;
173 self->ob_item = items;
174 self->ob_size++;
175 return 0;
176}
177
178int
Fred Drakea2f55112000-07-09 15:16:51 +0000179PyList_Insert(PyObject *op, int where, PyObject *newitem)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000180{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000181 if (!PyList_Check(op)) {
182 PyErr_BadInternalCall();
Guido van Rossum2a9096b1990-10-21 22:15:08 +0000183 return -1;
184 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000185 return ins1((PyListObject *)op, where, newitem);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000186}
187
188int
Fred Drakea2f55112000-07-09 15:16:51 +0000189PyList_Append(PyObject *op, PyObject *newitem)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000190{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000191 if (!PyList_Check(op)) {
192 PyErr_BadInternalCall();
Guido van Rossum2a9096b1990-10-21 22:15:08 +0000193 return -1;
194 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000195 return ins1((PyListObject *)op,
196 (int) ((PyListObject *)op)->ob_size, newitem);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000197}
198
199/* Methods */
200
201static void
Fred Drakea2f55112000-07-09 15:16:51 +0000202list_dealloc(PyListObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000203{
204 int i;
Guido van Rossumff413af2002-03-28 20:34:59 +0000205 PyObject_GC_UnTrack(op);
Guido van Rossumd724b232000-03-13 16:01:29 +0000206 Py_TRASHCAN_SAFE_BEGIN(op)
Jack Jansen7874d1f1995-01-19 12:09:27 +0000207 if (op->ob_item != NULL) {
Guido van Rossumfa717011999-06-09 15:19:34 +0000208 /* Do it backwards, for Christian Tismer.
209 There's a simple test case where somehow this reduces
210 thrashing when a *very* large list is created and
211 immediately deleted. */
212 i = op->ob_size;
213 while (--i >= 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000214 Py_XDECREF(op->ob_item[i]);
Jack Jansen7874d1f1995-01-19 12:09:27 +0000215 }
Guido van Rossumb18618d2000-05-03 23:44:39 +0000216 PyMem_FREE(op->ob_item);
Jack Jansen7874d1f1995-01-19 12:09:27 +0000217 }
Guido van Rossum9475a232001-10-05 20:51:39 +0000218 op->ob_type->tp_free((PyObject *)op);
Guido van Rossumd724b232000-03-13 16:01:29 +0000219 Py_TRASHCAN_SAFE_END(op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000220}
221
Guido van Rossum90933611991-06-07 16:10:43 +0000222static int
Fred Drakea2f55112000-07-09 15:16:51 +0000223list_print(PyListObject *op, FILE *fp, int flags)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000224{
225 int i;
Guido van Rossumfb376de1998-04-10 22:47:27 +0000226
227 i = Py_ReprEnter((PyObject*)op);
228 if (i != 0) {
229 if (i < 0)
230 return i;
231 fprintf(fp, "[...]");
232 return 0;
233 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000234 fprintf(fp, "[");
Guido van Rossum90933611991-06-07 16:10:43 +0000235 for (i = 0; i < op->ob_size; i++) {
236 if (i > 0)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000237 fprintf(fp, ", ");
Guido van Rossumfb376de1998-04-10 22:47:27 +0000238 if (PyObject_Print(op->ob_item[i], fp, 0) != 0) {
239 Py_ReprLeave((PyObject *)op);
Guido van Rossum90933611991-06-07 16:10:43 +0000240 return -1;
Guido van Rossumfb376de1998-04-10 22:47:27 +0000241 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000242 }
243 fprintf(fp, "]");
Guido van Rossumfb376de1998-04-10 22:47:27 +0000244 Py_ReprLeave((PyObject *)op);
Guido van Rossum90933611991-06-07 16:10:43 +0000245 return 0;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000246}
247
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000248static PyObject *
Fred Drakea2f55112000-07-09 15:16:51 +0000249list_repr(PyListObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000250{
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000251 int i;
Tim Petersa7259592001-06-16 05:11:17 +0000252 PyObject *s, *temp;
253 PyObject *pieces = NULL, *result = NULL;
Guido van Rossumfb376de1998-04-10 22:47:27 +0000254
255 i = Py_ReprEnter((PyObject*)v);
256 if (i != 0) {
Tim Petersa7259592001-06-16 05:11:17 +0000257 return i > 0 ? PyString_FromString("[...]") : NULL;
Guido van Rossumfb376de1998-04-10 22:47:27 +0000258 }
Tim Petersa7259592001-06-16 05:11:17 +0000259
260 if (v->ob_size == 0) {
261 result = PyString_FromString("[]");
262 goto Done;
263 }
264
265 pieces = PyList_New(0);
266 if (pieces == NULL)
267 goto Done;
268
269 /* Do repr() on each element. Note that this may mutate the list,
270 so must refetch the list size on each iteration. */
271 for (i = 0; i < v->ob_size; ++i) {
272 int status;
273 s = PyObject_Repr(v->ob_item[i]);
274 if (s == NULL)
275 goto Done;
276 status = PyList_Append(pieces, s);
277 Py_DECREF(s); /* append created a new ref */
278 if (status < 0)
279 goto Done;
280 }
281
282 /* Add "[]" decorations to the first and last items. */
283 assert(PyList_GET_SIZE(pieces) > 0);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000284 s = PyString_FromString("[");
Tim Petersa7259592001-06-16 05:11:17 +0000285 if (s == NULL)
286 goto Done;
287 temp = PyList_GET_ITEM(pieces, 0);
288 PyString_ConcatAndDel(&s, temp);
289 PyList_SET_ITEM(pieces, 0, s);
290 if (s == NULL)
291 goto Done;
292
293 s = PyString_FromString("]");
294 if (s == NULL)
295 goto Done;
296 temp = PyList_GET_ITEM(pieces, PyList_GET_SIZE(pieces) - 1);
297 PyString_ConcatAndDel(&temp, s);
298 PyList_SET_ITEM(pieces, PyList_GET_SIZE(pieces) - 1, temp);
299 if (temp == NULL)
300 goto Done;
301
302 /* Paste them all together with ", " between. */
303 s = PyString_FromString(", ");
304 if (s == NULL)
305 goto Done;
306 result = _PyString_Join(s, pieces);
Tim Peters3b01a122002-07-19 02:35:45 +0000307 Py_DECREF(s);
Tim Petersa7259592001-06-16 05:11:17 +0000308
309Done:
310 Py_XDECREF(pieces);
Guido van Rossumfb376de1998-04-10 22:47:27 +0000311 Py_ReprLeave((PyObject *)v);
Tim Petersa7259592001-06-16 05:11:17 +0000312 return result;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000313}
314
315static int
Fred Drakea2f55112000-07-09 15:16:51 +0000316list_length(PyListObject *a)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000317{
318 return a->ob_size;
319}
320
Jeremy Hylton37b1a262000-04-27 21:41:03 +0000321
322
323static int
Fred Drakea2f55112000-07-09 15:16:51 +0000324list_contains(PyListObject *a, PyObject *el)
Jeremy Hylton37b1a262000-04-27 21:41:03 +0000325{
Raymond Hettingeraae59992002-09-05 14:23:49 +0000326 int i, cmp;
Jeremy Hylton37b1a262000-04-27 21:41:03 +0000327
Raymond Hettingeraae59992002-09-05 14:23:49 +0000328 for (i = 0, cmp = 0 ; cmp == 0 && i < a->ob_size; ++i)
329 cmp = PyObject_RichCompareBool(el, PyList_GET_ITEM(a, i),
Guido van Rossum65e1cea2001-01-17 22:11:59 +0000330 Py_EQ);
Neal Norwitzbb9c5f52002-09-05 21:32:55 +0000331 return cmp;
Jeremy Hylton37b1a262000-04-27 21:41:03 +0000332}
333
334
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000335static PyObject *
Fred Drakea2f55112000-07-09 15:16:51 +0000336list_item(PyListObject *a, int i)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000337{
338 if (i < 0 || i >= a->ob_size) {
Guido van Rossum929f1b81996-08-09 20:51:27 +0000339 if (indexerr == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000340 indexerr = PyString_FromString(
341 "list index out of range");
342 PyErr_SetObject(PyExc_IndexError, indexerr);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000343 return NULL;
344 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000345 Py_INCREF(a->ob_item[i]);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000346 return a->ob_item[i];
347}
348
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000349static PyObject *
Fred Drakea2f55112000-07-09 15:16:51 +0000350list_slice(PyListObject *a, int ilow, int ihigh)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000351{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000352 PyListObject *np;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000353 int i;
354 if (ilow < 0)
355 ilow = 0;
356 else if (ilow > a->ob_size)
357 ilow = a->ob_size;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000358 if (ihigh < ilow)
359 ihigh = ilow;
360 else if (ihigh > a->ob_size)
361 ihigh = a->ob_size;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000362 np = (PyListObject *) PyList_New(ihigh - ilow);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000363 if (np == NULL)
364 return NULL;
365 for (i = ilow; i < ihigh; i++) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000366 PyObject *v = a->ob_item[i];
367 Py_INCREF(v);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000368 np->ob_item[i - ilow] = v;
369 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000370 return (PyObject *)np;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000371}
372
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000373PyObject *
Fred Drakea2f55112000-07-09 15:16:51 +0000374PyList_GetSlice(PyObject *a, int ilow, int ihigh)
Guido van Rossum234f9421993-06-17 12:35:49 +0000375{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000376 if (!PyList_Check(a)) {
377 PyErr_BadInternalCall();
Guido van Rossum234f9421993-06-17 12:35:49 +0000378 return NULL;
379 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000380 return list_slice((PyListObject *)a, ilow, ihigh);
Guido van Rossum234f9421993-06-17 12:35:49 +0000381}
382
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000383static PyObject *
Fred Drakea2f55112000-07-09 15:16:51 +0000384list_concat(PyListObject *a, PyObject *bb)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000385{
386 int size;
387 int i;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000388 PyListObject *np;
389 if (!PyList_Check(bb)) {
Fred Drakeb6a9ada2000-06-01 03:12:13 +0000390 PyErr_Format(PyExc_TypeError,
Fred Drake914a2ed2000-06-01 14:31:03 +0000391 "can only concatenate list (not \"%.200s\") to list",
392 bb->ob_type->tp_name);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000393 return NULL;
394 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000395#define b ((PyListObject *)bb)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000396 size = a->ob_size + b->ob_size;
Guido van Rossuma5c0e6d2002-10-11 21:05:56 +0000397 if (size < 0)
398 return PyErr_NoMemory();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000399 np = (PyListObject *) PyList_New(size);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000400 if (np == NULL) {
Guido van Rossum90933611991-06-07 16:10:43 +0000401 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000402 }
403 for (i = 0; i < a->ob_size; i++) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000404 PyObject *v = a->ob_item[i];
405 Py_INCREF(v);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000406 np->ob_item[i] = v;
407 }
408 for (i = 0; i < b->ob_size; i++) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000409 PyObject *v = b->ob_item[i];
410 Py_INCREF(v);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000411 np->ob_item[i + a->ob_size] = v;
412 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000413 return (PyObject *)np;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000414#undef b
415}
416
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000417static PyObject *
Fred Drakea2f55112000-07-09 15:16:51 +0000418list_repeat(PyListObject *a, int n)
Guido van Rossumed98d481991-03-06 13:07:53 +0000419{
420 int i, j;
421 int size;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000422 PyListObject *np;
423 PyObject **p;
Raymond Hettinger6624e682003-05-21 05:58:46 +0000424 PyObject *elem;
Guido van Rossumed98d481991-03-06 13:07:53 +0000425 if (n < 0)
426 n = 0;
427 size = a->ob_size * n;
Raymond Hettinger6624e682003-05-21 05:58:46 +0000428 if (size == 0)
429 return PyList_New(0);
Guido van Rossumbfa5a142002-10-11 23:39:35 +0000430 if (n && size/n != a->ob_size)
Guido van Rossuma5c0e6d2002-10-11 21:05:56 +0000431 return PyErr_NoMemory();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000432 np = (PyListObject *) PyList_New(size);
Guido van Rossumed98d481991-03-06 13:07:53 +0000433 if (np == NULL)
434 return NULL;
Raymond Hettinger6624e682003-05-21 05:58:46 +0000435
436 if (a->ob_size == 1) {
437 elem = a->ob_item[0];
438 for (i = 0; i < n; i++) {
439 np->ob_item[i] = elem;
440 Py_INCREF(elem);
441 }
442 return (PyObject *) np;
443 }
Guido van Rossumed98d481991-03-06 13:07:53 +0000444 p = np->ob_item;
445 for (i = 0; i < n; i++) {
446 for (j = 0; j < a->ob_size; j++) {
447 *p = a->ob_item[j];
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000448 Py_INCREF(*p);
Guido van Rossumed98d481991-03-06 13:07:53 +0000449 p++;
450 }
451 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000452 return (PyObject *) np;
Guido van Rossumed98d481991-03-06 13:07:53 +0000453}
454
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000455static int
Fred Drakea2f55112000-07-09 15:16:51 +0000456list_ass_slice(PyListObject *a, int ilow, int ihigh, PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000457{
Guido van Rossumae7bf1a1995-01-17 10:21:11 +0000458 /* Because [X]DECREF can recursively invoke list operations on
459 this list, we must postpone all [X]DECREF activity until
460 after the list is back in its canonical shape. Therefore
461 we must allocate an additional array, 'recycle', into which
462 we temporarily copy the items that are deleted from the
463 list. :-( */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000464 PyObject **recycle, **p;
465 PyObject **item;
Michael W. Hudson5da854f2002-11-05 17:38:05 +0000466 PyObject *v_as_SF = NULL; /* PySequence_Fast(v) */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000467 int n; /* Size of replacement list */
468 int d; /* Change in size */
469 int k; /* Loop index */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000470#define b ((PyListObject *)v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000471 if (v == NULL)
472 n = 0;
Michael W. Hudson5da854f2002-11-05 17:38:05 +0000473 else {
474 char msg[256];
Guido van Rossum32dffaa1991-12-24 13:27:34 +0000475 if (a == b) {
476 /* Special case "a[i:j] = a" -- copy b first */
477 int ret;
Michael W. Hudsonda0a0672003-08-15 12:06:41 +0000478 v = list_slice(b, 0, b->ob_size);
Martin v. Löwiscd12bfc2003-05-03 10:53:08 +0000479 if (v == NULL)
480 return -1;
Guido van Rossum32dffaa1991-12-24 13:27:34 +0000481 ret = list_ass_slice(a, ilow, ihigh, v);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000482 Py_DECREF(v);
Guido van Rossum32dffaa1991-12-24 13:27:34 +0000483 return ret;
484 }
Michael W. Hudsonb4f49382003-08-14 17:04:28 +0000485
486 PyOS_snprintf(msg, sizeof(msg),
487 "must assign sequence"
488 " (not \"%.200s\") to slice",
489 v->ob_type->tp_name);
490 v_as_SF = PySequence_Fast(v, msg);
491 if(v_as_SF == NULL)
492 return -1;
493 n = PySequence_Fast_GET_SIZE(v_as_SF);
Guido van Rossum32dffaa1991-12-24 13:27:34 +0000494 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000495 if (ilow < 0)
496 ilow = 0;
497 else if (ilow > a->ob_size)
498 ilow = a->ob_size;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000499 if (ihigh < ilow)
500 ihigh = ilow;
501 else if (ihigh > a->ob_size)
502 ihigh = a->ob_size;
503 item = a->ob_item;
504 d = n - (ihigh-ilow);
Martin v. Löwiscd12bfc2003-05-03 10:53:08 +0000505 if (ihigh > ilow) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000506 p = recycle = PyMem_NEW(PyObject *, (ihigh-ilow));
Martin v. Löwiscd12bfc2003-05-03 10:53:08 +0000507 if (recycle == NULL) {
508 PyErr_NoMemory();
509 return -1;
510 }
511 }
Guido van Rossumae7bf1a1995-01-17 10:21:11 +0000512 else
513 p = recycle = NULL;
514 if (d <= 0) { /* Delete -d items; recycle ihigh-ilow items */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000515 for (k = ilow; k < ihigh; k++)
Guido van Rossumae7bf1a1995-01-17 10:21:11 +0000516 *p++ = item[k];
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000517 if (d < 0) {
518 for (/*k = ihigh*/; k < a->ob_size; k++)
519 item[k+d] = item[k];
520 a->ob_size += d;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000521 NRESIZE(item, PyObject *, a->ob_size); /* Can't fail */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000522 a->ob_item = item;
523 }
524 }
Guido van Rossumae7bf1a1995-01-17 10:21:11 +0000525 else { /* Insert d items; recycle ihigh-ilow items */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000526 NRESIZE(item, PyObject *, a->ob_size + d);
Guido van Rossum2a9096b1990-10-21 22:15:08 +0000527 if (item == NULL) {
Guido van Rossumb18618d2000-05-03 23:44:39 +0000528 if (recycle != NULL)
529 PyMem_DEL(recycle);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000530 PyErr_NoMemory();
Guido van Rossum2a9096b1990-10-21 22:15:08 +0000531 return -1;
532 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000533 for (k = a->ob_size; --k >= ihigh; )
534 item[k+d] = item[k];
535 for (/*k = ihigh-1*/; k >= ilow; --k)
Guido van Rossumae7bf1a1995-01-17 10:21:11 +0000536 *p++ = item[k];
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000537 a->ob_item = item;
538 a->ob_size += d;
539 }
540 for (k = 0; k < n; k++, ilow++) {
Michael W. Hudson5da854f2002-11-05 17:38:05 +0000541 PyObject *w = PySequence_Fast_GET_ITEM(v_as_SF, k);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000542 Py_XINCREF(w);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000543 item[ilow] = w;
544 }
Guido van Rossumae7bf1a1995-01-17 10:21:11 +0000545 if (recycle) {
546 while (--p >= recycle)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000547 Py_XDECREF(*p);
548 PyMem_DEL(recycle);
Guido van Rossumae7bf1a1995-01-17 10:21:11 +0000549 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000550 if (a->ob_size == 0 && a->ob_item != NULL) {
551 PyMem_FREE(a->ob_item);
552 a->ob_item = NULL;
553 }
Michael W. Hudson5da854f2002-11-05 17:38:05 +0000554 Py_XDECREF(v_as_SF);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000555 return 0;
556#undef b
557}
558
Guido van Rossum234f9421993-06-17 12:35:49 +0000559int
Fred Drakea2f55112000-07-09 15:16:51 +0000560PyList_SetSlice(PyObject *a, int ilow, int ihigh, PyObject *v)
Guido van Rossum234f9421993-06-17 12:35:49 +0000561{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000562 if (!PyList_Check(a)) {
563 PyErr_BadInternalCall();
Guido van Rossum1fc238a1993-07-29 08:25:09 +0000564 return -1;
Guido van Rossum234f9421993-06-17 12:35:49 +0000565 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000566 return list_ass_slice((PyListObject *)a, ilow, ihigh, v);
Guido van Rossum234f9421993-06-17 12:35:49 +0000567}
568
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000569static PyObject *
570list_inplace_repeat(PyListObject *self, int n)
571{
572 PyObject **items;
573 int size, i, j;
574
575
576 size = PyList_GET_SIZE(self);
577 if (size == 0) {
578 Py_INCREF(self);
579 return (PyObject *)self;
580 }
581
582 items = self->ob_item;
583
584 if (n < 1) {
585 self->ob_item = NULL;
586 self->ob_size = 0;
587 for (i = 0; i < size; i++)
588 Py_XDECREF(items[i]);
589 PyMem_DEL(items);
590 Py_INCREF(self);
591 return (PyObject *)self;
592 }
593
594 NRESIZE(items, PyObject*, size*n);
595 if (items == NULL) {
596 PyErr_NoMemory();
597 goto finally;
598 }
599 self->ob_item = items;
600 for (i = 1; i < n; i++) { /* Start counting at 1, not 0 */
601 for (j = 0; j < size; j++) {
602 PyObject *o = PyList_GET_ITEM(self, j);
603 Py_INCREF(o);
604 PyList_SET_ITEM(self, self->ob_size++, o);
605 }
606 }
607 Py_INCREF(self);
608 return (PyObject *)self;
609 finally:
610 return NULL;
611}
612
Guido van Rossum4a450d01991-04-03 19:05:18 +0000613static int
Fred Drakea2f55112000-07-09 15:16:51 +0000614list_ass_item(PyListObject *a, int i, PyObject *v)
Guido van Rossum4a450d01991-04-03 19:05:18 +0000615{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000616 PyObject *old_value;
Guido van Rossum4a450d01991-04-03 19:05:18 +0000617 if (i < 0 || i >= a->ob_size) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000618 PyErr_SetString(PyExc_IndexError,
619 "list assignment index out of range");
Guido van Rossum4a450d01991-04-03 19:05:18 +0000620 return -1;
621 }
622 if (v == NULL)
623 return list_ass_slice(a, i, i+1, v);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000624 Py_INCREF(v);
Guido van Rossumd7047b31995-01-02 19:07:15 +0000625 old_value = a->ob_item[i];
Guido van Rossum4a450d01991-04-03 19:05:18 +0000626 a->ob_item[i] = v;
Tim Peters3b01a122002-07-19 02:35:45 +0000627 Py_DECREF(old_value);
Guido van Rossum4a450d01991-04-03 19:05:18 +0000628 return 0;
629}
630
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000631static PyObject *
Fred Drakea2f55112000-07-09 15:16:51 +0000632ins(PyListObject *self, int where, PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000633{
634 if (ins1(self, where, v) != 0)
635 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000636 Py_INCREF(Py_None);
637 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000638}
639
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000640static PyObject *
Fred Drakea2f55112000-07-09 15:16:51 +0000641listinsert(PyListObject *self, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000642{
643 int i;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000644 PyObject *v;
Guido van Rossumc00a9382000-02-24 21:48:29 +0000645 if (!PyArg_ParseTuple(args, "iO:insert", &i, &v))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000646 return NULL;
Guido van Rossumbf80e541993-02-08 15:49:17 +0000647 return ins(self, i, v);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000648}
649
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000650static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000651listappend(PyListObject *self, PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000652{
Guido van Rossumbf80e541993-02-08 15:49:17 +0000653 return ins(self, (int) self->ob_size, v);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000654}
655
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000656static int
657listextend_internal(PyListObject *self, PyObject *b)
Barry Warsawdedf6d61998-10-09 16:37:25 +0000658{
Barry Warsawdedf6d61998-10-09 16:37:25 +0000659 PyObject **items;
660 int selflen = PyList_GET_SIZE(self);
661 int blen;
662 register int i;
663
Jeremy Hyltondb60bb52001-01-03 22:32:16 +0000664 if (PyObject_Size(b) == 0) {
Barry Warsawdedf6d61998-10-09 16:37:25 +0000665 /* short circuit when b is empty */
Jeremy Hyltondb60bb52001-01-03 22:32:16 +0000666 Py_DECREF(b);
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000667 return 0;
Jeremy Hyltondb60bb52001-01-03 22:32:16 +0000668 }
Andrew M. Kuchling74042d62000-06-18 18:43:14 +0000669
Barry Warsawdedf6d61998-10-09 16:37:25 +0000670 if (self == (PyListObject*)b) {
671 /* as in list_ass_slice() we must special case the
672 * situation: a.extend(a)
673 *
674 * XXX: I think this way ought to be faster than using
675 * list_slice() the way list_ass_slice() does.
676 */
Andrew M. Kuchling74042d62000-06-18 18:43:14 +0000677 Py_DECREF(b);
Barry Warsawdedf6d61998-10-09 16:37:25 +0000678 b = PyList_New(selflen);
679 if (!b)
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000680 return -1;
Barry Warsawdedf6d61998-10-09 16:37:25 +0000681 for (i = 0; i < selflen; i++) {
682 PyObject *o = PyList_GET_ITEM(self, i);
683 Py_INCREF(o);
684 PyList_SET_ITEM(b, i, o);
685 }
686 }
Barry Warsawdedf6d61998-10-09 16:37:25 +0000687
Jeremy Hylton03657cf2000-07-12 13:05:33 +0000688 blen = PyObject_Size(b);
Andrew M. Kuchling74042d62000-06-18 18:43:14 +0000689
Barry Warsawdedf6d61998-10-09 16:37:25 +0000690 /* resize a using idiom */
691 items = self->ob_item;
692 NRESIZE(items, PyObject*, selflen + blen);
Andrew M. Kuchling74042d62000-06-18 18:43:14 +0000693 if (items == NULL) {
Barry Warsawdedf6d61998-10-09 16:37:25 +0000694 PyErr_NoMemory();
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000695 Py_DECREF(b);
696 return -1;
Barry Warsawdedf6d61998-10-09 16:37:25 +0000697 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000698
Barry Warsawdedf6d61998-10-09 16:37:25 +0000699 self->ob_item = items;
700
Andrew M. Kuchling74042d62000-06-18 18:43:14 +0000701 /* populate the end of self with b's items */
Barry Warsawdedf6d61998-10-09 16:37:25 +0000702 for (i = 0; i < blen; i++) {
Andrew M. Kuchling74042d62000-06-18 18:43:14 +0000703 PyObject *o = PySequence_Fast_GET_ITEM(b, i);
Barry Warsawdedf6d61998-10-09 16:37:25 +0000704 Py_INCREF(o);
705 PyList_SET_ITEM(self, self->ob_size++, o);
706 }
Andrew M. Kuchling74042d62000-06-18 18:43:14 +0000707 Py_DECREF(b);
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000708 return 0;
Barry Warsawdedf6d61998-10-09 16:37:25 +0000709}
710
711
712static PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000713list_inplace_concat(PyListObject *self, PyObject *other)
714{
Tim Peters1af03e92001-05-26 19:37:54 +0000715 other = PySequence_Fast(other, "argument to += must be iterable");
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000716 if (!other)
717 return NULL;
718
719 if (listextend_internal(self, other) < 0)
720 return NULL;
721
722 Py_INCREF(self);
723 return (PyObject *)self;
724}
725
726static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000727listextend(PyListObject *self, PyObject *b)
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000728{
729
Tim Peters1af03e92001-05-26 19:37:54 +0000730 b = PySequence_Fast(b, "list.extend() argument must be iterable");
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000731 if (!b)
732 return NULL;
733
734 if (listextend_internal(self, b) < 0)
735 return NULL;
736
737 Py_INCREF(Py_None);
738 return Py_None;
739}
740
741static PyObject *
Fred Drakea2f55112000-07-09 15:16:51 +0000742listpop(PyListObject *self, PyObject *args)
Guido van Rossum3dd7f3f1998-06-30 15:36:32 +0000743{
744 int i = -1;
745 PyObject *v;
Guido van Rossumc00a9382000-02-24 21:48:29 +0000746 if (!PyArg_ParseTuple(args, "|i:pop", &i))
Guido van Rossum3dd7f3f1998-06-30 15:36:32 +0000747 return NULL;
748 if (self->ob_size == 0) {
749 /* Special-case most common failure cause */
750 PyErr_SetString(PyExc_IndexError, "pop from empty list");
751 return NULL;
752 }
753 if (i < 0)
754 i += self->ob_size;
755 if (i < 0 || i >= self->ob_size) {
756 PyErr_SetString(PyExc_IndexError, "pop index out of range");
757 return NULL;
758 }
759 v = self->ob_item[i];
760 Py_INCREF(v);
761 if (list_ass_slice(self, i, i+1, (PyObject *)NULL) != 0) {
762 Py_DECREF(v);
763 return NULL;
764 }
765 return v;
766}
767
Tim Peters8e2e7ca2002-07-19 02:33:08 +0000768/* Reverse a slice of a list in place, from lo up to (exclusive) hi. */
769static void
770reverse_slice(PyObject **lo, PyObject **hi)
771{
772 assert(lo && hi);
773
774 --hi;
775 while (lo < hi) {
776 PyObject *t = *lo;
777 *lo = *hi;
778 *hi = t;
779 ++lo;
780 --hi;
781 }
782}
783
Tim Petersa64dc242002-08-01 02:13:36 +0000784/* Lots of code for an adaptive, stable, natural mergesort. There are many
785 * pieces to this algorithm; read listsort.txt for overviews and details.
786 */
Guido van Rossum3f236de1996-12-10 23:55:39 +0000787
Guido van Rossum3f236de1996-12-10 23:55:39 +0000788/* Comparison function. Takes care of calling a user-supplied
Tim Peters66860f62002-08-04 17:47:26 +0000789 * comparison function (any callable Python object), which must not be
790 * NULL (use the ISLT macro if you don't know, or call PyObject_RichCompareBool
791 * with Py_LT if you know it's NULL).
Tim Petersa64dc242002-08-01 02:13:36 +0000792 * Returns -1 on error, 1 if x < y, 0 if x >= y.
793 */
Guido van Rossum3f236de1996-12-10 23:55:39 +0000794static int
Tim Petersa8c974c2002-07-19 03:30:57 +0000795islt(PyObject *x, PyObject *y, PyObject *compare)
Guido van Rossum3f236de1996-12-10 23:55:39 +0000796{
Tim Petersf2a04732002-07-11 21:46:16 +0000797 PyObject *res;
798 PyObject *args;
Guido van Rossum3f236de1996-12-10 23:55:39 +0000799 int i;
800
Tim Peters66860f62002-08-04 17:47:26 +0000801 assert(compare != NULL);
Tim Petersa8c974c2002-07-19 03:30:57 +0000802 /* Call the user's comparison function and translate the 3-way
803 * result into true or false (or error).
804 */
Tim Petersf2a04732002-07-11 21:46:16 +0000805 args = PyTuple_New(2);
Guido van Rossum3f236de1996-12-10 23:55:39 +0000806 if (args == NULL)
Tim Petersa8c974c2002-07-19 03:30:57 +0000807 return -1;
Tim Petersf2a04732002-07-11 21:46:16 +0000808 Py_INCREF(x);
809 Py_INCREF(y);
810 PyTuple_SET_ITEM(args, 0, x);
811 PyTuple_SET_ITEM(args, 1, y);
Tim Peters58cf3612002-07-15 05:16:13 +0000812 res = PyObject_Call(compare, args, NULL);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000813 Py_DECREF(args);
Guido van Rossum3f236de1996-12-10 23:55:39 +0000814 if (res == NULL)
Tim Petersa8c974c2002-07-19 03:30:57 +0000815 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000816 if (!PyInt_Check(res)) {
817 Py_DECREF(res);
818 PyErr_SetString(PyExc_TypeError,
Guido van Rossum9bcd1d71999-04-19 17:44:39 +0000819 "comparison function must return int");
Tim Petersa8c974c2002-07-19 03:30:57 +0000820 return -1;
Guido van Rossum3f236de1996-12-10 23:55:39 +0000821 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000822 i = PyInt_AsLong(res);
823 Py_DECREF(res);
Tim Petersa8c974c2002-07-19 03:30:57 +0000824 return i < 0;
Guido van Rossum3f236de1996-12-10 23:55:39 +0000825}
826
Tim Peters66860f62002-08-04 17:47:26 +0000827/* If COMPARE is NULL, calls PyObject_RichCompareBool with Py_LT, else calls
828 * islt. This avoids a layer of function call in the usual case, and
829 * sorting does many comparisons.
830 * Returns -1 on error, 1 if x < y, 0 if x >= y.
831 */
832#define ISLT(X, Y, COMPARE) ((COMPARE) == NULL ? \
833 PyObject_RichCompareBool(X, Y, Py_LT) : \
834 islt(X, Y, COMPARE))
835
836/* Compare X to Y via "<". Goto "fail" if the comparison raises an
Tim Petersa8c974c2002-07-19 03:30:57 +0000837 error. Else "k" is set to true iff X<Y, and an "if (k)" block is
838 started. It makes more sense in context <wink>. X and Y are PyObject*s.
839*/
Tim Peters66860f62002-08-04 17:47:26 +0000840#define IFLT(X, Y) if ((k = ISLT(X, Y, compare)) < 0) goto fail; \
Tim Petersa8c974c2002-07-19 03:30:57 +0000841 if (k)
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000842
843/* binarysort is the best method for sorting small arrays: it does
844 few compares, but can do data movement quadratic in the number of
845 elements.
Guido van Rossum42812581998-06-17 14:15:44 +0000846 [lo, hi) is a contiguous slice of a list, and is sorted via
Tim Petersa8c974c2002-07-19 03:30:57 +0000847 binary insertion. This sort is stable.
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000848 On entry, must have lo <= start <= hi, and that [lo, start) is already
849 sorted (pass start == lo if you don't know!).
Tim Petersa8c974c2002-07-19 03:30:57 +0000850 If islt() complains return -1, else 0.
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000851 Even in case of error, the output slice will be some permutation of
852 the input (nothing is lost or duplicated).
853*/
Guido van Rossum3f236de1996-12-10 23:55:39 +0000854static int
Fred Drakea2f55112000-07-09 15:16:51 +0000855binarysort(PyObject **lo, PyObject **hi, PyObject **start, PyObject *compare)
856 /* compare -- comparison function object, or NULL for default */
Guido van Rossum3f236de1996-12-10 23:55:39 +0000857{
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000858 register int k;
859 register PyObject **l, **p, **r;
860 register PyObject *pivot;
Guido van Rossum3f236de1996-12-10 23:55:39 +0000861
Tim Petersa8c974c2002-07-19 03:30:57 +0000862 assert(lo <= start && start <= hi);
863 /* assert [lo, start) is sorted */
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000864 if (lo == start)
865 ++start;
866 for (; start < hi; ++start) {
867 /* set l to where *start belongs */
868 l = lo;
869 r = start;
Guido van Rossuma119c0d1998-05-29 17:56:32 +0000870 pivot = *r;
Tim Peters0fe977c2002-07-19 06:12:32 +0000871 /* Invariants:
872 * pivot >= all in [lo, l).
873 * pivot < all in [r, start).
874 * The second is vacuously true at the start.
875 */
876 assert(l < r);
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000877 do {
878 p = l + ((r - l) >> 1);
Tim Petersa8c974c2002-07-19 03:30:57 +0000879 IFLT(pivot, *p)
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000880 r = p;
881 else
Tim Peters0fe977c2002-07-19 06:12:32 +0000882 l = p+1;
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000883 } while (l < r);
Tim Peters0fe977c2002-07-19 06:12:32 +0000884 assert(l == r);
885 /* The invariants still hold, so pivot >= all in [lo, l) and
886 pivot < all in [l, start), so pivot belongs at l. Note
887 that if there are elements equal to pivot, l points to the
888 first slot after them -- that's why this sort is stable.
889 Slide over to make room.
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000890 Caution: using memmove is much slower under MSVC 5;
891 we're not usually moving many slots. */
892 for (p = start; p > l; --p)
893 *p = *(p-1);
894 *l = pivot;
Guido van Rossum3f236de1996-12-10 23:55:39 +0000895 }
Guido van Rossum3f236de1996-12-10 23:55:39 +0000896 return 0;
Guido van Rossuma119c0d1998-05-29 17:56:32 +0000897
898 fail:
899 return -1;
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000900}
901
Tim Petersa64dc242002-08-01 02:13:36 +0000902/*
903Return the length of the run beginning at lo, in the slice [lo, hi). lo < hi
904is required on entry. "A run" is the longest ascending sequence, with
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000905
Tim Petersa64dc242002-08-01 02:13:36 +0000906 lo[0] <= lo[1] <= lo[2] <= ...
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000907
Tim Petersa64dc242002-08-01 02:13:36 +0000908or the longest descending sequence, with
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000909
Tim Petersa64dc242002-08-01 02:13:36 +0000910 lo[0] > lo[1] > lo[2] > ...
Tim Peters3b01a122002-07-19 02:35:45 +0000911
Tim Petersa64dc242002-08-01 02:13:36 +0000912Boolean *descending is set to 0 in the former case, or to 1 in the latter.
913For its intended use in a stable mergesort, the strictness of the defn of
914"descending" is needed so that the caller can safely reverse a descending
915sequence without violating stability (strict > ensures there are no equal
916elements to get out of order).
917
918Returns -1 in case of error.
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000919*/
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000920static int
Tim Petersa64dc242002-08-01 02:13:36 +0000921count_run(PyObject **lo, PyObject **hi, PyObject *compare, int *descending)
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000922{
Tim Petersa64dc242002-08-01 02:13:36 +0000923 int k;
924 int n;
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000925
Tim Petersa64dc242002-08-01 02:13:36 +0000926 assert(lo < hi);
927 *descending = 0;
928 ++lo;
929 if (lo == hi)
930 return 1;
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000931
Tim Petersa64dc242002-08-01 02:13:36 +0000932 n = 2;
933 IFLT(*lo, *(lo-1)) {
934 *descending = 1;
935 for (lo = lo+1; lo < hi; ++lo, ++n) {
936 IFLT(*lo, *(lo-1))
937 ;
938 else
939 break;
940 }
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000941 }
Tim Petersa64dc242002-08-01 02:13:36 +0000942 else {
943 for (lo = lo+1; lo < hi; ++lo, ++n) {
944 IFLT(*lo, *(lo-1))
945 break;
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000946 }
947 }
948
Tim Petersa64dc242002-08-01 02:13:36 +0000949 return n;
950fail:
951 return -1;
952}
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000953
Tim Petersa64dc242002-08-01 02:13:36 +0000954/*
955Locate the proper position of key in a sorted vector; if the vector contains
956an element equal to key, return the position immediately to the left of
957the leftmost equal element. [gallop_right() does the same except returns
958the position to the right of the rightmost equal element (if any).]
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000959
Tim Petersa64dc242002-08-01 02:13:36 +0000960"a" is a sorted vector with n elements, starting at a[0]. n must be > 0.
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000961
Tim Petersa64dc242002-08-01 02:13:36 +0000962"hint" is an index at which to begin the search, 0 <= hint < n. The closer
963hint is to the final result, the faster this runs.
964
965The return value is the int k in 0..n such that
966
967 a[k-1] < key <= a[k]
968
969pretending that *(a-1) is minus infinity and a[n] is plus infinity. IOW,
970key belongs at index k; or, IOW, the first k elements of a should precede
971key, and the last n-k should follow key.
972
973Returns -1 on error. See listsort.txt for info on the method.
974*/
975static int
976gallop_left(PyObject *key, PyObject **a, int n, int hint, PyObject *compare)
977{
978 int ofs;
979 int lastofs;
980 int k;
981
982 assert(key && a && n > 0 && hint >= 0 && hint < n);
983
984 a += hint;
985 lastofs = 0;
986 ofs = 1;
987 IFLT(*a, key) {
988 /* a[hint] < key -- gallop right, until
989 * a[hint + lastofs] < key <= a[hint + ofs]
990 */
991 const int maxofs = n - hint; /* &a[n-1] is highest */
992 while (ofs < maxofs) {
993 IFLT(a[ofs], key) {
994 lastofs = ofs;
995 ofs = (ofs << 1) + 1;
996 if (ofs <= 0) /* int overflow */
997 ofs = maxofs;
998 }
999 else /* key <= a[hint + ofs] */
1000 break;
1001 }
1002 if (ofs > maxofs)
1003 ofs = maxofs;
1004 /* Translate back to offsets relative to &a[0]. */
1005 lastofs += hint;
1006 ofs += hint;
1007 }
1008 else {
1009 /* key <= a[hint] -- gallop left, until
1010 * a[hint - ofs] < key <= a[hint - lastofs]
1011 */
1012 const int maxofs = hint + 1; /* &a[0] is lowest */
1013 while (ofs < maxofs) {
1014 IFLT(*(a-ofs), key)
1015 break;
1016 /* key <= a[hint - ofs] */
1017 lastofs = ofs;
1018 ofs = (ofs << 1) + 1;
1019 if (ofs <= 0) /* int overflow */
1020 ofs = maxofs;
1021 }
1022 if (ofs > maxofs)
1023 ofs = maxofs;
1024 /* Translate back to positive offsets relative to &a[0]. */
1025 k = lastofs;
1026 lastofs = hint - ofs;
1027 ofs = hint - k;
1028 }
1029 a -= hint;
1030
1031 assert(-1 <= lastofs && lastofs < ofs && ofs <= n);
1032 /* Now a[lastofs] < key <= a[ofs], so key belongs somewhere to the
1033 * right of lastofs but no farther right than ofs. Do a binary
1034 * search, with invariant a[lastofs-1] < key <= a[ofs].
1035 */
1036 ++lastofs;
1037 while (lastofs < ofs) {
1038 int m = lastofs + ((ofs - lastofs) >> 1);
1039
1040 IFLT(a[m], key)
1041 lastofs = m+1; /* a[m] < key */
1042 else
1043 ofs = m; /* key <= a[m] */
1044 }
1045 assert(lastofs == ofs); /* so a[ofs-1] < key <= a[ofs] */
1046 return ofs;
1047
1048fail:
1049 return -1;
1050}
1051
1052/*
1053Exactly like gallop_left(), except that if key already exists in a[0:n],
1054finds the position immediately to the right of the rightmost equal value.
1055
1056The return value is the int k in 0..n such that
1057
1058 a[k-1] <= key < a[k]
1059
1060or -1 if error.
1061
1062The code duplication is massive, but this is enough different given that
1063we're sticking to "<" comparisons that it's much harder to follow if
1064written as one routine with yet another "left or right?" flag.
1065*/
1066static int
1067gallop_right(PyObject *key, PyObject **a, int n, int hint, PyObject *compare)
1068{
1069 int ofs;
1070 int lastofs;
1071 int k;
1072
1073 assert(key && a && n > 0 && hint >= 0 && hint < n);
1074
1075 a += hint;
1076 lastofs = 0;
1077 ofs = 1;
1078 IFLT(key, *a) {
1079 /* key < a[hint] -- gallop left, until
1080 * a[hint - ofs] <= key < a[hint - lastofs]
1081 */
1082 const int maxofs = hint + 1; /* &a[0] is lowest */
1083 while (ofs < maxofs) {
1084 IFLT(key, *(a-ofs)) {
1085 lastofs = ofs;
1086 ofs = (ofs << 1) + 1;
1087 if (ofs <= 0) /* int overflow */
1088 ofs = maxofs;
1089 }
1090 else /* a[hint - ofs] <= key */
1091 break;
1092 }
1093 if (ofs > maxofs)
1094 ofs = maxofs;
1095 /* Translate back to positive offsets relative to &a[0]. */
1096 k = lastofs;
1097 lastofs = hint - ofs;
1098 ofs = hint - k;
1099 }
1100 else {
1101 /* a[hint] <= key -- gallop right, until
1102 * a[hint + lastofs] <= key < a[hint + ofs]
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001103 */
Tim Petersa64dc242002-08-01 02:13:36 +00001104 const int maxofs = n - hint; /* &a[n-1] is highest */
1105 while (ofs < maxofs) {
1106 IFLT(key, a[ofs])
1107 break;
1108 /* a[hint + ofs] <= key */
1109 lastofs = ofs;
1110 ofs = (ofs << 1) + 1;
1111 if (ofs <= 0) /* int overflow */
1112 ofs = maxofs;
1113 }
1114 if (ofs > maxofs)
1115 ofs = maxofs;
1116 /* Translate back to offsets relative to &a[0]. */
1117 lastofs += hint;
1118 ofs += hint;
1119 }
1120 a -= hint;
1121
1122 assert(-1 <= lastofs && lastofs < ofs && ofs <= n);
1123 /* Now a[lastofs] <= key < a[ofs], so key belongs somewhere to the
1124 * right of lastofs but no farther right than ofs. Do a binary
1125 * search, with invariant a[lastofs-1] <= key < a[ofs].
1126 */
1127 ++lastofs;
1128 while (lastofs < ofs) {
1129 int m = lastofs + ((ofs - lastofs) >> 1);
1130
1131 IFLT(key, a[m])
1132 ofs = m; /* key < a[m] */
1133 else
1134 lastofs = m+1; /* a[m] <= key */
1135 }
1136 assert(lastofs == ofs); /* so a[ofs-1] <= key < a[ofs] */
1137 return ofs;
1138
1139fail:
1140 return -1;
1141}
1142
1143/* The maximum number of entries in a MergeState's pending-runs stack.
1144 * This is enough to sort arrays of size up to about
1145 * 32 * phi ** MAX_MERGE_PENDING
1146 * where phi ~= 1.618. 85 is ridiculouslylarge enough, good for an array
1147 * with 2**64 elements.
1148 */
1149#define MAX_MERGE_PENDING 85
1150
Tim Peterse05f65a2002-08-10 05:21:15 +00001151/* When we get into galloping mode, we stay there until both runs win less
1152 * often than MIN_GALLOP consecutive times. See listsort.txt for more info.
Tim Petersa64dc242002-08-01 02:13:36 +00001153 */
Tim Peterse05f65a2002-08-10 05:21:15 +00001154#define MIN_GALLOP 7
Tim Petersa64dc242002-08-01 02:13:36 +00001155
1156/* Avoid malloc for small temp arrays. */
1157#define MERGESTATE_TEMP_SIZE 256
1158
1159/* One MergeState exists on the stack per invocation of mergesort. It's just
1160 * a convenient way to pass state around among the helper functions.
1161 */
Tim Peterse05f65a2002-08-10 05:21:15 +00001162struct s_slice {
1163 PyObject **base;
1164 int len;
1165};
1166
Tim Petersa64dc242002-08-01 02:13:36 +00001167typedef struct s_MergeState {
1168 /* The user-supplied comparison function. or NULL if none given. */
1169 PyObject *compare;
1170
Tim Peterse05f65a2002-08-10 05:21:15 +00001171 /* This controls when we get *into* galloping mode. It's initialized
1172 * to MIN_GALLOP. merge_lo and merge_hi tend to nudge it higher for
1173 * random data, and lower for highly structured data.
1174 */
1175 int min_gallop;
1176
Tim Petersa64dc242002-08-01 02:13:36 +00001177 /* 'a' is temp storage to help with merges. It contains room for
1178 * alloced entries.
1179 */
1180 PyObject **a; /* may point to temparray below */
1181 int alloced;
1182
1183 /* A stack of n pending runs yet to be merged. Run #i starts at
1184 * address base[i] and extends for len[i] elements. It's always
1185 * true (so long as the indices are in bounds) that
1186 *
Tim Peterse05f65a2002-08-10 05:21:15 +00001187 * pending[i].base + pending[i].len == pending[i+1].base
Tim Petersa64dc242002-08-01 02:13:36 +00001188 *
1189 * so we could cut the storage for this, but it's a minor amount,
1190 * and keeping all the info explicit simplifies the code.
1191 */
1192 int n;
Tim Peterse05f65a2002-08-10 05:21:15 +00001193 struct s_slice pending[MAX_MERGE_PENDING];
Tim Petersa64dc242002-08-01 02:13:36 +00001194
1195 /* 'a' points to this when possible, rather than muck with malloc. */
1196 PyObject *temparray[MERGESTATE_TEMP_SIZE];
1197} MergeState;
1198
1199/* Conceptually a MergeState's constructor. */
1200static void
1201merge_init(MergeState *ms, PyObject *compare)
1202{
1203 assert(ms != NULL);
1204 ms->compare = compare;
1205 ms->a = ms->temparray;
1206 ms->alloced = MERGESTATE_TEMP_SIZE;
1207 ms->n = 0;
Tim Peterse05f65a2002-08-10 05:21:15 +00001208 ms->min_gallop = MIN_GALLOP;
Tim Petersa64dc242002-08-01 02:13:36 +00001209}
1210
1211/* Free all the temp memory owned by the MergeState. This must be called
1212 * when you're done with a MergeState, and may be called before then if
1213 * you want to free the temp memory early.
1214 */
1215static void
1216merge_freemem(MergeState *ms)
1217{
1218 assert(ms != NULL);
1219 if (ms->a != ms->temparray)
1220 PyMem_Free(ms->a);
1221 ms->a = ms->temparray;
1222 ms->alloced = MERGESTATE_TEMP_SIZE;
1223}
1224
1225/* Ensure enough temp memory for 'need' array slots is available.
1226 * Returns 0 on success and -1 if the memory can't be gotten.
1227 */
1228static int
1229merge_getmem(MergeState *ms, int need)
1230{
1231 assert(ms != NULL);
1232 if (need <= ms->alloced)
1233 return 0;
1234 /* Don't realloc! That can cost cycles to copy the old data, but
1235 * we don't care what's in the block.
1236 */
1237 merge_freemem(ms);
1238 ms->a = (PyObject **)PyMem_Malloc(need * sizeof(PyObject*));
1239 if (ms->a) {
1240 ms->alloced = need;
1241 return 0;
1242 }
1243 PyErr_NoMemory();
1244 merge_freemem(ms); /* reset to sane state */
1245 return -1;
1246}
1247#define MERGE_GETMEM(MS, NEED) ((NEED) <= (MS)->alloced ? 0 : \
1248 merge_getmem(MS, NEED))
1249
1250/* Merge the na elements starting at pa with the nb elements starting at pb
1251 * in a stable way, in-place. na and nb must be > 0, and pa + na == pb.
1252 * Must also have that *pb < *pa, that pa[na-1] belongs at the end of the
1253 * merge, and should have na <= nb. See listsort.txt for more info.
1254 * Return 0 if successful, -1 if error.
1255 */
1256static int
1257merge_lo(MergeState *ms, PyObject **pa, int na, PyObject **pb, int nb)
1258{
1259 int k;
1260 PyObject *compare;
1261 PyObject **dest;
1262 int result = -1; /* guilty until proved innocent */
Tim Peterse05f65a2002-08-10 05:21:15 +00001263 int min_gallop = ms->min_gallop;
Tim Petersa64dc242002-08-01 02:13:36 +00001264
1265 assert(ms && pa && pb && na > 0 && nb > 0 && pa + na == pb);
1266 if (MERGE_GETMEM(ms, na) < 0)
1267 return -1;
1268 memcpy(ms->a, pa, na * sizeof(PyObject*));
1269 dest = pa;
1270 pa = ms->a;
1271
1272 *dest++ = *pb++;
1273 --nb;
1274 if (nb == 0)
1275 goto Succeed;
1276 if (na == 1)
1277 goto CopyB;
1278
1279 compare = ms->compare;
1280 for (;;) {
1281 int acount = 0; /* # of times A won in a row */
1282 int bcount = 0; /* # of times B won in a row */
1283
1284 /* Do the straightforward thing until (if ever) one run
1285 * appears to win consistently.
1286 */
1287 for (;;) {
Tim Peterse05f65a2002-08-10 05:21:15 +00001288 assert(na > 1 && nb > 0);
Tim Peters66860f62002-08-04 17:47:26 +00001289 k = ISLT(*pb, *pa, compare);
Tim Petersa64dc242002-08-01 02:13:36 +00001290 if (k) {
1291 if (k < 0)
1292 goto Fail;
1293 *dest++ = *pb++;
1294 ++bcount;
1295 acount = 0;
1296 --nb;
1297 if (nb == 0)
1298 goto Succeed;
Tim Peterse05f65a2002-08-10 05:21:15 +00001299 if (bcount >= min_gallop)
Tim Petersa64dc242002-08-01 02:13:36 +00001300 break;
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001301 }
1302 else {
Tim Petersa64dc242002-08-01 02:13:36 +00001303 *dest++ = *pa++;
1304 ++acount;
1305 bcount = 0;
1306 --na;
1307 if (na == 1)
1308 goto CopyB;
Tim Peterse05f65a2002-08-10 05:21:15 +00001309 if (acount >= min_gallop)
Tim Petersa64dc242002-08-01 02:13:36 +00001310 break;
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001311 }
Tim Petersa64dc242002-08-01 02:13:36 +00001312 }
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001313
Tim Petersa64dc242002-08-01 02:13:36 +00001314 /* One run is winning so consistently that galloping may
1315 * be a huge win. So try that, and continue galloping until
1316 * (if ever) neither run appears to be winning consistently
1317 * anymore.
1318 */
Tim Peterse05f65a2002-08-10 05:21:15 +00001319 ++min_gallop;
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001320 do {
Tim Peterse05f65a2002-08-10 05:21:15 +00001321 assert(na > 1 && nb > 0);
1322 min_gallop -= min_gallop > 1;
1323 ms->min_gallop = min_gallop;
Tim Petersa64dc242002-08-01 02:13:36 +00001324 k = gallop_right(*pb, pa, na, 0, compare);
1325 acount = k;
1326 if (k) {
1327 if (k < 0)
1328 goto Fail;
1329 memcpy(dest, pa, k * sizeof(PyObject *));
1330 dest += k;
1331 pa += k;
1332 na -= k;
1333 if (na == 1)
1334 goto CopyB;
1335 /* na==0 is impossible now if the comparison
1336 * function is consistent, but we can't assume
1337 * that it is.
1338 */
1339 if (na == 0)
1340 goto Succeed;
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001341 }
Tim Petersa64dc242002-08-01 02:13:36 +00001342 *dest++ = *pb++;
1343 --nb;
1344 if (nb == 0)
1345 goto Succeed;
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001346
Tim Petersa64dc242002-08-01 02:13:36 +00001347 k = gallop_left(*pa, pb, nb, 0, compare);
1348 bcount = k;
1349 if (k) {
1350 if (k < 0)
1351 goto Fail;
1352 memmove(dest, pb, k * sizeof(PyObject *));
1353 dest += k;
1354 pb += k;
1355 nb -= k;
1356 if (nb == 0)
1357 goto Succeed;
1358 }
1359 *dest++ = *pa++;
1360 --na;
1361 if (na == 1)
1362 goto CopyB;
1363 } while (acount >= MIN_GALLOP || bcount >= MIN_GALLOP);
Tim Peterse05f65a2002-08-10 05:21:15 +00001364 ++min_gallop; /* penalize it for leaving galloping mode */
1365 ms->min_gallop = min_gallop;
Tim Petersa64dc242002-08-01 02:13:36 +00001366 }
1367Succeed:
1368 result = 0;
1369Fail:
1370 if (na)
1371 memcpy(dest, pa, na * sizeof(PyObject*));
1372 return result;
1373CopyB:
1374 assert(na == 1 && nb > 0);
1375 /* The last element of pa belongs at the end of the merge. */
1376 memmove(dest, pb, nb * sizeof(PyObject *));
1377 dest[nb] = *pa;
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001378 return 0;
Tim Petersa64dc242002-08-01 02:13:36 +00001379}
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001380
Tim Petersa64dc242002-08-01 02:13:36 +00001381/* Merge the na elements starting at pa with the nb elements starting at pb
1382 * in a stable way, in-place. na and nb must be > 0, and pa + na == pb.
1383 * Must also have that *pb < *pa, that pa[na-1] belongs at the end of the
1384 * merge, and should have na >= nb. See listsort.txt for more info.
1385 * Return 0 if successful, -1 if error.
1386 */
1387static int
1388merge_hi(MergeState *ms, PyObject **pa, int na, PyObject **pb, int nb)
1389{
1390 int k;
1391 PyObject *compare;
1392 PyObject **dest;
1393 int result = -1; /* guilty until proved innocent */
1394 PyObject **basea;
1395 PyObject **baseb;
Tim Peterse05f65a2002-08-10 05:21:15 +00001396 int min_gallop = ms->min_gallop;
Tim Petersa64dc242002-08-01 02:13:36 +00001397
1398 assert(ms && pa && pb && na > 0 && nb > 0 && pa + na == pb);
1399 if (MERGE_GETMEM(ms, nb) < 0)
1400 return -1;
1401 dest = pb + nb - 1;
1402 memcpy(ms->a, pb, nb * sizeof(PyObject*));
1403 basea = pa;
1404 baseb = ms->a;
1405 pb = ms->a + nb - 1;
1406 pa += na - 1;
1407
1408 *dest-- = *pa--;
1409 --na;
1410 if (na == 0)
1411 goto Succeed;
1412 if (nb == 1)
1413 goto CopyA;
1414
1415 compare = ms->compare;
1416 for (;;) {
1417 int acount = 0; /* # of times A won in a row */
1418 int bcount = 0; /* # of times B won in a row */
1419
1420 /* Do the straightforward thing until (if ever) one run
1421 * appears to win consistently.
1422 */
1423 for (;;) {
Tim Peterse05f65a2002-08-10 05:21:15 +00001424 assert(na > 0 && nb > 1);
Tim Peters66860f62002-08-04 17:47:26 +00001425 k = ISLT(*pb, *pa, compare);
Tim Petersa64dc242002-08-01 02:13:36 +00001426 if (k) {
1427 if (k < 0)
1428 goto Fail;
1429 *dest-- = *pa--;
1430 ++acount;
1431 bcount = 0;
1432 --na;
1433 if (na == 0)
1434 goto Succeed;
Tim Peterse05f65a2002-08-10 05:21:15 +00001435 if (acount >= min_gallop)
Tim Petersa64dc242002-08-01 02:13:36 +00001436 break;
1437 }
1438 else {
1439 *dest-- = *pb--;
1440 ++bcount;
1441 acount = 0;
1442 --nb;
1443 if (nb == 1)
1444 goto CopyA;
Tim Peterse05f65a2002-08-10 05:21:15 +00001445 if (bcount >= min_gallop)
Tim Petersa64dc242002-08-01 02:13:36 +00001446 break;
1447 }
1448 }
1449
1450 /* One run is winning so consistently that galloping may
1451 * be a huge win. So try that, and continue galloping until
1452 * (if ever) neither run appears to be winning consistently
1453 * anymore.
1454 */
Tim Peterse05f65a2002-08-10 05:21:15 +00001455 ++min_gallop;
Tim Petersa64dc242002-08-01 02:13:36 +00001456 do {
Tim Peterse05f65a2002-08-10 05:21:15 +00001457 assert(na > 0 && nb > 1);
1458 min_gallop -= min_gallop > 1;
1459 ms->min_gallop = min_gallop;
Tim Petersa64dc242002-08-01 02:13:36 +00001460 k = gallop_right(*pb, basea, na, na-1, compare);
1461 if (k < 0)
1462 goto Fail;
1463 k = na - k;
1464 acount = k;
1465 if (k) {
1466 dest -= k;
1467 pa -= k;
1468 memmove(dest+1, pa+1, k * sizeof(PyObject *));
1469 na -= k;
1470 if (na == 0)
1471 goto Succeed;
1472 }
1473 *dest-- = *pb--;
1474 --nb;
1475 if (nb == 1)
1476 goto CopyA;
1477
1478 k = gallop_left(*pa, baseb, nb, nb-1, compare);
1479 if (k < 0)
1480 goto Fail;
1481 k = nb - k;
1482 bcount = k;
1483 if (k) {
1484 dest -= k;
1485 pb -= k;
1486 memcpy(dest+1, pb+1, k * sizeof(PyObject *));
1487 nb -= k;
1488 if (nb == 1)
1489 goto CopyA;
1490 /* nb==0 is impossible now if the comparison
1491 * function is consistent, but we can't assume
1492 * that it is.
1493 */
1494 if (nb == 0)
1495 goto Succeed;
1496 }
1497 *dest-- = *pa--;
1498 --na;
1499 if (na == 0)
1500 goto Succeed;
1501 } while (acount >= MIN_GALLOP || bcount >= MIN_GALLOP);
Tim Peterse05f65a2002-08-10 05:21:15 +00001502 ++min_gallop; /* penalize it for leaving galloping mode */
1503 ms->min_gallop = min_gallop;
Tim Petersa64dc242002-08-01 02:13:36 +00001504 }
1505Succeed:
1506 result = 0;
1507Fail:
1508 if (nb)
1509 memcpy(dest-(nb-1), baseb, nb * sizeof(PyObject*));
1510 return result;
1511CopyA:
1512 assert(nb == 1 && na > 0);
1513 /* The first element of pb belongs at the front of the merge. */
1514 dest -= na;
1515 pa -= na;
1516 memmove(dest+1, pa+1, na * sizeof(PyObject *));
1517 *dest = *pb;
1518 return 0;
1519}
1520
1521/* Merge the two runs at stack indices i and i+1.
1522 * Returns 0 on success, -1 on error.
1523 */
1524static int
1525merge_at(MergeState *ms, int i)
1526{
1527 PyObject **pa, **pb;
1528 int na, nb;
1529 int k;
1530 PyObject *compare;
1531
1532 assert(ms != NULL);
1533 assert(ms->n >= 2);
1534 assert(i >= 0);
1535 assert(i == ms->n - 2 || i == ms->n - 3);
1536
Tim Peterse05f65a2002-08-10 05:21:15 +00001537 pa = ms->pending[i].base;
1538 na = ms->pending[i].len;
1539 pb = ms->pending[i+1].base;
1540 nb = ms->pending[i+1].len;
Tim Petersa64dc242002-08-01 02:13:36 +00001541 assert(na > 0 && nb > 0);
1542 assert(pa + na == pb);
1543
1544 /* Record the length of the combined runs; if i is the 3rd-last
1545 * run now, also slide over the last run (which isn't involved
1546 * in this merge). The current run i+1 goes away in any case.
1547 */
Tim Peterse05f65a2002-08-10 05:21:15 +00001548 ms->pending[i].len = na + nb;
1549 if (i == ms->n - 3)
1550 ms->pending[i+1] = ms->pending[i+2];
Tim Petersa64dc242002-08-01 02:13:36 +00001551 --ms->n;
1552
1553 /* Where does b start in a? Elements in a before that can be
1554 * ignored (already in place).
1555 */
1556 compare = ms->compare;
1557 k = gallop_right(*pb, pa, na, 0, compare);
1558 if (k < 0)
1559 return -1;
1560 pa += k;
1561 na -= k;
1562 if (na == 0)
1563 return 0;
1564
1565 /* Where does a end in b? Elements in b after that can be
1566 * ignored (already in place).
1567 */
1568 nb = gallop_left(pa[na-1], pb, nb, nb-1, compare);
1569 if (nb <= 0)
1570 return nb;
1571
1572 /* Merge what remains of the runs, using a temp array with
1573 * min(na, nb) elements.
1574 */
1575 if (na <= nb)
1576 return merge_lo(ms, pa, na, pb, nb);
1577 else
1578 return merge_hi(ms, pa, na, pb, nb);
1579}
1580
1581/* Examine the stack of runs waiting to be merged, merging adjacent runs
1582 * until the stack invariants are re-established:
1583 *
1584 * 1. len[-3] > len[-2] + len[-1]
1585 * 2. len[-2] > len[-1]
1586 *
1587 * See listsort.txt for more info.
1588 *
1589 * Returns 0 on success, -1 on error.
1590 */
1591static int
1592merge_collapse(MergeState *ms)
1593{
Tim Peterse05f65a2002-08-10 05:21:15 +00001594 struct s_slice *p = ms->pending;
Tim Petersa64dc242002-08-01 02:13:36 +00001595
1596 assert(ms);
1597 while (ms->n > 1) {
1598 int n = ms->n - 2;
Tim Peterse05f65a2002-08-10 05:21:15 +00001599 if (n > 0 && p[n-1].len <= p[n].len + p[n+1].len) {
1600 if (p[n-1].len < p[n+1].len)
Tim Petersa64dc242002-08-01 02:13:36 +00001601 --n;
1602 if (merge_at(ms, n) < 0)
1603 return -1;
1604 }
Tim Peterse05f65a2002-08-10 05:21:15 +00001605 else if (p[n].len <= p[n+1].len) {
Tim Petersa64dc242002-08-01 02:13:36 +00001606 if (merge_at(ms, n) < 0)
1607 return -1;
1608 }
1609 else
1610 break;
1611 }
1612 return 0;
1613}
1614
1615/* Regardless of invariants, merge all runs on the stack until only one
1616 * remains. This is used at the end of the mergesort.
1617 *
1618 * Returns 0 on success, -1 on error.
1619 */
1620static int
1621merge_force_collapse(MergeState *ms)
1622{
Tim Peterse05f65a2002-08-10 05:21:15 +00001623 struct s_slice *p = ms->pending;
Tim Petersa64dc242002-08-01 02:13:36 +00001624
1625 assert(ms);
1626 while (ms->n > 1) {
1627 int n = ms->n - 2;
Tim Peterse05f65a2002-08-10 05:21:15 +00001628 if (n > 0 && p[n-1].len < p[n+1].len)
Tim Petersa64dc242002-08-01 02:13:36 +00001629 --n;
1630 if (merge_at(ms, n) < 0)
1631 return -1;
1632 }
1633 return 0;
1634}
1635
1636/* Compute a good value for the minimum run length; natural runs shorter
1637 * than this are boosted artificially via binary insertion.
1638 *
1639 * If n < 64, return n (it's too small to bother with fancy stuff).
1640 * Else if n is an exact power of 2, return 32.
1641 * Else return an int k, 32 <= k <= 64, such that n/k is close to, but
1642 * strictly less than, an exact power of 2.
1643 *
1644 * See listsort.txt for more info.
1645 */
1646static int
1647merge_compute_minrun(int n)
1648{
1649 int r = 0; /* becomes 1 if any 1 bits are shifted off */
1650
1651 assert(n >= 0);
1652 while (n >= 64) {
1653 r |= n & 1;
1654 n >>= 1;
1655 }
1656 return n + r;
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001657}
Guido van Rossuma119c0d1998-05-29 17:56:32 +00001658
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00001659/* Special wrapper to support stable sorting using the decorate-sort-undecorate
1660 pattern. Holds a key which is used for comparisions and the original record
1661 which is returned during the undecorate phase. By exposing only the key
1662 during comparisons, the underlying sort stability characteristics are left
1663 unchanged. Also, if a custom comparison function is used, it will only see
1664 the key instead of a full record. */
1665
1666typedef struct {
1667 PyObject_HEAD
1668 PyObject *key;
1669 PyObject *value;
1670} sortwrapperobject;
1671
1672static PyTypeObject sortwrapper_type;
1673
1674static PyObject *
1675sortwrapper_richcompare(sortwrapperobject *a, sortwrapperobject *b, int op)
1676{
1677 if (!PyObject_TypeCheck(b, &sortwrapper_type)) {
1678 PyErr_SetString(PyExc_TypeError,
1679 "expected a sortwrapperobject");
1680 return NULL;
1681 }
1682 return PyObject_RichCompare(a->key, b->key, op);
1683}
1684
1685static void
1686sortwrapper_dealloc(sortwrapperobject *so)
1687{
1688 Py_XDECREF(so->key);
1689 Py_XDECREF(so->value);
1690 PyObject_Del(so);
1691}
1692
1693PyDoc_STRVAR(sortwrapper_doc, "Object wrapper with a custom sort key.");
1694
1695static PyTypeObject sortwrapper_type = {
1696 PyObject_HEAD_INIT(&PyType_Type)
1697 0, /* ob_size */
1698 "sortwrapper", /* tp_name */
1699 sizeof(sortwrapperobject), /* tp_basicsize */
1700 0, /* tp_itemsize */
1701 /* methods */
1702 (destructor)sortwrapper_dealloc, /* tp_dealloc */
1703 0, /* tp_print */
1704 0, /* tp_getattr */
1705 0, /* tp_setattr */
1706 0, /* tp_compare */
1707 0, /* tp_repr */
1708 0, /* tp_as_number */
1709 0, /* tp_as_sequence */
1710 0, /* tp_as_mapping */
1711 0, /* tp_hash */
1712 0, /* tp_call */
1713 0, /* tp_str */
1714 PyObject_GenericGetAttr, /* tp_getattro */
1715 0, /* tp_setattro */
1716 0, /* tp_as_buffer */
1717 Py_TPFLAGS_DEFAULT |
1718 Py_TPFLAGS_HAVE_RICHCOMPARE, /* tp_flags */
1719 sortwrapper_doc, /* tp_doc */
1720 0, /* tp_traverse */
1721 0, /* tp_clear */
1722 (richcmpfunc)sortwrapper_richcompare, /* tp_richcompare */
1723};
1724
1725/* Returns a new reference to a sortwrapper.
1726 Consumes the references to the two underlying objects. */
1727
1728static PyObject *
1729build_sortwrapper(PyObject *key, PyObject *value)
1730{
1731 sortwrapperobject *so;
1732
1733 so = PyObject_New(sortwrapperobject, &sortwrapper_type);
1734 if (so == NULL)
1735 return NULL;
1736 so->key = key;
1737 so->value = value;
1738 return (PyObject *)so;
1739}
1740
1741/* Returns a new reference to the value underlying the wrapper. */
1742static PyObject *
1743sortwrapper_getvalue(PyObject *so)
1744{
1745 PyObject *value;
1746
1747 if (!PyObject_TypeCheck(so, &sortwrapper_type)) {
1748 PyErr_SetString(PyExc_TypeError,
1749 "expected a sortwrapperobject");
1750 return NULL;
1751 }
1752 value = ((sortwrapperobject *)so)->value;
1753 Py_INCREF(value);
1754 return value;
1755}
1756
1757/* Wrapper for user specified cmp functions in combination with a
1758 specified key function. Makes sure the cmp function is presented
1759 with the actual key instead of the sortwrapper */
1760
1761typedef struct {
1762 PyObject_HEAD
1763 PyObject *func;
1764} cmpwrapperobject;
1765
1766static void
1767cmpwrapper_dealloc(cmpwrapperobject *co)
1768{
1769 Py_XDECREF(co->func);
1770 PyObject_Del(co);
1771}
1772
1773static PyObject *
1774cmpwrapper_call(cmpwrapperobject *co, PyObject *args, PyObject *kwds)
1775{
1776 PyObject *x, *y, *xx, *yy;
1777
1778 if (!PyArg_UnpackTuple(args, "", 2, 2, &x, &y))
1779 return NULL;
1780 if (!PyObject_TypeCheck(x, &sortwrapper_type) ||
Raymond Hettingerae4a2992003-10-16 17:16:30 +00001781 !PyObject_TypeCheck(y, &sortwrapper_type)) {
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00001782 PyErr_SetString(PyExc_TypeError,
1783 "expected a sortwrapperobject");
1784 return NULL;
1785 }
1786 xx = ((sortwrapperobject *)x)->key;
1787 yy = ((sortwrapperobject *)y)->key;
1788 return PyObject_CallFunctionObjArgs(co->func, xx, yy, NULL);
1789}
1790
1791PyDoc_STRVAR(cmpwrapper_doc, "cmp() wrapper for sort with custom keys.");
1792
1793static PyTypeObject cmpwrapper_type = {
1794 PyObject_HEAD_INIT(&PyType_Type)
1795 0, /* ob_size */
1796 "cmpwrapper", /* tp_name */
1797 sizeof(cmpwrapperobject), /* tp_basicsize */
1798 0, /* tp_itemsize */
1799 /* methods */
1800 (destructor)cmpwrapper_dealloc, /* tp_dealloc */
1801 0, /* tp_print */
1802 0, /* tp_getattr */
1803 0, /* tp_setattr */
1804 0, /* tp_compare */
1805 0, /* tp_repr */
1806 0, /* tp_as_number */
1807 0, /* tp_as_sequence */
1808 0, /* tp_as_mapping */
1809 0, /* tp_hash */
1810 (ternaryfunc)cmpwrapper_call, /* tp_call */
1811 0, /* tp_str */
1812 PyObject_GenericGetAttr, /* tp_getattro */
1813 0, /* tp_setattro */
1814 0, /* tp_as_buffer */
1815 Py_TPFLAGS_DEFAULT, /* tp_flags */
1816 cmpwrapper_doc, /* tp_doc */
1817};
1818
1819static PyObject *
1820build_cmpwrapper(PyObject *cmpfunc)
1821{
1822 cmpwrapperobject *co;
1823
1824 co = PyObject_New(cmpwrapperobject, &cmpwrapper_type);
1825 if (co == NULL)
1826 return NULL;
1827 Py_INCREF(cmpfunc);
1828 co->func = cmpfunc;
1829 return (PyObject *)co;
1830}
1831
Tim Petersa64dc242002-08-01 02:13:36 +00001832/* An adaptive, stable, natural mergesort. See listsort.txt.
1833 * Returns Py_None on success, NULL on error. Even in case of error, the
1834 * list will be some permutation of its input state (nothing is lost or
1835 * duplicated).
1836 */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001837static PyObject *
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00001838listsort(PyListObject *self, PyObject *args, PyObject *kwds)
Guido van Rossum3f236de1996-12-10 23:55:39 +00001839{
Tim Petersa64dc242002-08-01 02:13:36 +00001840 MergeState ms;
1841 PyObject **lo, **hi;
1842 int nremaining;
1843 int minrun;
Tim Petersb9099c32002-11-12 22:08:10 +00001844 int saved_ob_size;
1845 PyObject **saved_ob_item;
1846 PyObject **empty_ob_item;
Tim Petersa64dc242002-08-01 02:13:36 +00001847 PyObject *compare = NULL;
1848 PyObject *result = NULL; /* guilty until proved innocent */
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00001849 int reverse = 0;
1850 PyObject *keyfunc = NULL;
Michael W. Hudson1df0f652003-12-04 11:25:46 +00001851 int i;
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00001852 PyObject *key, *value, *kvpair;
1853 static char *kwlist[] = {"cmp", "key", "reverse", 0};
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001854
Tim Petersa64dc242002-08-01 02:13:36 +00001855 assert(self != NULL);
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00001856 assert (PyList_Check(self));
Guido van Rossum4aa24f92000-02-24 15:23:03 +00001857 if (args != NULL) {
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00001858 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OOi:sort",
1859 kwlist, &compare, &keyfunc, &reverse))
Guido van Rossum4aa24f92000-02-24 15:23:03 +00001860 return NULL;
1861 }
Skip Montanaro4abd5f02003-01-02 20:51:08 +00001862 if (compare == Py_None)
1863 compare = NULL;
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00001864 if (keyfunc == Py_None)
1865 keyfunc = NULL;
1866 if (compare != NULL && keyfunc != NULL) {
1867 compare = build_cmpwrapper(compare);
1868 if (compare == NULL)
Hye-Shik Chang19cb1932003-12-10 07:31:08 +00001869 return NULL;
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00001870 } else
1871 Py_XINCREF(compare);
1872
Tim Petersb9099c32002-11-12 22:08:10 +00001873 /* The list is temporarily made empty, so that mutations performed
1874 * by comparison functions can't affect the slice of memory we're
1875 * sorting (allowing mutations during sorting is a core-dump
1876 * factory, since ob_item may change).
1877 */
1878 saved_ob_size = self->ob_size;
1879 saved_ob_item = self->ob_item;
1880 self->ob_size = 0;
1881 self->ob_item = empty_ob_item = PyMem_NEW(PyObject *, 0);
Tim Peters330f9e92002-07-19 07:05:44 +00001882
Michael W. Hudson1df0f652003-12-04 11:25:46 +00001883 if (keyfunc != NULL) {
1884 for (i=0 ; i < saved_ob_size ; i++) {
1885 value = saved_ob_item[i];
1886 key = PyObject_CallFunctionObjArgs(keyfunc, value,
1887 NULL);
1888 if (key == NULL) {
1889 for (i=i-1 ; i>=0 ; i--) {
1890 kvpair = saved_ob_item[i];
1891 value = sortwrapper_getvalue(kvpair);
1892 saved_ob_item[i] = value;
1893 Py_DECREF(kvpair);
1894 }
1895 if (self->ob_item != empty_ob_item
1896 || self->ob_size) {
1897 /* If the list changed *as well* we
1898 have two errors. We let the first
1899 one "win", but we shouldn't let
1900 what's in the list currently
1901 leak. */
1902 (void)list_ass_slice(
1903 self, 0, self->ob_size,
1904 (PyObject *)NULL);
1905 }
1906
1907 goto dsu_fail;
1908 }
1909 kvpair = build_sortwrapper(key, value);
1910 if (kvpair == NULL)
1911 goto dsu_fail;
1912 saved_ob_item[i] = kvpair;
1913 }
1914 }
1915
1916 /* Reverse sort stability achieved by initially reversing the list,
1917 applying a stable forward sort, then reversing the final result. */
1918 if (reverse && saved_ob_size > 1)
1919 reverse_slice(saved_ob_item, saved_ob_item + saved_ob_size);
1920
1921 merge_init(&ms, compare);
1922
Tim Petersb9099c32002-11-12 22:08:10 +00001923 nremaining = saved_ob_size;
Tim Petersa64dc242002-08-01 02:13:36 +00001924 if (nremaining < 2)
1925 goto succeed;
Tim Peters330f9e92002-07-19 07:05:44 +00001926
Tim Petersa64dc242002-08-01 02:13:36 +00001927 /* March over the array once, left to right, finding natural runs,
1928 * and extending short natural runs to minrun elements.
1929 */
Tim Petersb9099c32002-11-12 22:08:10 +00001930 lo = saved_ob_item;
Tim Petersa64dc242002-08-01 02:13:36 +00001931 hi = lo + nremaining;
1932 minrun = merge_compute_minrun(nremaining);
1933 do {
1934 int descending;
1935 int n;
Tim Peters330f9e92002-07-19 07:05:44 +00001936
Tim Petersa64dc242002-08-01 02:13:36 +00001937 /* Identify next run. */
1938 n = count_run(lo, hi, compare, &descending);
1939 if (n < 0)
1940 goto fail;
1941 if (descending)
1942 reverse_slice(lo, lo + n);
1943 /* If short, extend to min(minrun, nremaining). */
1944 if (n < minrun) {
1945 const int force = nremaining <= minrun ?
1946 nremaining : minrun;
1947 if (binarysort(lo, lo + force, lo + n, compare) < 0)
1948 goto fail;
1949 n = force;
1950 }
1951 /* Push run onto pending-runs stack, and maybe merge. */
1952 assert(ms.n < MAX_MERGE_PENDING);
Tim Peterse05f65a2002-08-10 05:21:15 +00001953 ms.pending[ms.n].base = lo;
1954 ms.pending[ms.n].len = n;
Tim Petersa64dc242002-08-01 02:13:36 +00001955 ++ms.n;
1956 if (merge_collapse(&ms) < 0)
1957 goto fail;
1958 /* Advance to find next run. */
1959 lo += n;
1960 nremaining -= n;
1961 } while (nremaining);
1962 assert(lo == hi);
Tim Peters330f9e92002-07-19 07:05:44 +00001963
Tim Petersa64dc242002-08-01 02:13:36 +00001964 if (merge_force_collapse(&ms) < 0)
1965 goto fail;
1966 assert(ms.n == 1);
Tim Petersb9099c32002-11-12 22:08:10 +00001967 assert(ms.pending[0].base == saved_ob_item);
1968 assert(ms.pending[0].len == saved_ob_size);
Tim Petersa64dc242002-08-01 02:13:36 +00001969
1970succeed:
1971 result = Py_None;
Tim Peters330f9e92002-07-19 07:05:44 +00001972fail:
Michael W. Hudson1df0f652003-12-04 11:25:46 +00001973 if (keyfunc != NULL) {
1974 for (i=0 ; i < saved_ob_size ; i++) {
1975 kvpair = saved_ob_item[i];
1976 value = sortwrapper_getvalue(kvpair);
1977 saved_ob_item[i] = value;
1978 Py_DECREF(kvpair);
1979 }
1980 }
1981
Tim Petersb9099c32002-11-12 22:08:10 +00001982 if (self->ob_item != empty_ob_item || self->ob_size) {
1983 /* The user mucked with the list during the sort. */
1984 (void)list_ass_slice(self, 0, self->ob_size, (PyObject *)NULL);
1985 if (result != NULL) {
1986 PyErr_SetString(PyExc_ValueError,
1987 "list modified during sort");
1988 result = NULL;
1989 }
1990 }
Michael W. Hudson1df0f652003-12-04 11:25:46 +00001991
1992 if (reverse && saved_ob_size > 1)
1993 reverse_slice(saved_ob_item, saved_ob_item + saved_ob_size);
1994
1995 merge_freemem(&ms);
1996
1997dsu_fail:
Tim Petersb9099c32002-11-12 22:08:10 +00001998 if (self->ob_item == empty_ob_item)
1999 PyMem_FREE(empty_ob_item);
2000 self->ob_size = saved_ob_size;
2001 self->ob_item = saved_ob_item;
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00002002 Py_XDECREF(compare);
Tim Petersa64dc242002-08-01 02:13:36 +00002003 Py_XINCREF(result);
2004 return result;
Guido van Rossum3f236de1996-12-10 23:55:39 +00002005}
Tim Peters330f9e92002-07-19 07:05:44 +00002006#undef IFLT
Tim Peters66860f62002-08-04 17:47:26 +00002007#undef ISLT
Tim Peters330f9e92002-07-19 07:05:44 +00002008
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00002009int
Fred Drakea2f55112000-07-09 15:16:51 +00002010PyList_Sort(PyObject *v)
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00002011{
2012 if (v == NULL || !PyList_Check(v)) {
2013 PyErr_BadInternalCall();
2014 return -1;
2015 }
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00002016 v = listsort((PyListObject *)v, (PyObject *)NULL, (PyObject *)NULL);
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00002017 if (v == NULL)
2018 return -1;
2019 Py_DECREF(v);
2020 return 0;
2021}
2022
Guido van Rossumb86c5492001-02-12 22:06:02 +00002023static PyObject *
Raymond Hettinger0a9b9da2003-10-29 06:54:43 +00002024listsorted(PyObject *cls, PyObject *args, PyObject *kwds)
2025{
2026 PyObject *newlist, *v, *seq, *compare=NULL, *keyfunc=NULL, *newargs;
2027 static char *kwlist[] = {"iterable", "cmp", "key", "reverse", 0};
2028 long reverse;
2029
2030 if (args != NULL) {
2031 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|OOi:sorted",
2032 kwlist, &seq, &compare, &keyfunc, &reverse))
2033 return NULL;
2034 }
2035
2036 newlist = PyObject_CallFunctionObjArgs(cls, seq, NULL);
2037 if (newlist == NULL)
2038 return NULL;
2039
2040 newargs = PyTuple_GetSlice(args, 1, 4);
2041 if (newargs == NULL) {
2042 Py_DECREF(newlist);
2043 return NULL;
2044 }
2045 v = listsort((PyListObject *)newlist, newargs, kwds);
2046 Py_DECREF(newargs);
2047 if (v == NULL) {
2048 Py_DECREF(newlist);
2049 return NULL;
2050 }
2051 Py_DECREF(v);
2052 return newlist;
2053}
2054
2055static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00002056listreverse(PyListObject *self)
Guido van Rossumb86c5492001-02-12 22:06:02 +00002057{
Tim Peters326b4482002-07-19 04:04:16 +00002058 if (self->ob_size > 1)
2059 reverse_slice(self->ob_item, self->ob_item + self->ob_size);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002060 Py_INCREF(Py_None);
2061 return Py_None;
Guido van Rossumed98d481991-03-06 13:07:53 +00002062}
2063
Guido van Rossum84c76f51990-10-30 13:32:20 +00002064int
Fred Drakea2f55112000-07-09 15:16:51 +00002065PyList_Reverse(PyObject *v)
Guido van Rossumb0fe3a91995-01-17 16:34:45 +00002066{
Tim Peters6063e262002-08-08 01:06:39 +00002067 PyListObject *self = (PyListObject *)v;
2068
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002069 if (v == NULL || !PyList_Check(v)) {
2070 PyErr_BadInternalCall();
Guido van Rossumb0fe3a91995-01-17 16:34:45 +00002071 return -1;
2072 }
Tim Peters6063e262002-08-08 01:06:39 +00002073 if (self->ob_size > 1)
2074 reverse_slice(self->ob_item, self->ob_item + self->ob_size);
Guido van Rossumb0fe3a91995-01-17 16:34:45 +00002075 return 0;
2076}
2077
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002078PyObject *
Fred Drakea2f55112000-07-09 15:16:51 +00002079PyList_AsTuple(PyObject *v)
Guido van Rossum6cd2fe01994-08-29 12:45:32 +00002080{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002081 PyObject *w;
2082 PyObject **p;
Guido van Rossum6cd2fe01994-08-29 12:45:32 +00002083 int n;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002084 if (v == NULL || !PyList_Check(v)) {
2085 PyErr_BadInternalCall();
Guido van Rossum6cd2fe01994-08-29 12:45:32 +00002086 return NULL;
2087 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002088 n = ((PyListObject *)v)->ob_size;
2089 w = PyTuple_New(n);
Guido van Rossum6cd2fe01994-08-29 12:45:32 +00002090 if (w == NULL)
2091 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002092 p = ((PyTupleObject *)w)->ob_item;
Thomas Wouters334fb892000-07-25 12:56:38 +00002093 memcpy((void *)p,
2094 (void *)((PyListObject *)v)->ob_item,
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002095 n*sizeof(PyObject *));
Guido van Rossum6cd2fe01994-08-29 12:45:32 +00002096 while (--n >= 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002097 Py_INCREF(*p);
Guido van Rossum6cd2fe01994-08-29 12:45:32 +00002098 p++;
2099 }
2100 return w;
2101}
2102
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002103static PyObject *
Raymond Hettingerd05abde2003-06-17 05:05:49 +00002104listindex(PyListObject *self, PyObject *args)
Guido van Rossumed98d481991-03-06 13:07:53 +00002105{
Raymond Hettingerd05abde2003-06-17 05:05:49 +00002106 int i, start=0, stop=self->ob_size;
2107 PyObject *v;
Guido van Rossum4aa24f92000-02-24 15:23:03 +00002108
Walter Dörwalde8049bef2003-06-17 19:27:39 +00002109 if (!PyArg_ParseTuple(args, "O|O&O&:index", &v,
2110 _PyEval_SliceIndex, &start,
2111 _PyEval_SliceIndex, &stop))
Raymond Hettingerd05abde2003-06-17 05:05:49 +00002112 return NULL;
Guido van Rossum2743d872003-06-17 14:25:14 +00002113 if (start < 0) {
2114 start += self->ob_size;
2115 if (start < 0)
2116 start = 0;
2117 }
2118 if (stop < 0) {
2119 stop += self->ob_size;
2120 if (stop < 0)
2121 stop = 0;
2122 }
2123 else if (stop > self->ob_size)
2124 stop = self->ob_size;
Raymond Hettingerd05abde2003-06-17 05:05:49 +00002125 for (i = start; i < stop; i++) {
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002126 int cmp = PyObject_RichCompareBool(self->ob_item[i], v, Py_EQ);
2127 if (cmp > 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002128 return PyInt_FromLong((long)i);
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002129 else if (cmp < 0)
Guido van Rossumc8b6df91997-05-23 00:06:51 +00002130 return NULL;
Guido van Rossumed98d481991-03-06 13:07:53 +00002131 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002132 PyErr_SetString(PyExc_ValueError, "list.index(x): x not in list");
Guido van Rossumed98d481991-03-06 13:07:53 +00002133 return NULL;
2134}
2135
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002136static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00002137listcount(PyListObject *self, PyObject *v)
Guido van Rossume6f7d181991-10-20 20:20:40 +00002138{
2139 int count = 0;
2140 int i;
Guido van Rossum4aa24f92000-02-24 15:23:03 +00002141
Guido van Rossume6f7d181991-10-20 20:20:40 +00002142 for (i = 0; i < self->ob_size; i++) {
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002143 int cmp = PyObject_RichCompareBool(self->ob_item[i], v, Py_EQ);
2144 if (cmp > 0)
Guido van Rossume6f7d181991-10-20 20:20:40 +00002145 count++;
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002146 else if (cmp < 0)
Guido van Rossumc8b6df91997-05-23 00:06:51 +00002147 return NULL;
Guido van Rossume6f7d181991-10-20 20:20:40 +00002148 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002149 return PyInt_FromLong((long)count);
Guido van Rossume6f7d181991-10-20 20:20:40 +00002150}
2151
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002152static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00002153listremove(PyListObject *self, PyObject *v)
Guido van Rossumed98d481991-03-06 13:07:53 +00002154{
2155 int i;
Guido van Rossum4aa24f92000-02-24 15:23:03 +00002156
Guido van Rossumed98d481991-03-06 13:07:53 +00002157 for (i = 0; i < self->ob_size; i++) {
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002158 int cmp = PyObject_RichCompareBool(self->ob_item[i], v, Py_EQ);
2159 if (cmp > 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002160 if (list_ass_slice(self, i, i+1,
2161 (PyObject *)NULL) != 0)
Guido van Rossumed98d481991-03-06 13:07:53 +00002162 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002163 Py_INCREF(Py_None);
2164 return Py_None;
Guido van Rossumed98d481991-03-06 13:07:53 +00002165 }
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002166 else if (cmp < 0)
Guido van Rossumc8b6df91997-05-23 00:06:51 +00002167 return NULL;
Guido van Rossumed98d481991-03-06 13:07:53 +00002168 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002169 PyErr_SetString(PyExc_ValueError, "list.remove(x): x not in list");
Guido van Rossumed98d481991-03-06 13:07:53 +00002170 return NULL;
2171}
2172
Jeremy Hylton8caad492000-06-23 14:18:11 +00002173static int
2174list_traverse(PyListObject *o, visitproc visit, void *arg)
2175{
2176 int i, err;
2177 PyObject *x;
2178
2179 for (i = o->ob_size; --i >= 0; ) {
2180 x = o->ob_item[i];
2181 if (x != NULL) {
2182 err = visit(x, arg);
2183 if (err)
2184 return err;
2185 }
2186 }
2187 return 0;
2188}
2189
2190static int
2191list_clear(PyListObject *lp)
2192{
2193 (void) PyList_SetSlice((PyObject *)lp, 0, lp->ob_size, 0);
2194 return 0;
2195}
2196
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002197static PyObject *
2198list_richcompare(PyObject *v, PyObject *w, int op)
2199{
2200 PyListObject *vl, *wl;
2201 int i;
2202
2203 if (!PyList_Check(v) || !PyList_Check(w)) {
2204 Py_INCREF(Py_NotImplemented);
2205 return Py_NotImplemented;
2206 }
2207
2208 vl = (PyListObject *)v;
2209 wl = (PyListObject *)w;
2210
2211 if (vl->ob_size != wl->ob_size && (op == Py_EQ || op == Py_NE)) {
2212 /* Shortcut: if the lengths differ, the lists differ */
2213 PyObject *res;
2214 if (op == Py_EQ)
2215 res = Py_False;
2216 else
2217 res = Py_True;
2218 Py_INCREF(res);
2219 return res;
2220 }
2221
2222 /* Search for the first index where items are different */
2223 for (i = 0; i < vl->ob_size && i < wl->ob_size; i++) {
2224 int k = PyObject_RichCompareBool(vl->ob_item[i],
2225 wl->ob_item[i], Py_EQ);
2226 if (k < 0)
2227 return NULL;
2228 if (!k)
2229 break;
2230 }
2231
2232 if (i >= vl->ob_size || i >= wl->ob_size) {
2233 /* No more items to compare -- compare sizes */
2234 int vs = vl->ob_size;
2235 int ws = wl->ob_size;
2236 int cmp;
2237 PyObject *res;
2238 switch (op) {
2239 case Py_LT: cmp = vs < ws; break;
Tim Peters6ee42342001-07-06 17:45:43 +00002240 case Py_LE: cmp = vs <= ws; break;
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002241 case Py_EQ: cmp = vs == ws; break;
2242 case Py_NE: cmp = vs != ws; break;
2243 case Py_GT: cmp = vs > ws; break;
2244 case Py_GE: cmp = vs >= ws; break;
2245 default: return NULL; /* cannot happen */
2246 }
2247 if (cmp)
2248 res = Py_True;
2249 else
2250 res = Py_False;
2251 Py_INCREF(res);
2252 return res;
2253 }
2254
2255 /* We have an item that differs -- shortcuts for EQ/NE */
2256 if (op == Py_EQ) {
2257 Py_INCREF(Py_False);
2258 return Py_False;
2259 }
2260 if (op == Py_NE) {
2261 Py_INCREF(Py_True);
2262 return Py_True;
2263 }
2264
2265 /* Compare the final item again using the proper operator */
2266 return PyObject_RichCompare(vl->ob_item[i], wl->ob_item[i], op);
2267}
2268
Tim Peters6d6c1a32001-08-02 04:15:00 +00002269/* Adapted from newer code by Tim */
2270static int
2271list_fill(PyListObject *result, PyObject *v)
2272{
2273 PyObject *it; /* iter(v) */
2274 int n; /* guess for result list size */
2275 int i;
2276
2277 n = result->ob_size;
2278
2279 /* Special-case list(a_list), for speed. */
2280 if (PyList_Check(v)) {
2281 if (v == (PyObject *)result)
2282 return 0; /* source is destination, we're done */
2283 return list_ass_slice(result, 0, n, v);
2284 }
2285
2286 /* Empty previous contents */
2287 if (n != 0) {
2288 if (list_ass_slice(result, 0, n, (PyObject *)NULL) != 0)
2289 return -1;
2290 }
2291
2292 /* Get iterator. There may be some low-level efficiency to be gained
2293 * by caching the tp_iternext slot instead of using PyIter_Next()
2294 * later, but premature optimization is the root etc.
2295 */
2296 it = PyObject_GetIter(v);
2297 if (it == NULL)
2298 return -1;
2299
2300 /* Guess a result list size. */
2301 n = -1; /* unknown */
2302 if (PySequence_Check(v) &&
2303 v->ob_type->tp_as_sequence->sq_length) {
2304 n = PySequence_Size(v);
2305 if (n < 0)
2306 PyErr_Clear();
2307 }
2308 if (n < 0)
2309 n = 8; /* arbitrary */
2310 NRESIZE(result->ob_item, PyObject*, n);
Neal Norwitzd4e5be52002-05-22 23:19:17 +00002311 if (result->ob_item == NULL) {
2312 PyErr_NoMemory();
Tim Peters6d6c1a32001-08-02 04:15:00 +00002313 goto error;
Neal Norwitzd4e5be52002-05-22 23:19:17 +00002314 }
Neal Norwitz35fc7602002-06-13 21:11:11 +00002315 memset(result->ob_item, 0, sizeof(*result->ob_item) * n);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002316 result->ob_size = n;
2317
2318 /* Run iterator to exhaustion. */
2319 for (i = 0; ; i++) {
2320 PyObject *item = PyIter_Next(it);
2321 if (item == NULL) {
2322 if (PyErr_Occurred())
2323 goto error;
2324 break;
2325 }
2326 if (i < n)
2327 PyList_SET_ITEM(result, i, item); /* steals ref */
2328 else {
2329 int status = ins1(result, result->ob_size, item);
2330 Py_DECREF(item); /* append creates a new ref */
2331 if (status < 0)
2332 goto error;
2333 }
2334 }
2335
2336 /* Cut back result list if initial guess was too large. */
2337 if (i < n && result != NULL) {
2338 if (list_ass_slice(result, i, n, (PyObject *)NULL) != 0)
2339 goto error;
2340 }
2341 Py_DECREF(it);
2342 return 0;
2343
2344 error:
2345 Py_DECREF(it);
2346 return -1;
2347}
2348
2349static int
2350list_init(PyListObject *self, PyObject *args, PyObject *kw)
2351{
2352 PyObject *arg = NULL;
2353 static char *kwlist[] = {"sequence", 0};
2354
2355 if (!PyArg_ParseTupleAndKeywords(args, kw, "|O:list", kwlist, &arg))
2356 return -1;
2357 if (arg != NULL)
2358 return list_fill(self, arg);
2359 if (self->ob_size > 0)
2360 return list_ass_slice(self, 0, self->ob_size, (PyObject*)NULL);
2361 return 0;
2362}
2363
Guido van Rossumdbb53d92001-12-03 16:32:18 +00002364static long
2365list_nohash(PyObject *self)
2366{
2367 PyErr_SetString(PyExc_TypeError, "list objects are unhashable");
2368 return -1;
2369}
2370
Raymond Hettinger1021c442003-11-07 15:38:09 +00002371static PyObject *list_iter(PyObject *seq);
2372static PyObject *list_reversed(PyListObject* seq, PyObject* unused);
2373
Raymond Hettinger8f5cdaa2003-12-13 11:26:12 +00002374PyDoc_STRVAR(getitem_doc,
2375"x.__getitem__(y) <==> x[y]");
Raymond Hettinger1021c442003-11-07 15:38:09 +00002376PyDoc_STRVAR(reversed_doc,
2377"L.__reversed__() -- return a reverse iterator over the list");
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002378PyDoc_STRVAR(append_doc,
2379"L.append(object) -- append object to end");
2380PyDoc_STRVAR(extend_doc,
Raymond Hettingerf8bcfb12002-12-29 05:49:09 +00002381"L.extend(iterable) -- extend list by appending elements from the iterable");
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002382PyDoc_STRVAR(insert_doc,
2383"L.insert(index, object) -- insert object before index");
2384PyDoc_STRVAR(pop_doc,
2385"L.pop([index]) -> item -- remove and return item at index (default last)");
2386PyDoc_STRVAR(remove_doc,
2387"L.remove(value) -- remove first occurrence of value");
2388PyDoc_STRVAR(index_doc,
Raymond Hettingerd05abde2003-06-17 05:05:49 +00002389"L.index(value, [start, [stop]]) -> integer -- return first index of value");
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002390PyDoc_STRVAR(count_doc,
2391"L.count(value) -> integer -- return number of occurrences of value");
2392PyDoc_STRVAR(reverse_doc,
2393"L.reverse() -- reverse *IN PLACE*");
2394PyDoc_STRVAR(sort_doc,
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00002395"L.sort(cmp=None, key=None, reverse=False) -- stable sort *IN PLACE*;\n\
2396cmp(x, y) -> -1, 0, 1");
Raymond Hettinger0a9b9da2003-10-29 06:54:43 +00002397PyDoc_STRVAR(sorted_doc,
2398"list.sorted(iterable, cmp=None, key=None, reverse=False) --> new sorted list;\n\
2399cmp(x, y) -> -1, 0, 1");
Guido van Rossum3dd7f3f1998-06-30 15:36:32 +00002400
Raymond Hettinger8f5cdaa2003-12-13 11:26:12 +00002401static PyObject *list_subscript(PyListObject*, PyObject*);
2402
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002403static PyMethodDef list_methods[] = {
Raymond Hettinger8f5cdaa2003-12-13 11:26:12 +00002404 {"__getitem__", (PyCFunction)list_subscript, METH_O|METH_COEXIST, getitem_doc},
Raymond Hettinger1021c442003-11-07 15:38:09 +00002405 {"__reversed__",(PyCFunction)list_reversed, METH_NOARGS, reversed_doc},
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00002406 {"append", (PyCFunction)listappend, METH_O, append_doc},
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002407 {"insert", (PyCFunction)listinsert, METH_VARARGS, insert_doc},
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00002408 {"extend", (PyCFunction)listextend, METH_O, extend_doc},
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002409 {"pop", (PyCFunction)listpop, METH_VARARGS, pop_doc},
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00002410 {"remove", (PyCFunction)listremove, METH_O, remove_doc},
Raymond Hettingerd05abde2003-06-17 05:05:49 +00002411 {"index", (PyCFunction)listindex, METH_VARARGS, index_doc},
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00002412 {"count", (PyCFunction)listcount, METH_O, count_doc},
2413 {"reverse", (PyCFunction)listreverse, METH_NOARGS, reverse_doc},
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00002414 {"sort", (PyCFunction)listsort, METH_VARARGS | METH_KEYWORDS, sort_doc},
Raymond Hettinger0a9b9da2003-10-29 06:54:43 +00002415 {"sorted", (PyCFunction)listsorted,
2416 METH_VARARGS | METH_KEYWORDS | METH_CLASS, sorted_doc},
Tim Petersa64dc242002-08-01 02:13:36 +00002417 {NULL, NULL} /* sentinel */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002418};
2419
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002420static PySequenceMethods list_as_sequence = {
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002421 (inquiry)list_length, /* sq_length */
2422 (binaryfunc)list_concat, /* sq_concat */
2423 (intargfunc)list_repeat, /* sq_repeat */
2424 (intargfunc)list_item, /* sq_item */
2425 (intintargfunc)list_slice, /* sq_slice */
2426 (intobjargproc)list_ass_item, /* sq_ass_item */
2427 (intintobjargproc)list_ass_slice, /* sq_ass_slice */
2428 (objobjproc)list_contains, /* sq_contains */
2429 (binaryfunc)list_inplace_concat, /* sq_inplace_concat */
2430 (intargfunc)list_inplace_repeat, /* sq_inplace_repeat */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002431};
2432
Neal Norwitz2c2e8272002-06-14 02:04:18 +00002433PyDoc_STRVAR(list_doc,
Tim Peters6d6c1a32001-08-02 04:15:00 +00002434"list() -> new list\n"
Neal Norwitz2c2e8272002-06-14 02:04:18 +00002435"list(sequence) -> new list initialized from sequence's items");
Tim Peters6d6c1a32001-08-02 04:15:00 +00002436
Jeremy Hyltona4b4c3b2002-07-13 03:51:17 +00002437static PyObject *
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002438list_subscript(PyListObject* self, PyObject* item)
2439{
2440 if (PyInt_Check(item)) {
2441 long i = PyInt_AS_LONG(item);
2442 if (i < 0)
2443 i += PyList_GET_SIZE(self);
2444 return list_item(self, i);
2445 }
2446 else if (PyLong_Check(item)) {
2447 long i = PyLong_AsLong(item);
2448 if (i == -1 && PyErr_Occurred())
2449 return NULL;
2450 if (i < 0)
2451 i += PyList_GET_SIZE(self);
2452 return list_item(self, i);
2453 }
2454 else if (PySlice_Check(item)) {
2455 int start, stop, step, slicelength, cur, i;
2456 PyObject* result;
2457 PyObject* it;
2458
2459 if (PySlice_GetIndicesEx((PySliceObject*)item, self->ob_size,
2460 &start, &stop, &step, &slicelength) < 0) {
2461 return NULL;
2462 }
2463
2464 if (slicelength <= 0) {
2465 return PyList_New(0);
2466 }
2467 else {
2468 result = PyList_New(slicelength);
2469 if (!result) return NULL;
2470
Tim Peters3b01a122002-07-19 02:35:45 +00002471 for (cur = start, i = 0; i < slicelength;
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002472 cur += step, i++) {
2473 it = PyList_GET_ITEM(self, cur);
2474 Py_INCREF(it);
2475 PyList_SET_ITEM(result, i, it);
2476 }
Tim Peters3b01a122002-07-19 02:35:45 +00002477
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002478 return result;
2479 }
2480 }
2481 else {
2482 PyErr_SetString(PyExc_TypeError,
2483 "list indices must be integers");
2484 return NULL;
2485 }
2486}
2487
Tim Peters3b01a122002-07-19 02:35:45 +00002488static int
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002489list_ass_subscript(PyListObject* self, PyObject* item, PyObject* value)
2490{
2491 if (PyInt_Check(item)) {
2492 long i = PyInt_AS_LONG(item);
2493 if (i < 0)
2494 i += PyList_GET_SIZE(self);
2495 return list_ass_item(self, i, value);
2496 }
2497 else if (PyLong_Check(item)) {
2498 long i = PyLong_AsLong(item);
2499 if (i == -1 && PyErr_Occurred())
2500 return -1;
2501 if (i < 0)
2502 i += PyList_GET_SIZE(self);
2503 return list_ass_item(self, i, value);
2504 }
2505 else if (PySlice_Check(item)) {
2506 int start, stop, step, slicelength;
2507
2508 if (PySlice_GetIndicesEx((PySliceObject*)item, self->ob_size,
2509 &start, &stop, &step, &slicelength) < 0) {
2510 return -1;
2511 }
2512
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00002513 /* treat L[slice(a,b)] = v _exactly_ like L[a:b] = v */
2514 if (step == 1 && ((PySliceObject*)item)->step == Py_None)
2515 return list_ass_slice(self, start, stop, value);
2516
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002517 if (value == NULL) {
2518 /* delete slice */
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00002519 PyObject **garbage, **it;
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002520 int cur, i, j;
Tim Peters3b01a122002-07-19 02:35:45 +00002521
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002522 if (slicelength <= 0)
2523 return 0;
2524
2525 if (step < 0) {
2526 stop = start + 1;
2527 start = stop + step*(slicelength - 1) - 1;
2528 step = -step;
2529 }
2530
2531 garbage = (PyObject**)
2532 PyMem_MALLOC(slicelength*sizeof(PyObject*));
Tim Peters3b01a122002-07-19 02:35:45 +00002533
2534 /* drawing pictures might help
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002535 understand these for loops */
Guido van Rossum75a20b12002-06-11 12:22:28 +00002536 for (cur = start, i = 0;
2537 cur < stop;
Michael W. Hudson56796f62002-07-29 14:35:04 +00002538 cur += step, i++) {
2539 int lim = step;
2540
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002541 garbage[i] = PyList_GET_ITEM(self, cur);
2542
Michael W. Hudson56796f62002-07-29 14:35:04 +00002543 if (cur + step >= self->ob_size) {
2544 lim = self->ob_size - cur - 1;
2545 }
2546
2547 for (j = 0; j < lim; j++) {
Tim Peters3b01a122002-07-19 02:35:45 +00002548 PyList_SET_ITEM(self, cur + j - i,
Guido van Rossum75a20b12002-06-11 12:22:28 +00002549 PyList_GET_ITEM(self,
2550 cur + j + 1));
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002551 }
2552 }
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00002553 for (cur = start + slicelength*step + 1;
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002554 cur < self->ob_size; cur++) {
2555 PyList_SET_ITEM(self, cur - slicelength,
2556 PyList_GET_ITEM(self, cur));
2557 }
2558 self->ob_size -= slicelength;
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00002559 it = self->ob_item;
2560 NRESIZE(it, PyObject*, self->ob_size);
2561 self->ob_item = it;
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002562
2563 for (i = 0; i < slicelength; i++) {
2564 Py_DECREF(garbage[i]);
2565 }
2566 PyMem_FREE(garbage);
2567
2568 return 0;
2569 }
2570 else {
2571 /* assign slice */
Michael W. Hudsona69c0302002-12-05 21:32:32 +00002572 PyObject **garbage, *ins, *seq;
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002573 int cur, i;
2574
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002575 /* protect against a[::-1] = a */
Tim Peters3b01a122002-07-19 02:35:45 +00002576 if (self == (PyListObject*)value) {
Michael W. Hudsona69c0302002-12-05 21:32:32 +00002577 seq = list_slice((PyListObject*)value, 0,
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002578 PyList_GET_SIZE(value));
Tim Peters3b01a122002-07-19 02:35:45 +00002579 }
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002580 else {
Michael W. Hudsona69c0302002-12-05 21:32:32 +00002581 char msg[256];
2582 PyOS_snprintf(msg, sizeof(msg),
2583 "must assign sequence (not \"%.200s\") to extended slice",
2584 value->ob_type->tp_name);
2585 seq = PySequence_Fast(value, msg);
2586 if (!seq)
2587 return -1;
2588 }
2589
2590 if (PySequence_Fast_GET_SIZE(seq) != slicelength) {
2591 PyErr_Format(PyExc_ValueError,
2592 "attempt to assign sequence of size %d to extended slice of size %d",
2593 PySequence_Fast_GET_SIZE(seq),
2594 slicelength);
2595 Py_DECREF(seq);
2596 return -1;
2597 }
2598
2599 if (!slicelength) {
2600 Py_DECREF(seq);
2601 return 0;
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002602 }
2603
2604 garbage = (PyObject**)
2605 PyMem_MALLOC(slicelength*sizeof(PyObject*));
Tim Peters3b01a122002-07-19 02:35:45 +00002606
2607 for (cur = start, i = 0; i < slicelength;
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002608 cur += step, i++) {
2609 garbage[i] = PyList_GET_ITEM(self, cur);
Tim Peters3b01a122002-07-19 02:35:45 +00002610
Michael W. Hudsona69c0302002-12-05 21:32:32 +00002611 ins = PySequence_Fast_GET_ITEM(seq, i);
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002612 Py_INCREF(ins);
2613 PyList_SET_ITEM(self, cur, ins);
2614 }
2615
2616 for (i = 0; i < slicelength; i++) {
2617 Py_DECREF(garbage[i]);
2618 }
Tim Peters3b01a122002-07-19 02:35:45 +00002619
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002620 PyMem_FREE(garbage);
Michael W. Hudsona69c0302002-12-05 21:32:32 +00002621 Py_DECREF(seq);
Tim Peters3b01a122002-07-19 02:35:45 +00002622
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002623 return 0;
2624 }
Tim Peters3b01a122002-07-19 02:35:45 +00002625 }
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002626 else {
Tim Peters3b01a122002-07-19 02:35:45 +00002627 PyErr_SetString(PyExc_TypeError,
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002628 "list indices must be integers");
2629 return -1;
2630 }
2631}
2632
2633static PyMappingMethods list_as_mapping = {
2634 (inquiry)list_length,
2635 (binaryfunc)list_subscript,
2636 (objobjargproc)list_ass_subscript
2637};
2638
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002639PyTypeObject PyList_Type = {
2640 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002641 0,
2642 "list",
Neil Schemenauere83c00e2001-08-29 23:54:21 +00002643 sizeof(PyListObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002644 0,
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002645 (destructor)list_dealloc, /* tp_dealloc */
2646 (printfunc)list_print, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002647 0, /* tp_getattr */
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002648 0, /* tp_setattr */
2649 0, /* tp_compare */
2650 (reprfunc)list_repr, /* tp_repr */
2651 0, /* tp_as_number */
2652 &list_as_sequence, /* tp_as_sequence */
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002653 &list_as_mapping, /* tp_as_mapping */
Guido van Rossumdbb53d92001-12-03 16:32:18 +00002654 list_nohash, /* tp_hash */
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002655 0, /* tp_call */
2656 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002657 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002658 0, /* tp_setattro */
2659 0, /* tp_as_buffer */
Neil Schemenauere83c00e2001-08-29 23:54:21 +00002660 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
Tim Peters6d6c1a32001-08-02 04:15:00 +00002661 Py_TPFLAGS_BASETYPE, /* tp_flags */
2662 list_doc, /* tp_doc */
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002663 (traverseproc)list_traverse, /* tp_traverse */
2664 (inquiry)list_clear, /* tp_clear */
2665 list_richcompare, /* tp_richcompare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002666 0, /* tp_weaklistoffset */
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002667 list_iter, /* tp_iter */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002668 0, /* tp_iternext */
2669 list_methods, /* tp_methods */
2670 0, /* tp_members */
2671 0, /* tp_getset */
2672 0, /* tp_base */
2673 0, /* tp_dict */
2674 0, /* tp_descr_get */
2675 0, /* tp_descr_set */
2676 0, /* tp_dictoffset */
2677 (initproc)list_init, /* tp_init */
2678 PyType_GenericAlloc, /* tp_alloc */
2679 PyType_GenericNew, /* tp_new */
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002680 PyObject_GC_Del, /* tp_free */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002681};
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00002682
2683
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002684/*********************** List Iterator **************************/
2685
2686typedef struct {
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002687 PyObject_HEAD
2688 long it_index;
Guido van Rossum86103ae2002-07-16 20:07:32 +00002689 PyListObject *it_seq; /* Set to NULL when iterator is exhausted */
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002690} listiterobject;
2691
2692PyTypeObject PyListIter_Type;
2693
Guido van Rossum5086e492002-07-16 15:56:52 +00002694static PyObject *
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002695list_iter(PyObject *seq)
2696{
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002697 listiterobject *it;
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002698
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002699 if (!PyList_Check(seq)) {
2700 PyErr_BadInternalCall();
2701 return NULL;
2702 }
2703 it = PyObject_GC_New(listiterobject, &PyListIter_Type);
2704 if (it == NULL)
2705 return NULL;
2706 it->it_index = 0;
2707 Py_INCREF(seq);
2708 it->it_seq = (PyListObject *)seq;
2709 _PyObject_GC_TRACK(it);
2710 return (PyObject *)it;
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002711}
2712
2713static void
2714listiter_dealloc(listiterobject *it)
2715{
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002716 _PyObject_GC_UNTRACK(it);
Guido van Rossum86103ae2002-07-16 20:07:32 +00002717 Py_XDECREF(it->it_seq);
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002718 PyObject_GC_Del(it);
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002719}
2720
2721static int
2722listiter_traverse(listiterobject *it, visitproc visit, void *arg)
2723{
Guido van Rossum86103ae2002-07-16 20:07:32 +00002724 if (it->it_seq == NULL)
2725 return 0;
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002726 return visit((PyObject *)it->it_seq, arg);
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002727}
2728
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002729static PyObject *
Tim Peters93b2cc42002-06-01 05:22:55 +00002730listiter_next(listiterobject *it)
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002731{
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002732 PyListObject *seq;
2733 PyObject *item;
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002734
Tim Peters93b2cc42002-06-01 05:22:55 +00002735 assert(it != NULL);
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002736 seq = it->it_seq;
Guido van Rossum86103ae2002-07-16 20:07:32 +00002737 if (seq == NULL)
2738 return NULL;
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002739 assert(PyList_Check(seq));
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002740
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002741 if (it->it_index < PyList_GET_SIZE(seq)) {
Tim Peters93b2cc42002-06-01 05:22:55 +00002742 item = PyList_GET_ITEM(seq, it->it_index);
2743 ++it->it_index;
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002744 Py_INCREF(item);
2745 return item;
2746 }
Guido van Rossum86103ae2002-07-16 20:07:32 +00002747
2748 Py_DECREF(seq);
2749 it->it_seq = NULL;
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002750 return NULL;
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002751}
2752
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002753PyTypeObject PyListIter_Type = {
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002754 PyObject_HEAD_INIT(&PyType_Type)
2755 0, /* ob_size */
2756 "listiterator", /* tp_name */
2757 sizeof(listiterobject), /* tp_basicsize */
2758 0, /* tp_itemsize */
2759 /* methods */
2760 (destructor)listiter_dealloc, /* tp_dealloc */
2761 0, /* tp_print */
2762 0, /* tp_getattr */
2763 0, /* tp_setattr */
2764 0, /* tp_compare */
2765 0, /* tp_repr */
2766 0, /* tp_as_number */
2767 0, /* tp_as_sequence */
2768 0, /* tp_as_mapping */
2769 0, /* tp_hash */
2770 0, /* tp_call */
2771 0, /* tp_str */
2772 PyObject_GenericGetAttr, /* tp_getattro */
2773 0, /* tp_setattro */
2774 0, /* tp_as_buffer */
2775 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
2776 0, /* tp_doc */
2777 (traverseproc)listiter_traverse, /* tp_traverse */
2778 0, /* tp_clear */
2779 0, /* tp_richcompare */
2780 0, /* tp_weaklistoffset */
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +00002781 PyObject_SelfIter, /* tp_iter */
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002782 (iternextfunc)listiter_next, /* tp_iternext */
Guido van Rossum86103ae2002-07-16 20:07:32 +00002783 0, /* tp_methods */
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002784 0, /* tp_members */
2785 0, /* tp_getset */
2786 0, /* tp_base */
2787 0, /* tp_dict */
2788 0, /* tp_descr_get */
2789 0, /* tp_descr_set */
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002790};
Raymond Hettinger1021c442003-11-07 15:38:09 +00002791
2792/*********************** List Reverse Iterator **************************/
2793
2794typedef struct {
2795 PyObject_HEAD
2796 long it_index;
Raymond Hettinger001f2282003-11-08 11:58:44 +00002797 PyListObject *it_seq; /* Set to NULL when iterator is exhausted */
Raymond Hettinger1021c442003-11-07 15:38:09 +00002798} listreviterobject;
2799
2800PyTypeObject PyListRevIter_Type;
2801
2802static PyObject *
2803list_reversed(PyListObject *seq, PyObject *unused)
2804{
2805 listreviterobject *it;
2806
2807 it = PyObject_GC_New(listreviterobject, &PyListRevIter_Type);
2808 if (it == NULL)
2809 return NULL;
2810 assert(PyList_Check(seq));
2811 it->it_index = PyList_GET_SIZE(seq) - 1;
2812 Py_INCREF(seq);
2813 it->it_seq = seq;
2814 PyObject_GC_Track(it);
2815 return (PyObject *)it;
2816}
2817
2818static void
2819listreviter_dealloc(listreviterobject *it)
2820{
2821 PyObject_GC_UnTrack(it);
2822 Py_XDECREF(it->it_seq);
2823 PyObject_GC_Del(it);
2824}
2825
2826static int
2827listreviter_traverse(listreviterobject *it, visitproc visit, void *arg)
2828{
2829 if (it->it_seq == NULL)
2830 return 0;
2831 return visit((PyObject *)it->it_seq, arg);
2832}
2833
2834static PyObject *
2835listreviter_next(listreviterobject *it)
2836{
2837 PyObject *item = NULL;
2838
2839 assert(PyList_Check(it->it_seq));
2840 if (it->it_index >= 0) {
2841 assert(it->it_index < PyList_GET_SIZE(it->it_seq));
2842 item = PyList_GET_ITEM(it->it_seq, it->it_index);
2843 it->it_index--;
2844 Py_INCREF(item);
Raymond Hettinger001f2282003-11-08 11:58:44 +00002845 } else if (it->it_seq != NULL) {
2846 Py_DECREF(it->it_seq);
2847 it->it_seq = NULL;
Raymond Hettinger1021c442003-11-07 15:38:09 +00002848 }
2849 return item;
2850}
2851
2852PyTypeObject PyListRevIter_Type = {
2853 PyObject_HEAD_INIT(&PyType_Type)
2854 0, /* ob_size */
2855 "listreverseiterator", /* tp_name */
2856 sizeof(listreviterobject), /* tp_basicsize */
2857 0, /* tp_itemsize */
2858 /* methods */
2859 (destructor)listreviter_dealloc, /* tp_dealloc */
2860 0, /* tp_print */
2861 0, /* tp_getattr */
2862 0, /* tp_setattr */
2863 0, /* tp_compare */
2864 0, /* tp_repr */
2865 0, /* tp_as_number */
2866 0, /* tp_as_sequence */
2867 0, /* tp_as_mapping */
2868 0, /* tp_hash */
2869 0, /* tp_call */
2870 0, /* tp_str */
2871 PyObject_GenericGetAttr, /* tp_getattro */
2872 0, /* tp_setattro */
2873 0, /* tp_as_buffer */
2874 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
2875 0, /* tp_doc */
2876 (traverseproc)listreviter_traverse, /* tp_traverse */
2877 0, /* tp_clear */
2878 0, /* tp_richcompare */
2879 0, /* tp_weaklistoffset */
2880 PyObject_SelfIter, /* tp_iter */
2881 (iternextfunc)listreviter_next, /* tp_iternext */
2882 0,
2883};