blob: bf4466a1a2d21bac0aaac928b1e4c07e289900e3 [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
Tim Peters8d9eb102004-07-31 02:24:20 +000011/* Ensure ob_item has room for at least newsize elements, and set
12 * ob_size to newsize. If newsize > ob_size on entry, the content
13 * of the new slots at exit is undefined heap trash; it's the caller's
14 * responsiblity to overwrite them with sane values.
15 * The number of allocated elements may grow, shrink, or stay the same.
16 * Failure is impossible if newsize <= self.allocated on entry, although
17 * that partly relies on an assumption that the system realloc() never
18 * fails when passed a number of bytes <= the number of bytes last
19 * allocated (the C standard doesn't guarantee this, but it's hard to
20 * imagine a realloc implementation where it wouldn't be true).
21 * Note that self->ob_item may change, and even if newsize is less
22 * than ob_size on entry.
23 */
Guido van Rossuma46d51d1995-01-26 22:59:43 +000024static int
Martin v. Löwis18e16552006-02-15 17:27:45 +000025list_resize(PyListObject *self, Py_ssize_t newsize)
Guido van Rossuma46d51d1995-01-26 22:59:43 +000026{
Raymond Hettinger4bb95402004-02-13 11:36:39 +000027 PyObject **items;
Raymond Hettingera84f3ab2004-09-12 19:53:07 +000028 size_t new_allocated;
Martin v. Löwis18e16552006-02-15 17:27:45 +000029 Py_ssize_t allocated = self->allocated;
Tim Peters65b8b842001-05-26 05:28:40 +000030
Raymond Hettinger4bb95402004-02-13 11:36:39 +000031 /* Bypass realloc() when a previous overallocation is large enough
Raymond Hettingera84f3ab2004-09-12 19:53:07 +000032 to accommodate the newsize. If the newsize falls lower than half
33 the allocated size, then proceed with the realloc() to shrink the list.
Raymond Hettinger4bb95402004-02-13 11:36:39 +000034 */
Raymond Hettingera84f3ab2004-09-12 19:53:07 +000035 if (allocated >= newsize && newsize >= (allocated >> 1)) {
Raymond Hettingerc0aaa2d2004-07-29 23:31:29 +000036 assert(self->ob_item != NULL || newsize == 0);
Raymond Hettinger4bb95402004-02-13 11:36:39 +000037 self->ob_size = newsize;
38 return 0;
39 }
40
41 /* This over-allocates proportional to the list size, making room
Tim Peters65b8b842001-05-26 05:28:40 +000042 * for additional growth. The over-allocation is mild, but is
43 * enough to give linear-time amortized behavior over a long
44 * sequence of appends() in the presence of a poorly-performing
Raymond Hettingerab517d22004-02-14 18:34:46 +000045 * system realloc().
46 * The growth pattern is: 0, 4, 8, 16, 25, 35, 46, 58, 72, 88, ...
Tim Peters65b8b842001-05-26 05:28:40 +000047 */
Raymond Hettingera84f3ab2004-09-12 19:53:07 +000048 new_allocated = (newsize >> 3) + (newsize < 9 ? 3 : 6) + newsize;
49 if (newsize == 0)
50 new_allocated = 0;
Raymond Hettinger4bb95402004-02-13 11:36:39 +000051 items = self->ob_item;
Raymond Hettingera84f3ab2004-09-12 19:53:07 +000052 if (new_allocated <= ((~(size_t)0) / sizeof(PyObject *)))
53 PyMem_RESIZE(items, PyObject *, new_allocated);
Raymond Hettinger4bb95402004-02-13 11:36:39 +000054 else
55 items = NULL;
56 if (items == NULL) {
57 PyErr_NoMemory();
58 return -1;
59 }
60 self->ob_item = items;
61 self->ob_size = newsize;
Raymond Hettingera84f3ab2004-09-12 19:53:07 +000062 self->allocated = new_allocated;
Raymond Hettinger4bb95402004-02-13 11:36:39 +000063 return 0;
64}
Guido van Rossuma46d51d1995-01-26 22:59:43 +000065
Raymond Hettinger0468e412004-05-05 05:37:53 +000066/* Empty list reuse scheme to save calls to malloc and free */
67#define MAXFREELISTS 80
68static PyListObject *free_lists[MAXFREELISTS];
69static int num_free_lists = 0;
70
Raymond Hettingerfb09f0e2004-10-07 03:58:07 +000071void
72PyList_Fini(void)
73{
74 PyListObject *op;
75
76 while (num_free_lists) {
77 num_free_lists--;
78 op = free_lists[num_free_lists];
79 assert(PyList_CheckExact(op));
80 PyObject_GC_Del(op);
81 }
82}
83
Guido van Rossumc0b618a1997-05-02 03:12:38 +000084PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +000085PyList_New(Py_ssize_t size)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000086{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000087 PyListObject *op;
Guido van Rossum6cd2fe01994-08-29 12:45:32 +000088 size_t nbytes;
Tim Peters3986d4e2004-07-29 02:28:42 +000089
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000090 if (size < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +000091 PyErr_BadInternalCall();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000092 return NULL;
93 }
Tim Peters7049d812004-01-18 20:31:02 +000094 nbytes = size * sizeof(PyObject *);
Guido van Rossum1e28e5e1992-08-19 16:46:30 +000095 /* Check for overflow */
Raymond Hettingerfdfe6182004-05-05 06:28:16 +000096 if (nbytes / sizeof(PyObject *) != (size_t)size)
Guido van Rossumc0b618a1997-05-02 03:12:38 +000097 return PyErr_NoMemory();
Raymond Hettinger0468e412004-05-05 05:37:53 +000098 if (num_free_lists) {
99 num_free_lists--;
100 op = free_lists[num_free_lists];
101 _Py_NewReference((PyObject *)op);
102 } else {
103 op = PyObject_GC_New(PyListObject, &PyList_Type);
104 if (op == NULL)
105 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000106 }
Raymond Hettingerfdfe6182004-05-05 06:28:16 +0000107 if (size <= 0)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000108 op->ob_item = NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000109 else {
Guido van Rossumb18618d2000-05-03 23:44:39 +0000110 op->ob_item = (PyObject **) PyMem_MALLOC(nbytes);
Neal Norwitza00c0b92006-06-12 02:08:41 +0000111 if (op->ob_item == NULL) {
112 Py_DECREF(op);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000113 return PyErr_NoMemory();
Neal Norwitza00c0b92006-06-12 02:08:41 +0000114 }
Tim Peters3986d4e2004-07-29 02:28:42 +0000115 memset(op->ob_item, 0, nbytes);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000116 }
Neil Schemenauere83c00e2001-08-29 23:54:21 +0000117 op->ob_size = size;
Raymond Hettinger4bb95402004-02-13 11:36:39 +0000118 op->allocated = size;
Neil Schemenauere83c00e2001-08-29 23:54:21 +0000119 _PyObject_GC_TRACK(op);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000120 return (PyObject *) op;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000121}
122
Martin v. Löwis18e16552006-02-15 17:27:45 +0000123Py_ssize_t
Fred Drakea2f55112000-07-09 15:16:51 +0000124PyList_Size(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000125{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000126 if (!PyList_Check(op)) {
127 PyErr_BadInternalCall();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000128 return -1;
129 }
130 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000131 return ((PyListObject *)op) -> ob_size;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000132}
133
Raymond Hettingerfdfe6182004-05-05 06:28:16 +0000134static PyObject *indexerr = NULL;
Guido van Rossum929f1b81996-08-09 20:51:27 +0000135
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000136PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000137PyList_GetItem(PyObject *op, Py_ssize_t i)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000138{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000139 if (!PyList_Check(op)) {
140 PyErr_BadInternalCall();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000141 return NULL;
142 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000143 if (i < 0 || i >= ((PyListObject *)op) -> ob_size) {
Guido van Rossum929f1b81996-08-09 20:51:27 +0000144 if (indexerr == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000145 indexerr = PyString_FromString(
146 "list index out of range");
147 PyErr_SetObject(PyExc_IndexError, indexerr);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000148 return NULL;
149 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000150 return ((PyListObject *)op) -> ob_item[i];
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000151}
152
153int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000154PyList_SetItem(register PyObject *op, register Py_ssize_t i,
Fred Drakea2f55112000-07-09 15:16:51 +0000155 register PyObject *newitem)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000156{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000157 register PyObject *olditem;
158 register PyObject **p;
159 if (!PyList_Check(op)) {
160 Py_XDECREF(newitem);
161 PyErr_BadInternalCall();
Guido van Rossum2a9096b1990-10-21 22:15:08 +0000162 return -1;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000163 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000164 if (i < 0 || i >= ((PyListObject *)op) -> ob_size) {
165 Py_XDECREF(newitem);
166 PyErr_SetString(PyExc_IndexError,
167 "list assignment index out of range");
Guido van Rossum2a9096b1990-10-21 22:15:08 +0000168 return -1;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000169 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000170 p = ((PyListObject *)op) -> ob_item + i;
Guido van Rossum5fe60581995-03-09 12:12:50 +0000171 olditem = *p;
172 *p = newitem;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000173 Py_XDECREF(olditem);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000174 return 0;
175}
176
177static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000178ins1(PyListObject *self, Py_ssize_t where, PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000179{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000180 Py_ssize_t i, n = self->ob_size;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000181 PyObject **items;
Guido van Rossum2a9096b1990-10-21 22:15:08 +0000182 if (v == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000183 PyErr_BadInternalCall();
Guido van Rossum2a9096b1990-10-21 22:15:08 +0000184 return -1;
185 }
Martin v. Löwisb1ed7fa2006-04-13 07:52:27 +0000186 if (n == PY_SSIZE_T_MAX) {
Trent Micka5846642000-08-13 22:47:45 +0000187 PyErr_SetString(PyExc_OverflowError,
188 "cannot add more objects to list");
189 return -1;
190 }
Tim Petersb38e2b62004-07-29 02:29:26 +0000191
Raymond Hettingerd4ff7412004-03-15 09:01:31 +0000192 if (list_resize(self, n+1) == -1)
Guido van Rossum2a9096b1990-10-21 22:15:08 +0000193 return -1;
Raymond Hettinger4bb95402004-02-13 11:36:39 +0000194
Guido van Rossum3a3cca52003-04-14 20:58:14 +0000195 if (where < 0) {
Raymond Hettinger4bb95402004-02-13 11:36:39 +0000196 where += n;
Guido van Rossum3a3cca52003-04-14 20:58:14 +0000197 if (where < 0)
198 where = 0;
199 }
Raymond Hettinger4bb95402004-02-13 11:36:39 +0000200 if (where > n)
201 where = n;
202 items = self->ob_item;
203 for (i = n; --i >= where; )
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000204 items[i+1] = items[i];
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000205 Py_INCREF(v);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000206 items[where] = v;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000207 return 0;
208}
209
210int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000211PyList_Insert(PyObject *op, Py_ssize_t where, PyObject *newitem)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000212{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000213 if (!PyList_Check(op)) {
214 PyErr_BadInternalCall();
Guido van Rossum2a9096b1990-10-21 22:15:08 +0000215 return -1;
216 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000217 return ins1((PyListObject *)op, where, newitem);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000218}
219
Raymond Hettinger40a03822004-04-12 13:05:09 +0000220static int
221app1(PyListObject *self, PyObject *v)
222{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000223 Py_ssize_t n = PyList_GET_SIZE(self);
Raymond Hettinger40a03822004-04-12 13:05:09 +0000224
225 assert (v != NULL);
Martin v. Löwisb1ed7fa2006-04-13 07:52:27 +0000226 if (n == PY_SSIZE_T_MAX) {
Raymond Hettinger40a03822004-04-12 13:05:09 +0000227 PyErr_SetString(PyExc_OverflowError,
228 "cannot add more objects to list");
229 return -1;
230 }
231
232 if (list_resize(self, n+1) == -1)
233 return -1;
234
235 Py_INCREF(v);
236 PyList_SET_ITEM(self, n, v);
237 return 0;
238}
239
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000240int
Fred Drakea2f55112000-07-09 15:16:51 +0000241PyList_Append(PyObject *op, PyObject *newitem)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000242{
Raymond Hettingerfdfe6182004-05-05 06:28:16 +0000243 if (PyList_Check(op) && (newitem != NULL))
244 return app1((PyListObject *)op, newitem);
245 PyErr_BadInternalCall();
246 return -1;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000247}
248
249/* Methods */
250
251static void
Fred Drakea2f55112000-07-09 15:16:51 +0000252list_dealloc(PyListObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000253{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000254 Py_ssize_t i;
Guido van Rossumff413af2002-03-28 20:34:59 +0000255 PyObject_GC_UnTrack(op);
Guido van Rossumd724b232000-03-13 16:01:29 +0000256 Py_TRASHCAN_SAFE_BEGIN(op)
Jack Jansen7874d1f1995-01-19 12:09:27 +0000257 if (op->ob_item != NULL) {
Guido van Rossumfa717011999-06-09 15:19:34 +0000258 /* Do it backwards, for Christian Tismer.
259 There's a simple test case where somehow this reduces
260 thrashing when a *very* large list is created and
261 immediately deleted. */
262 i = op->ob_size;
263 while (--i >= 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000264 Py_XDECREF(op->ob_item[i]);
Jack Jansen7874d1f1995-01-19 12:09:27 +0000265 }
Guido van Rossumb18618d2000-05-03 23:44:39 +0000266 PyMem_FREE(op->ob_item);
Jack Jansen7874d1f1995-01-19 12:09:27 +0000267 }
Raymond Hettinger0468e412004-05-05 05:37:53 +0000268 if (num_free_lists < MAXFREELISTS && PyList_CheckExact(op))
269 free_lists[num_free_lists++] = op;
Tim Petersb38e2b62004-07-29 02:29:26 +0000270 else
271 op->ob_type->tp_free((PyObject *)op);
Guido van Rossumd724b232000-03-13 16:01:29 +0000272 Py_TRASHCAN_SAFE_END(op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000273}
274
Guido van Rossum90933611991-06-07 16:10:43 +0000275static int
Fred Drakea2f55112000-07-09 15:16:51 +0000276list_print(PyListObject *op, FILE *fp, int flags)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000277{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000278 int rc;
279 Py_ssize_t i;
Guido van Rossumfb376de1998-04-10 22:47:27 +0000280
Martin v. Löwis18e16552006-02-15 17:27:45 +0000281 rc = Py_ReprEnter((PyObject*)op);
282 if (rc != 0) {
283 if (rc < 0)
284 return rc;
Guido van Rossumfb376de1998-04-10 22:47:27 +0000285 fprintf(fp, "[...]");
286 return 0;
287 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000288 fprintf(fp, "[");
Guido van Rossum90933611991-06-07 16:10:43 +0000289 for (i = 0; i < op->ob_size; i++) {
290 if (i > 0)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000291 fprintf(fp, ", ");
Guido van Rossumfb376de1998-04-10 22:47:27 +0000292 if (PyObject_Print(op->ob_item[i], fp, 0) != 0) {
293 Py_ReprLeave((PyObject *)op);
Guido van Rossum90933611991-06-07 16:10:43 +0000294 return -1;
Guido van Rossumfb376de1998-04-10 22:47:27 +0000295 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000296 }
297 fprintf(fp, "]");
Guido van Rossumfb376de1998-04-10 22:47:27 +0000298 Py_ReprLeave((PyObject *)op);
Guido van Rossum90933611991-06-07 16:10:43 +0000299 return 0;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000300}
301
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000302static PyObject *
Fred Drakea2f55112000-07-09 15:16:51 +0000303list_repr(PyListObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000304{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000305 Py_ssize_t i;
Tim Petersa7259592001-06-16 05:11:17 +0000306 PyObject *s, *temp;
307 PyObject *pieces = NULL, *result = NULL;
Guido van Rossumfb376de1998-04-10 22:47:27 +0000308
309 i = Py_ReprEnter((PyObject*)v);
310 if (i != 0) {
Tim Petersa7259592001-06-16 05:11:17 +0000311 return i > 0 ? PyString_FromString("[...]") : NULL;
Guido van Rossumfb376de1998-04-10 22:47:27 +0000312 }
Tim Petersa7259592001-06-16 05:11:17 +0000313
314 if (v->ob_size == 0) {
315 result = PyString_FromString("[]");
316 goto Done;
317 }
318
319 pieces = PyList_New(0);
320 if (pieces == NULL)
321 goto Done;
322
323 /* Do repr() on each element. Note that this may mutate the list,
324 so must refetch the list size on each iteration. */
325 for (i = 0; i < v->ob_size; ++i) {
326 int status;
327 s = PyObject_Repr(v->ob_item[i]);
328 if (s == NULL)
329 goto Done;
330 status = PyList_Append(pieces, s);
331 Py_DECREF(s); /* append created a new ref */
332 if (status < 0)
333 goto Done;
334 }
335
336 /* Add "[]" decorations to the first and last items. */
337 assert(PyList_GET_SIZE(pieces) > 0);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000338 s = PyString_FromString("[");
Tim Petersa7259592001-06-16 05:11:17 +0000339 if (s == NULL)
340 goto Done;
341 temp = PyList_GET_ITEM(pieces, 0);
342 PyString_ConcatAndDel(&s, temp);
343 PyList_SET_ITEM(pieces, 0, s);
344 if (s == NULL)
345 goto Done;
346
347 s = PyString_FromString("]");
348 if (s == NULL)
349 goto Done;
350 temp = PyList_GET_ITEM(pieces, PyList_GET_SIZE(pieces) - 1);
351 PyString_ConcatAndDel(&temp, s);
352 PyList_SET_ITEM(pieces, PyList_GET_SIZE(pieces) - 1, temp);
353 if (temp == NULL)
354 goto Done;
355
356 /* Paste them all together with ", " between. */
357 s = PyString_FromString(", ");
358 if (s == NULL)
359 goto Done;
360 result = _PyString_Join(s, pieces);
Tim Peters3b01a122002-07-19 02:35:45 +0000361 Py_DECREF(s);
Tim Petersa7259592001-06-16 05:11:17 +0000362
363Done:
364 Py_XDECREF(pieces);
Guido van Rossumfb376de1998-04-10 22:47:27 +0000365 Py_ReprLeave((PyObject *)v);
Tim Petersa7259592001-06-16 05:11:17 +0000366 return result;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000367}
368
Martin v. Löwis18e16552006-02-15 17:27:45 +0000369static Py_ssize_t
Fred Drakea2f55112000-07-09 15:16:51 +0000370list_length(PyListObject *a)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000371{
372 return a->ob_size;
373}
374
Jeremy Hylton37b1a262000-04-27 21:41:03 +0000375static int
Fred Drakea2f55112000-07-09 15:16:51 +0000376list_contains(PyListObject *a, PyObject *el)
Jeremy Hylton37b1a262000-04-27 21:41:03 +0000377{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000378 Py_ssize_t i;
379 int cmp;
Jeremy Hylton37b1a262000-04-27 21:41:03 +0000380
Raymond Hettingeraae59992002-09-05 14:23:49 +0000381 for (i = 0, cmp = 0 ; cmp == 0 && i < a->ob_size; ++i)
382 cmp = PyObject_RichCompareBool(el, PyList_GET_ITEM(a, i),
Guido van Rossum65e1cea2001-01-17 22:11:59 +0000383 Py_EQ);
Neal Norwitzbb9c5f52002-09-05 21:32:55 +0000384 return cmp;
Jeremy Hylton37b1a262000-04-27 21:41:03 +0000385}
386
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000387static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000388list_item(PyListObject *a, Py_ssize_t i)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000389{
390 if (i < 0 || i >= a->ob_size) {
Guido van Rossum929f1b81996-08-09 20:51:27 +0000391 if (indexerr == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000392 indexerr = PyString_FromString(
393 "list index out of range");
394 PyErr_SetObject(PyExc_IndexError, indexerr);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000395 return NULL;
396 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000397 Py_INCREF(a->ob_item[i]);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000398 return a->ob_item[i];
399}
400
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000401static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000402list_slice(PyListObject *a, Py_ssize_t ilow, Py_ssize_t ihigh)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000403{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000404 PyListObject *np;
Raymond Hettingerb7d05db2004-03-08 07:25:05 +0000405 PyObject **src, **dest;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000406 Py_ssize_t i, len;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000407 if (ilow < 0)
408 ilow = 0;
409 else if (ilow > a->ob_size)
410 ilow = a->ob_size;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000411 if (ihigh < ilow)
412 ihigh = ilow;
413 else if (ihigh > a->ob_size)
414 ihigh = a->ob_size;
Raymond Hettinger99842b62004-03-08 05:56:15 +0000415 len = ihigh - ilow;
416 np = (PyListObject *) PyList_New(len);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000417 if (np == NULL)
418 return NULL;
Raymond Hettinger99842b62004-03-08 05:56:15 +0000419
Raymond Hettingerb7d05db2004-03-08 07:25:05 +0000420 src = a->ob_item + ilow;
421 dest = np->ob_item;
Raymond Hettinger99842b62004-03-08 05:56:15 +0000422 for (i = 0; i < len; i++) {
Raymond Hettingerb7d05db2004-03-08 07:25:05 +0000423 PyObject *v = src[i];
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000424 Py_INCREF(v);
Raymond Hettingerb7d05db2004-03-08 07:25:05 +0000425 dest[i] = v;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000426 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000427 return (PyObject *)np;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000428}
429
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000430PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000431PyList_GetSlice(PyObject *a, Py_ssize_t ilow, Py_ssize_t ihigh)
Guido van Rossum234f9421993-06-17 12:35:49 +0000432{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000433 if (!PyList_Check(a)) {
434 PyErr_BadInternalCall();
Guido van Rossum234f9421993-06-17 12:35:49 +0000435 return NULL;
436 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000437 return list_slice((PyListObject *)a, ilow, ihigh);
Guido van Rossum234f9421993-06-17 12:35:49 +0000438}
439
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000440static PyObject *
Fred Drakea2f55112000-07-09 15:16:51 +0000441list_concat(PyListObject *a, PyObject *bb)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000442{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000443 Py_ssize_t size;
444 Py_ssize_t i;
Raymond Hettingera6366fe2004-03-09 13:05:22 +0000445 PyObject **src, **dest;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000446 PyListObject *np;
447 if (!PyList_Check(bb)) {
Fred Drakeb6a9ada2000-06-01 03:12:13 +0000448 PyErr_Format(PyExc_TypeError,
Fred Drake914a2ed2000-06-01 14:31:03 +0000449 "can only concatenate list (not \"%.200s\") to list",
450 bb->ob_type->tp_name);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000451 return NULL;
452 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000453#define b ((PyListObject *)bb)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000454 size = a->ob_size + b->ob_size;
Guido van Rossuma5c0e6d2002-10-11 21:05:56 +0000455 if (size < 0)
456 return PyErr_NoMemory();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000457 np = (PyListObject *) PyList_New(size);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000458 if (np == NULL) {
Guido van Rossum90933611991-06-07 16:10:43 +0000459 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000460 }
Raymond Hettingera6366fe2004-03-09 13:05:22 +0000461 src = a->ob_item;
462 dest = np->ob_item;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000463 for (i = 0; i < a->ob_size; i++) {
Raymond Hettingera6366fe2004-03-09 13:05:22 +0000464 PyObject *v = src[i];
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000465 Py_INCREF(v);
Raymond Hettingera6366fe2004-03-09 13:05:22 +0000466 dest[i] = v;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000467 }
Raymond Hettingera6366fe2004-03-09 13:05:22 +0000468 src = b->ob_item;
469 dest = np->ob_item + a->ob_size;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000470 for (i = 0; i < b->ob_size; i++) {
Raymond Hettingera6366fe2004-03-09 13:05:22 +0000471 PyObject *v = src[i];
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000472 Py_INCREF(v);
Raymond Hettingera6366fe2004-03-09 13:05:22 +0000473 dest[i] = v;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000474 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000475 return (PyObject *)np;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000476#undef b
477}
478
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000479static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000480list_repeat(PyListObject *a, Py_ssize_t n)
Guido van Rossumed98d481991-03-06 13:07:53 +0000481{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000482 Py_ssize_t i, j;
483 Py_ssize_t size;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000484 PyListObject *np;
Raymond Hettingera6366fe2004-03-09 13:05:22 +0000485 PyObject **p, **items;
Raymond Hettinger6624e682003-05-21 05:58:46 +0000486 PyObject *elem;
Guido van Rossumed98d481991-03-06 13:07:53 +0000487 if (n < 0)
488 n = 0;
489 size = a->ob_size * n;
Raymond Hettinger6624e682003-05-21 05:58:46 +0000490 if (size == 0)
491 return PyList_New(0);
Guido van Rossumbfa5a142002-10-11 23:39:35 +0000492 if (n && size/n != a->ob_size)
Guido van Rossuma5c0e6d2002-10-11 21:05:56 +0000493 return PyErr_NoMemory();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000494 np = (PyListObject *) PyList_New(size);
Guido van Rossumed98d481991-03-06 13:07:53 +0000495 if (np == NULL)
496 return NULL;
Raymond Hettinger6624e682003-05-21 05:58:46 +0000497
Raymond Hettingera6366fe2004-03-09 13:05:22 +0000498 items = np->ob_item;
Raymond Hettinger6624e682003-05-21 05:58:46 +0000499 if (a->ob_size == 1) {
500 elem = a->ob_item[0];
501 for (i = 0; i < n; i++) {
Raymond Hettingera6366fe2004-03-09 13:05:22 +0000502 items[i] = elem;
Raymond Hettinger6624e682003-05-21 05:58:46 +0000503 Py_INCREF(elem);
504 }
505 return (PyObject *) np;
506 }
Guido van Rossumed98d481991-03-06 13:07:53 +0000507 p = np->ob_item;
Raymond Hettingera6366fe2004-03-09 13:05:22 +0000508 items = a->ob_item;
Guido van Rossumed98d481991-03-06 13:07:53 +0000509 for (i = 0; i < n; i++) {
510 for (j = 0; j < a->ob_size; j++) {
Raymond Hettingera6366fe2004-03-09 13:05:22 +0000511 *p = items[j];
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000512 Py_INCREF(*p);
Guido van Rossumed98d481991-03-06 13:07:53 +0000513 p++;
514 }
515 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000516 return (PyObject *) np;
Guido van Rossumed98d481991-03-06 13:07:53 +0000517}
518
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000519static int
Armin Rigo93677f02004-07-29 12:40:23 +0000520list_clear(PyListObject *a)
521{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000522 Py_ssize_t i;
Armin Rigo93677f02004-07-29 12:40:23 +0000523 PyObject **item = a->ob_item;
524 if (item != NULL) {
525 /* Because XDECREF can recursively invoke operations on
526 this list, we make it empty first. */
527 i = a->ob_size;
528 a->ob_size = 0;
529 a->ob_item = NULL;
530 a->allocated = 0;
531 while (--i >= 0) {
532 Py_XDECREF(item[i]);
533 }
534 PyMem_FREE(item);
535 }
536 /* Never fails; the return value can be ignored.
537 Note that there is no guarantee that the list is actually empty
538 at this point, because XDECREF may have populated it again! */
539 return 0;
540}
541
Tim Peters8fc4a912004-07-31 21:53:19 +0000542/* a[ilow:ihigh] = v if v != NULL.
543 * del a[ilow:ihigh] if v == NULL.
544 *
545 * Special speed gimmick: when v is NULL and ihigh - ilow <= 8, it's
546 * guaranteed the call cannot fail.
547 */
Armin Rigo93677f02004-07-29 12:40:23 +0000548static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000549list_ass_slice(PyListObject *a, Py_ssize_t ilow, Py_ssize_t ihigh, PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000550{
Guido van Rossumae7bf1a1995-01-17 10:21:11 +0000551 /* Because [X]DECREF can recursively invoke list operations on
552 this list, we must postpone all [X]DECREF activity until
553 after the list is back in its canonical shape. Therefore
554 we must allocate an additional array, 'recycle', into which
555 we temporarily copy the items that are deleted from the
556 list. :-( */
Tim Peters73572222004-07-31 02:54:42 +0000557 PyObject *recycle_on_stack[8];
558 PyObject **recycle = recycle_on_stack; /* will allocate more if needed */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000559 PyObject **item;
Raymond Hettingerf889e102004-03-09 08:04:33 +0000560 PyObject **vitem = NULL;
Michael W. Hudson5da854f2002-11-05 17:38:05 +0000561 PyObject *v_as_SF = NULL; /* PySequence_Fast(v) */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000562 Py_ssize_t n; /* # of elements in replacement list */
563 Py_ssize_t norig; /* # of elements in list getting replaced */
564 Py_ssize_t d; /* Change in size */
565 Py_ssize_t k;
Tim Peters8d9eb102004-07-31 02:24:20 +0000566 size_t s;
567 int result = -1; /* guilty until proved innocent */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000568#define b ((PyListObject *)v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000569 if (v == NULL)
570 n = 0;
Michael W. Hudson5da854f2002-11-05 17:38:05 +0000571 else {
Guido van Rossum32dffaa1991-12-24 13:27:34 +0000572 if (a == b) {
573 /* Special case "a[i:j] = a" -- copy b first */
Michael W. Hudsonda0a0672003-08-15 12:06:41 +0000574 v = list_slice(b, 0, b->ob_size);
Martin v. Löwiscd12bfc2003-05-03 10:53:08 +0000575 if (v == NULL)
Tim Peters8d9eb102004-07-31 02:24:20 +0000576 return result;
577 result = list_ass_slice(a, ilow, ihigh, v);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000578 Py_DECREF(v);
Tim Peters8d9eb102004-07-31 02:24:20 +0000579 return result;
Guido van Rossum32dffaa1991-12-24 13:27:34 +0000580 }
Raymond Hettingerf889e102004-03-09 08:04:33 +0000581 v_as_SF = PySequence_Fast(v, "can only assign an iterable");
Michael W. Hudsonb4f49382003-08-14 17:04:28 +0000582 if(v_as_SF == NULL)
Tim Peters8d9eb102004-07-31 02:24:20 +0000583 goto Error;
Michael W. Hudsonb4f49382003-08-14 17:04:28 +0000584 n = PySequence_Fast_GET_SIZE(v_as_SF);
Raymond Hettinger42bec932004-03-12 16:38:17 +0000585 vitem = PySequence_Fast_ITEMS(v_as_SF);
Guido van Rossum32dffaa1991-12-24 13:27:34 +0000586 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000587 if (ilow < 0)
588 ilow = 0;
589 else if (ilow > a->ob_size)
590 ilow = a->ob_size;
Tim Peters8d9eb102004-07-31 02:24:20 +0000591
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000592 if (ihigh < ilow)
593 ihigh = ilow;
594 else if (ihigh > a->ob_size)
595 ihigh = a->ob_size;
Armin Rigo93677f02004-07-29 12:40:23 +0000596
Tim Peters8d9eb102004-07-31 02:24:20 +0000597 norig = ihigh - ilow;
598 assert(norig >= 0);
599 d = n - norig;
Armin Rigo93677f02004-07-29 12:40:23 +0000600 if (a->ob_size + d == 0) {
601 Py_XDECREF(v_as_SF);
602 return list_clear(a);
603 }
604 item = a->ob_item;
Tim Peters8d9eb102004-07-31 02:24:20 +0000605 /* recycle the items that we are about to remove */
606 s = norig * sizeof(PyObject *);
Tim Peters73572222004-07-31 02:54:42 +0000607 if (s > sizeof(recycle_on_stack)) {
Armin Rigo1dd04a02004-07-30 11:38:22 +0000608 recycle = (PyObject **)PyMem_MALLOC(s);
Martin v. Löwiscd12bfc2003-05-03 10:53:08 +0000609 if (recycle == NULL) {
610 PyErr_NoMemory();
Tim Peters8d9eb102004-07-31 02:24:20 +0000611 goto Error;
Martin v. Löwiscd12bfc2003-05-03 10:53:08 +0000612 }
613 }
Armin Rigo1dd04a02004-07-30 11:38:22 +0000614 memcpy(recycle, &item[ilow], s);
Tim Peters8d9eb102004-07-31 02:24:20 +0000615
Armin Rigo1dd04a02004-07-30 11:38:22 +0000616 if (d < 0) { /* Delete -d items */
617 memmove(&item[ihigh+d], &item[ihigh],
618 (a->ob_size - ihigh)*sizeof(PyObject *));
619 list_resize(a, a->ob_size + d);
620 item = a->ob_item;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000621 }
Armin Rigo1dd04a02004-07-30 11:38:22 +0000622 else if (d > 0) { /* Insert d items */
Tim Peters73572222004-07-31 02:54:42 +0000623 k = a->ob_size;
624 if (list_resize(a, k+d) < 0)
Tim Peters8d9eb102004-07-31 02:24:20 +0000625 goto Error;
Raymond Hettinger4bb95402004-02-13 11:36:39 +0000626 item = a->ob_item;
Raymond Hettingerf889e102004-03-09 08:04:33 +0000627 memmove(&item[ihigh+d], &item[ihigh],
Tim Peters73572222004-07-31 02:54:42 +0000628 (k - ihigh)*sizeof(PyObject *));
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000629 }
630 for (k = 0; k < n; k++, ilow++) {
Raymond Hettingerf889e102004-03-09 08:04:33 +0000631 PyObject *w = vitem[k];
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000632 Py_XINCREF(w);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000633 item[ilow] = w;
634 }
Tim Peters73572222004-07-31 02:54:42 +0000635 for (k = norig - 1; k >= 0; --k)
636 Py_XDECREF(recycle[k]);
Tim Peters8d9eb102004-07-31 02:24:20 +0000637 result = 0;
638 Error:
Tim Peters73572222004-07-31 02:54:42 +0000639 if (recycle != recycle_on_stack)
Armin Rigo1dd04a02004-07-30 11:38:22 +0000640 PyMem_FREE(recycle);
Michael W. Hudson5da854f2002-11-05 17:38:05 +0000641 Py_XDECREF(v_as_SF);
Tim Peters8d9eb102004-07-31 02:24:20 +0000642 return result;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000643#undef b
644}
645
Guido van Rossum234f9421993-06-17 12:35:49 +0000646int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000647PyList_SetSlice(PyObject *a, Py_ssize_t ilow, Py_ssize_t ihigh, PyObject *v)
Guido van Rossum234f9421993-06-17 12:35:49 +0000648{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000649 if (!PyList_Check(a)) {
650 PyErr_BadInternalCall();
Guido van Rossum1fc238a1993-07-29 08:25:09 +0000651 return -1;
Guido van Rossum234f9421993-06-17 12:35:49 +0000652 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000653 return list_ass_slice((PyListObject *)a, ilow, ihigh, v);
Guido van Rossum234f9421993-06-17 12:35:49 +0000654}
655
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000656static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000657list_inplace_repeat(PyListObject *self, Py_ssize_t n)
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000658{
659 PyObject **items;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000660 Py_ssize_t size, i, j, p;
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000661
662
663 size = PyList_GET_SIZE(self);
664 if (size == 0) {
665 Py_INCREF(self);
666 return (PyObject *)self;
667 }
668
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000669 if (n < 1) {
Armin Rigo93677f02004-07-29 12:40:23 +0000670 (void)list_clear(self);
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000671 Py_INCREF(self);
672 return (PyObject *)self;
673 }
674
Tim Petersb38e2b62004-07-29 02:29:26 +0000675 if (list_resize(self, size*n) == -1)
Raymond Hettinger4bb95402004-02-13 11:36:39 +0000676 return NULL;
677
678 p = size;
Raymond Hettingera6366fe2004-03-09 13:05:22 +0000679 items = self->ob_item;
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000680 for (i = 1; i < n; i++) { /* Start counting at 1, not 0 */
681 for (j = 0; j < size; j++) {
Raymond Hettingera6366fe2004-03-09 13:05:22 +0000682 PyObject *o = items[j];
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000683 Py_INCREF(o);
Raymond Hettingera6366fe2004-03-09 13:05:22 +0000684 items[p++] = o;
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000685 }
686 }
687 Py_INCREF(self);
688 return (PyObject *)self;
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000689}
690
Guido van Rossum4a450d01991-04-03 19:05:18 +0000691static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000692list_ass_item(PyListObject *a, Py_ssize_t i, PyObject *v)
Guido van Rossum4a450d01991-04-03 19:05:18 +0000693{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000694 PyObject *old_value;
Guido van Rossum4a450d01991-04-03 19:05:18 +0000695 if (i < 0 || i >= a->ob_size) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000696 PyErr_SetString(PyExc_IndexError,
697 "list assignment index out of range");
Guido van Rossum4a450d01991-04-03 19:05:18 +0000698 return -1;
699 }
700 if (v == NULL)
701 return list_ass_slice(a, i, i+1, v);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000702 Py_INCREF(v);
Guido van Rossumd7047b31995-01-02 19:07:15 +0000703 old_value = a->ob_item[i];
Guido van Rossum4a450d01991-04-03 19:05:18 +0000704 a->ob_item[i] = v;
Tim Peters3b01a122002-07-19 02:35:45 +0000705 Py_DECREF(old_value);
Guido van Rossum4a450d01991-04-03 19:05:18 +0000706 return 0;
707}
708
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000709static PyObject *
Fred Drakea2f55112000-07-09 15:16:51 +0000710listinsert(PyListObject *self, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000711{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000712 Py_ssize_t i;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000713 PyObject *v;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000714 if (!PyArg_ParseTuple(args, "nO:insert", &i, &v))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000715 return NULL;
Raymond Hettinger45d0b5c2004-04-12 17:21:03 +0000716 if (ins1(self, i, v) == 0)
717 Py_RETURN_NONE;
Raymond Hettinger501f02c2004-04-12 14:01:16 +0000718 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000719}
720
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000721static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000722listappend(PyListObject *self, PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000723{
Raymond Hettinger45d0b5c2004-04-12 17:21:03 +0000724 if (app1(self, v) == 0)
725 Py_RETURN_NONE;
Raymond Hettinger501f02c2004-04-12 14:01:16 +0000726 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000727}
728
Barry Warsawdedf6d61998-10-09 16:37:25 +0000729static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000730listextend(PyListObject *self, PyObject *b)
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000731{
Raymond Hettinger90a39bf2004-02-15 03:57:00 +0000732 PyObject *it; /* iter(v) */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000733 Py_ssize_t m; /* size of self */
734 Py_ssize_t n; /* guess for size of b */
735 Py_ssize_t mn; /* m + n */
736 Py_ssize_t i;
Raymond Hettinger57c45422004-03-11 09:48:18 +0000737 PyObject *(*iternext)(PyObject *);
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000738
Raymond Hettinger90a39bf2004-02-15 03:57:00 +0000739 /* Special cases:
Tim Petersb38e2b62004-07-29 02:29:26 +0000740 1) lists and tuples which can use PySequence_Fast ops
741 2) extending self to self requires making a copy first
Raymond Hettinger90a39bf2004-02-15 03:57:00 +0000742 */
743 if (PyList_CheckExact(b) || PyTuple_CheckExact(b) || (PyObject *)self == b) {
Armin Rigo70d172d2004-03-20 22:19:23 +0000744 PyObject **src, **dest;
Raymond Hettinger90a39bf2004-02-15 03:57:00 +0000745 b = PySequence_Fast(b, "argument must be iterable");
746 if (!b)
747 return NULL;
Armin Rigo70d172d2004-03-20 22:19:23 +0000748 n = PySequence_Fast_GET_SIZE(b);
749 if (n == 0) {
750 /* short circuit when b is empty */
751 Py_DECREF(b);
752 Py_RETURN_NONE;
753 }
754 m = self->ob_size;
755 if (list_resize(self, m + n) == -1) {
756 Py_DECREF(b);
Raymond Hettinger90a39bf2004-02-15 03:57:00 +0000757 return NULL;
Armin Rigo70d172d2004-03-20 22:19:23 +0000758 }
759 /* note that we may still have self == b here for the
760 * situation a.extend(a), but the following code works
761 * in that case too. Just make sure to resize self
762 * before calling PySequence_Fast_ITEMS.
763 */
764 /* populate the end of self with b's items */
765 src = PySequence_Fast_ITEMS(b);
766 dest = self->ob_item + m;
767 for (i = 0; i < n; i++) {
768 PyObject *o = src[i];
769 Py_INCREF(o);
770 dest[i] = o;
771 }
772 Py_DECREF(b);
Raymond Hettinger90a39bf2004-02-15 03:57:00 +0000773 Py_RETURN_NONE;
774 }
775
776 it = PyObject_GetIter(b);
777 if (it == NULL)
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000778 return NULL;
Raymond Hettinger57c45422004-03-11 09:48:18 +0000779 iternext = *it->ob_type->tp_iternext;
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000780
Raymond Hettinger90a39bf2004-02-15 03:57:00 +0000781 /* Guess a result list size. */
Armin Rigof5b3e362006-02-11 21:32:43 +0000782 n = _PyObject_LengthHint(b);
Raymond Hettinger90a39bf2004-02-15 03:57:00 +0000783 if (n < 0) {
Raymond Hettingera710b332005-08-21 11:03:59 +0000784 if (!PyErr_ExceptionMatches(PyExc_TypeError) &&
785 !PyErr_ExceptionMatches(PyExc_AttributeError)) {
786 Py_DECREF(it);
787 return NULL;
788 }
Raymond Hettinger90a39bf2004-02-15 03:57:00 +0000789 PyErr_Clear();
790 n = 8; /* arbitrary */
791 }
792 m = self->ob_size;
793 mn = m + n;
Raymond Hettingeraa241e02004-09-26 19:24:20 +0000794 if (mn >= m) {
795 /* Make room. */
796 if (list_resize(self, mn) == -1)
797 goto error;
798 /* Make the list sane again. */
799 self->ob_size = m;
800 }
801 /* Else m + n overflowed; on the chance that n lied, and there really
802 * is enough room, ignore it. If n was telling the truth, we'll
803 * eventually run out of memory during the loop.
804 */
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000805
Raymond Hettinger90a39bf2004-02-15 03:57:00 +0000806 /* Run iterator to exhaustion. */
Raymond Hettingeraa241e02004-09-26 19:24:20 +0000807 for (;;) {
Raymond Hettinger57c45422004-03-11 09:48:18 +0000808 PyObject *item = iternext(it);
Raymond Hettinger90a39bf2004-02-15 03:57:00 +0000809 if (item == NULL) {
Raymond Hettinger57c45422004-03-11 09:48:18 +0000810 if (PyErr_Occurred()) {
811 if (PyErr_ExceptionMatches(PyExc_StopIteration))
812 PyErr_Clear();
813 else
814 goto error;
815 }
Raymond Hettinger90a39bf2004-02-15 03:57:00 +0000816 break;
817 }
Raymond Hettingeraa241e02004-09-26 19:24:20 +0000818 if (self->ob_size < self->allocated) {
819 /* steals ref */
820 PyList_SET_ITEM(self, self->ob_size, item);
821 ++self->ob_size;
822 }
Raymond Hettinger90a39bf2004-02-15 03:57:00 +0000823 else {
Raymond Hettinger40a03822004-04-12 13:05:09 +0000824 int status = app1(self, item);
Raymond Hettinger90a39bf2004-02-15 03:57:00 +0000825 Py_DECREF(item); /* append creates a new ref */
826 if (status < 0)
827 goto error;
828 }
829 }
830
831 /* Cut back result list if initial guess was too large. */
Raymond Hettingeraa241e02004-09-26 19:24:20 +0000832 if (self->ob_size < self->allocated)
833 list_resize(self, self->ob_size); /* shrinking can't fail */
834
Raymond Hettinger90a39bf2004-02-15 03:57:00 +0000835 Py_DECREF(it);
836 Py_RETURN_NONE;
837
838 error:
839 Py_DECREF(it);
840 return NULL;
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000841}
842
Raymond Hettinger8ca92ae2004-03-11 09:13:12 +0000843PyObject *
844_PyList_Extend(PyListObject *self, PyObject *b)
845{
846 return listextend(self, b);
847}
848
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000849static PyObject *
Raymond Hettinger97bc6182004-03-11 07:34:19 +0000850list_inplace_concat(PyListObject *self, PyObject *other)
851{
852 PyObject *result;
853
854 result = listextend(self, other);
855 if (result == NULL)
856 return result;
857 Py_DECREF(result);
858 Py_INCREF(self);
859 return (PyObject *)self;
860}
861
862static PyObject *
Fred Drakea2f55112000-07-09 15:16:51 +0000863listpop(PyListObject *self, PyObject *args)
Guido van Rossum3dd7f3f1998-06-30 15:36:32 +0000864{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000865 Py_ssize_t i = -1;
Armin Rigo7ccbca92006-10-04 12:17:45 +0000866 PyObject *v;
Tim Peters8fc4a912004-07-31 21:53:19 +0000867 int status;
Raymond Hettinger9eb86b32004-02-17 11:36:16 +0000868
Armin Rigo7ccbca92006-10-04 12:17:45 +0000869 if (!PyArg_ParseTuple(args, "|n:pop", &i))
Guido van Rossum3dd7f3f1998-06-30 15:36:32 +0000870 return NULL;
Armin Rigo7ccbca92006-10-04 12:17:45 +0000871
Guido van Rossum3dd7f3f1998-06-30 15:36:32 +0000872 if (self->ob_size == 0) {
873 /* Special-case most common failure cause */
874 PyErr_SetString(PyExc_IndexError, "pop from empty list");
875 return NULL;
876 }
877 if (i < 0)
878 i += self->ob_size;
879 if (i < 0 || i >= self->ob_size) {
880 PyErr_SetString(PyExc_IndexError, "pop index out of range");
881 return NULL;
882 }
883 v = self->ob_item[i];
Raymond Hettingercb3e5802004-02-13 18:36:31 +0000884 if (i == self->ob_size - 1) {
Tim Peters8fc4a912004-07-31 21:53:19 +0000885 status = list_resize(self, self->ob_size - 1);
886 assert(status >= 0);
887 return v; /* and v now owns the reference the list had */
Raymond Hettingercb3e5802004-02-13 18:36:31 +0000888 }
Guido van Rossum3dd7f3f1998-06-30 15:36:32 +0000889 Py_INCREF(v);
Tim Peters8fc4a912004-07-31 21:53:19 +0000890 status = list_ass_slice(self, i, i+1, (PyObject *)NULL);
891 assert(status >= 0);
892 /* Use status, so that in a release build compilers don't
893 * complain about the unused name.
894 */
Brett Cannon651dd522004-08-08 21:21:18 +0000895 (void) status;
896
897 return v;
Guido van Rossum3dd7f3f1998-06-30 15:36:32 +0000898}
899
Tim Peters8e2e7ca2002-07-19 02:33:08 +0000900/* Reverse a slice of a list in place, from lo up to (exclusive) hi. */
901static void
902reverse_slice(PyObject **lo, PyObject **hi)
903{
904 assert(lo && hi);
905
906 --hi;
907 while (lo < hi) {
908 PyObject *t = *lo;
909 *lo = *hi;
910 *hi = t;
911 ++lo;
912 --hi;
913 }
914}
915
Tim Petersa64dc242002-08-01 02:13:36 +0000916/* Lots of code for an adaptive, stable, natural mergesort. There are many
917 * pieces to this algorithm; read listsort.txt for overviews and details.
918 */
Guido van Rossum3f236de1996-12-10 23:55:39 +0000919
Guido van Rossum3f236de1996-12-10 23:55:39 +0000920/* Comparison function. Takes care of calling a user-supplied
Tim Peters66860f62002-08-04 17:47:26 +0000921 * comparison function (any callable Python object), which must not be
922 * NULL (use the ISLT macro if you don't know, or call PyObject_RichCompareBool
923 * with Py_LT if you know it's NULL).
Tim Petersa64dc242002-08-01 02:13:36 +0000924 * Returns -1 on error, 1 if x < y, 0 if x >= y.
925 */
Guido van Rossum3f236de1996-12-10 23:55:39 +0000926static int
Tim Petersa8c974c2002-07-19 03:30:57 +0000927islt(PyObject *x, PyObject *y, PyObject *compare)
Guido van Rossum3f236de1996-12-10 23:55:39 +0000928{
Tim Petersf2a04732002-07-11 21:46:16 +0000929 PyObject *res;
930 PyObject *args;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000931 Py_ssize_t i;
Guido van Rossum3f236de1996-12-10 23:55:39 +0000932
Tim Peters66860f62002-08-04 17:47:26 +0000933 assert(compare != NULL);
Tim Petersa8c974c2002-07-19 03:30:57 +0000934 /* Call the user's comparison function and translate the 3-way
935 * result into true or false (or error).
936 */
Tim Petersf2a04732002-07-11 21:46:16 +0000937 args = PyTuple_New(2);
Guido van Rossum3f236de1996-12-10 23:55:39 +0000938 if (args == NULL)
Tim Petersa8c974c2002-07-19 03:30:57 +0000939 return -1;
Tim Petersf2a04732002-07-11 21:46:16 +0000940 Py_INCREF(x);
941 Py_INCREF(y);
942 PyTuple_SET_ITEM(args, 0, x);
943 PyTuple_SET_ITEM(args, 1, y);
Tim Peters58cf3612002-07-15 05:16:13 +0000944 res = PyObject_Call(compare, args, NULL);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000945 Py_DECREF(args);
Guido van Rossum3f236de1996-12-10 23:55:39 +0000946 if (res == NULL)
Tim Petersa8c974c2002-07-19 03:30:57 +0000947 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000948 if (!PyInt_Check(res)) {
949 Py_DECREF(res);
950 PyErr_SetString(PyExc_TypeError,
Guido van Rossum9bcd1d71999-04-19 17:44:39 +0000951 "comparison function must return int");
Tim Petersa8c974c2002-07-19 03:30:57 +0000952 return -1;
Guido van Rossum3f236de1996-12-10 23:55:39 +0000953 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000954 i = PyInt_AsLong(res);
955 Py_DECREF(res);
Tim Petersa8c974c2002-07-19 03:30:57 +0000956 return i < 0;
Guido van Rossum3f236de1996-12-10 23:55:39 +0000957}
958
Tim Peters66860f62002-08-04 17:47:26 +0000959/* If COMPARE is NULL, calls PyObject_RichCompareBool with Py_LT, else calls
960 * islt. This avoids a layer of function call in the usual case, and
961 * sorting does many comparisons.
962 * Returns -1 on error, 1 if x < y, 0 if x >= y.
963 */
964#define ISLT(X, Y, COMPARE) ((COMPARE) == NULL ? \
965 PyObject_RichCompareBool(X, Y, Py_LT) : \
966 islt(X, Y, COMPARE))
967
968/* Compare X to Y via "<". Goto "fail" if the comparison raises an
Tim Petersa8c974c2002-07-19 03:30:57 +0000969 error. Else "k" is set to true iff X<Y, and an "if (k)" block is
970 started. It makes more sense in context <wink>. X and Y are PyObject*s.
971*/
Tim Peters66860f62002-08-04 17:47:26 +0000972#define IFLT(X, Y) if ((k = ISLT(X, Y, compare)) < 0) goto fail; \
Tim Petersa8c974c2002-07-19 03:30:57 +0000973 if (k)
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000974
975/* binarysort is the best method for sorting small arrays: it does
976 few compares, but can do data movement quadratic in the number of
977 elements.
Guido van Rossum42812581998-06-17 14:15:44 +0000978 [lo, hi) is a contiguous slice of a list, and is sorted via
Tim Petersa8c974c2002-07-19 03:30:57 +0000979 binary insertion. This sort is stable.
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000980 On entry, must have lo <= start <= hi, and that [lo, start) is already
981 sorted (pass start == lo if you don't know!).
Tim Petersa8c974c2002-07-19 03:30:57 +0000982 If islt() complains return -1, else 0.
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000983 Even in case of error, the output slice will be some permutation of
984 the input (nothing is lost or duplicated).
985*/
Guido van Rossum3f236de1996-12-10 23:55:39 +0000986static int
Fred Drakea2f55112000-07-09 15:16:51 +0000987binarysort(PyObject **lo, PyObject **hi, PyObject **start, PyObject *compare)
988 /* compare -- comparison function object, or NULL for default */
Guido van Rossum3f236de1996-12-10 23:55:39 +0000989{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000990 register Py_ssize_t k;
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000991 register PyObject **l, **p, **r;
992 register PyObject *pivot;
Guido van Rossum3f236de1996-12-10 23:55:39 +0000993
Tim Petersa8c974c2002-07-19 03:30:57 +0000994 assert(lo <= start && start <= hi);
995 /* assert [lo, start) is sorted */
Guido van Rossum4c4e7df1998-06-16 15:18:28 +0000996 if (lo == start)
997 ++start;
998 for (; start < hi; ++start) {
999 /* set l to where *start belongs */
1000 l = lo;
1001 r = start;
Guido van Rossuma119c0d1998-05-29 17:56:32 +00001002 pivot = *r;
Tim Peters0fe977c2002-07-19 06:12:32 +00001003 /* Invariants:
1004 * pivot >= all in [lo, l).
1005 * pivot < all in [r, start).
1006 * The second is vacuously true at the start.
1007 */
1008 assert(l < r);
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001009 do {
1010 p = l + ((r - l) >> 1);
Tim Petersa8c974c2002-07-19 03:30:57 +00001011 IFLT(pivot, *p)
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001012 r = p;
1013 else
Tim Peters0fe977c2002-07-19 06:12:32 +00001014 l = p+1;
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001015 } while (l < r);
Tim Peters0fe977c2002-07-19 06:12:32 +00001016 assert(l == r);
1017 /* The invariants still hold, so pivot >= all in [lo, l) and
1018 pivot < all in [l, start), so pivot belongs at l. Note
1019 that if there are elements equal to pivot, l points to the
1020 first slot after them -- that's why this sort is stable.
1021 Slide over to make room.
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001022 Caution: using memmove is much slower under MSVC 5;
1023 we're not usually moving many slots. */
1024 for (p = start; p > l; --p)
1025 *p = *(p-1);
1026 *l = pivot;
Guido van Rossum3f236de1996-12-10 23:55:39 +00001027 }
Guido van Rossum3f236de1996-12-10 23:55:39 +00001028 return 0;
Guido van Rossuma119c0d1998-05-29 17:56:32 +00001029
1030 fail:
1031 return -1;
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001032}
1033
Tim Petersa64dc242002-08-01 02:13:36 +00001034/*
1035Return the length of the run beginning at lo, in the slice [lo, hi). lo < hi
1036is required on entry. "A run" is the longest ascending sequence, with
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001037
Tim Petersa64dc242002-08-01 02:13:36 +00001038 lo[0] <= lo[1] <= lo[2] <= ...
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001039
Tim Petersa64dc242002-08-01 02:13:36 +00001040or the longest descending sequence, with
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001041
Tim Petersa64dc242002-08-01 02:13:36 +00001042 lo[0] > lo[1] > lo[2] > ...
Tim Peters3b01a122002-07-19 02:35:45 +00001043
Tim Petersa64dc242002-08-01 02:13:36 +00001044Boolean *descending is set to 0 in the former case, or to 1 in the latter.
1045For its intended use in a stable mergesort, the strictness of the defn of
1046"descending" is needed so that the caller can safely reverse a descending
1047sequence without violating stability (strict > ensures there are no equal
1048elements to get out of order).
1049
1050Returns -1 in case of error.
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001051*/
Martin v. Löwis18e16552006-02-15 17:27:45 +00001052static Py_ssize_t
Tim Petersa64dc242002-08-01 02:13:36 +00001053count_run(PyObject **lo, PyObject **hi, PyObject *compare, int *descending)
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001054{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001055 Py_ssize_t k;
1056 Py_ssize_t n;
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001057
Tim Petersa64dc242002-08-01 02:13:36 +00001058 assert(lo < hi);
1059 *descending = 0;
1060 ++lo;
1061 if (lo == hi)
1062 return 1;
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001063
Tim Petersa64dc242002-08-01 02:13:36 +00001064 n = 2;
1065 IFLT(*lo, *(lo-1)) {
1066 *descending = 1;
1067 for (lo = lo+1; lo < hi; ++lo, ++n) {
1068 IFLT(*lo, *(lo-1))
1069 ;
1070 else
1071 break;
1072 }
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001073 }
Tim Petersa64dc242002-08-01 02:13:36 +00001074 else {
1075 for (lo = lo+1; lo < hi; ++lo, ++n) {
1076 IFLT(*lo, *(lo-1))
1077 break;
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001078 }
1079 }
1080
Tim Petersa64dc242002-08-01 02:13:36 +00001081 return n;
1082fail:
1083 return -1;
1084}
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001085
Tim Petersa64dc242002-08-01 02:13:36 +00001086/*
1087Locate the proper position of key in a sorted vector; if the vector contains
1088an element equal to key, return the position immediately to the left of
1089the leftmost equal element. [gallop_right() does the same except returns
1090the position to the right of the rightmost equal element (if any).]
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001091
Tim Petersa64dc242002-08-01 02:13:36 +00001092"a" is a sorted vector with n elements, starting at a[0]. n must be > 0.
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001093
Tim Petersa64dc242002-08-01 02:13:36 +00001094"hint" is an index at which to begin the search, 0 <= hint < n. The closer
1095hint is to the final result, the faster this runs.
1096
1097The return value is the int k in 0..n such that
1098
1099 a[k-1] < key <= a[k]
1100
1101pretending that *(a-1) is minus infinity and a[n] is plus infinity. IOW,
1102key belongs at index k; or, IOW, the first k elements of a should precede
1103key, and the last n-k should follow key.
1104
1105Returns -1 on error. See listsort.txt for info on the method.
1106*/
Martin v. Löwis18e16552006-02-15 17:27:45 +00001107static Py_ssize_t
1108gallop_left(PyObject *key, PyObject **a, Py_ssize_t n, Py_ssize_t hint, PyObject *compare)
Tim Petersa64dc242002-08-01 02:13:36 +00001109{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001110 Py_ssize_t ofs;
1111 Py_ssize_t lastofs;
1112 Py_ssize_t k;
Tim Petersa64dc242002-08-01 02:13:36 +00001113
1114 assert(key && a && n > 0 && hint >= 0 && hint < n);
1115
1116 a += hint;
1117 lastofs = 0;
1118 ofs = 1;
1119 IFLT(*a, key) {
1120 /* a[hint] < key -- gallop right, until
1121 * a[hint + lastofs] < key <= a[hint + ofs]
1122 */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001123 const Py_ssize_t maxofs = n - hint; /* &a[n-1] is highest */
Tim Petersa64dc242002-08-01 02:13:36 +00001124 while (ofs < maxofs) {
1125 IFLT(a[ofs], key) {
1126 lastofs = ofs;
1127 ofs = (ofs << 1) + 1;
1128 if (ofs <= 0) /* int overflow */
1129 ofs = maxofs;
1130 }
1131 else /* key <= a[hint + ofs] */
1132 break;
1133 }
1134 if (ofs > maxofs)
1135 ofs = maxofs;
1136 /* Translate back to offsets relative to &a[0]. */
1137 lastofs += hint;
1138 ofs += hint;
1139 }
1140 else {
1141 /* key <= a[hint] -- gallop left, until
1142 * a[hint - ofs] < key <= a[hint - lastofs]
1143 */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001144 const Py_ssize_t maxofs = hint + 1; /* &a[0] is lowest */
Tim Petersa64dc242002-08-01 02:13:36 +00001145 while (ofs < maxofs) {
1146 IFLT(*(a-ofs), key)
1147 break;
1148 /* key <= a[hint - ofs] */
1149 lastofs = ofs;
1150 ofs = (ofs << 1) + 1;
1151 if (ofs <= 0) /* int overflow */
1152 ofs = maxofs;
1153 }
1154 if (ofs > maxofs)
1155 ofs = maxofs;
1156 /* Translate back to positive offsets relative to &a[0]. */
1157 k = lastofs;
1158 lastofs = hint - ofs;
1159 ofs = hint - k;
1160 }
1161 a -= hint;
1162
1163 assert(-1 <= lastofs && lastofs < ofs && ofs <= n);
1164 /* Now a[lastofs] < key <= a[ofs], so key belongs somewhere to the
1165 * right of lastofs but no farther right than ofs. Do a binary
1166 * search, with invariant a[lastofs-1] < key <= a[ofs].
1167 */
1168 ++lastofs;
1169 while (lastofs < ofs) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001170 Py_ssize_t m = lastofs + ((ofs - lastofs) >> 1);
Tim Petersa64dc242002-08-01 02:13:36 +00001171
1172 IFLT(a[m], key)
1173 lastofs = m+1; /* a[m] < key */
1174 else
1175 ofs = m; /* key <= a[m] */
1176 }
1177 assert(lastofs == ofs); /* so a[ofs-1] < key <= a[ofs] */
1178 return ofs;
1179
1180fail:
1181 return -1;
1182}
1183
1184/*
1185Exactly like gallop_left(), except that if key already exists in a[0:n],
1186finds the position immediately to the right of the rightmost equal value.
1187
1188The return value is the int k in 0..n such that
1189
1190 a[k-1] <= key < a[k]
1191
1192or -1 if error.
1193
1194The code duplication is massive, but this is enough different given that
1195we're sticking to "<" comparisons that it's much harder to follow if
1196written as one routine with yet another "left or right?" flag.
1197*/
Martin v. Löwis18e16552006-02-15 17:27:45 +00001198static Py_ssize_t
1199gallop_right(PyObject *key, PyObject **a, Py_ssize_t n, Py_ssize_t hint, PyObject *compare)
Tim Petersa64dc242002-08-01 02:13:36 +00001200{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001201 Py_ssize_t ofs;
1202 Py_ssize_t lastofs;
1203 Py_ssize_t k;
Tim Petersa64dc242002-08-01 02:13:36 +00001204
1205 assert(key && a && n > 0 && hint >= 0 && hint < n);
1206
1207 a += hint;
1208 lastofs = 0;
1209 ofs = 1;
1210 IFLT(key, *a) {
1211 /* key < a[hint] -- gallop left, until
1212 * a[hint - ofs] <= key < a[hint - lastofs]
1213 */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001214 const Py_ssize_t maxofs = hint + 1; /* &a[0] is lowest */
Tim Petersa64dc242002-08-01 02:13:36 +00001215 while (ofs < maxofs) {
1216 IFLT(key, *(a-ofs)) {
1217 lastofs = ofs;
1218 ofs = (ofs << 1) + 1;
1219 if (ofs <= 0) /* int overflow */
1220 ofs = maxofs;
1221 }
1222 else /* a[hint - ofs] <= key */
1223 break;
1224 }
1225 if (ofs > maxofs)
1226 ofs = maxofs;
1227 /* Translate back to positive offsets relative to &a[0]. */
1228 k = lastofs;
1229 lastofs = hint - ofs;
1230 ofs = hint - k;
1231 }
1232 else {
1233 /* a[hint] <= key -- gallop right, until
1234 * a[hint + lastofs] <= key < a[hint + ofs]
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001235 */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001236 const Py_ssize_t maxofs = n - hint; /* &a[n-1] is highest */
Tim Petersa64dc242002-08-01 02:13:36 +00001237 while (ofs < maxofs) {
1238 IFLT(key, a[ofs])
1239 break;
1240 /* a[hint + ofs] <= key */
1241 lastofs = ofs;
1242 ofs = (ofs << 1) + 1;
1243 if (ofs <= 0) /* int overflow */
1244 ofs = maxofs;
1245 }
1246 if (ofs > maxofs)
1247 ofs = maxofs;
1248 /* Translate back to offsets relative to &a[0]. */
1249 lastofs += hint;
1250 ofs += hint;
1251 }
1252 a -= hint;
1253
1254 assert(-1 <= lastofs && lastofs < ofs && ofs <= n);
1255 /* Now a[lastofs] <= key < a[ofs], so key belongs somewhere to the
1256 * right of lastofs but no farther right than ofs. Do a binary
1257 * search, with invariant a[lastofs-1] <= key < a[ofs].
1258 */
1259 ++lastofs;
1260 while (lastofs < ofs) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001261 Py_ssize_t m = lastofs + ((ofs - lastofs) >> 1);
Tim Petersa64dc242002-08-01 02:13:36 +00001262
1263 IFLT(key, a[m])
1264 ofs = m; /* key < a[m] */
1265 else
1266 lastofs = m+1; /* a[m] <= key */
1267 }
1268 assert(lastofs == ofs); /* so a[ofs-1] <= key < a[ofs] */
1269 return ofs;
1270
1271fail:
1272 return -1;
1273}
1274
1275/* The maximum number of entries in a MergeState's pending-runs stack.
1276 * This is enough to sort arrays of size up to about
1277 * 32 * phi ** MAX_MERGE_PENDING
1278 * where phi ~= 1.618. 85 is ridiculouslylarge enough, good for an array
1279 * with 2**64 elements.
1280 */
1281#define MAX_MERGE_PENDING 85
1282
Tim Peterse05f65a2002-08-10 05:21:15 +00001283/* When we get into galloping mode, we stay there until both runs win less
1284 * often than MIN_GALLOP consecutive times. See listsort.txt for more info.
Tim Petersa64dc242002-08-01 02:13:36 +00001285 */
Tim Peterse05f65a2002-08-10 05:21:15 +00001286#define MIN_GALLOP 7
Tim Petersa64dc242002-08-01 02:13:36 +00001287
1288/* Avoid malloc for small temp arrays. */
1289#define MERGESTATE_TEMP_SIZE 256
1290
1291/* One MergeState exists on the stack per invocation of mergesort. It's just
1292 * a convenient way to pass state around among the helper functions.
1293 */
Tim Peterse05f65a2002-08-10 05:21:15 +00001294struct s_slice {
1295 PyObject **base;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001296 Py_ssize_t len;
Tim Peterse05f65a2002-08-10 05:21:15 +00001297};
1298
Tim Petersa64dc242002-08-01 02:13:36 +00001299typedef struct s_MergeState {
1300 /* The user-supplied comparison function. or NULL if none given. */
1301 PyObject *compare;
1302
Tim Peterse05f65a2002-08-10 05:21:15 +00001303 /* This controls when we get *into* galloping mode. It's initialized
1304 * to MIN_GALLOP. merge_lo and merge_hi tend to nudge it higher for
1305 * random data, and lower for highly structured data.
1306 */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001307 Py_ssize_t min_gallop;
Tim Peterse05f65a2002-08-10 05:21:15 +00001308
Tim Petersa64dc242002-08-01 02:13:36 +00001309 /* 'a' is temp storage to help with merges. It contains room for
1310 * alloced entries.
1311 */
1312 PyObject **a; /* may point to temparray below */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001313 Py_ssize_t alloced;
Tim Petersa64dc242002-08-01 02:13:36 +00001314
1315 /* A stack of n pending runs yet to be merged. Run #i starts at
1316 * address base[i] and extends for len[i] elements. It's always
1317 * true (so long as the indices are in bounds) that
1318 *
Tim Peterse05f65a2002-08-10 05:21:15 +00001319 * pending[i].base + pending[i].len == pending[i+1].base
Tim Petersa64dc242002-08-01 02:13:36 +00001320 *
1321 * so we could cut the storage for this, but it's a minor amount,
1322 * and keeping all the info explicit simplifies the code.
1323 */
1324 int n;
Tim Peterse05f65a2002-08-10 05:21:15 +00001325 struct s_slice pending[MAX_MERGE_PENDING];
Tim Petersa64dc242002-08-01 02:13:36 +00001326
1327 /* 'a' points to this when possible, rather than muck with malloc. */
1328 PyObject *temparray[MERGESTATE_TEMP_SIZE];
1329} MergeState;
1330
1331/* Conceptually a MergeState's constructor. */
1332static void
1333merge_init(MergeState *ms, PyObject *compare)
1334{
1335 assert(ms != NULL);
1336 ms->compare = compare;
1337 ms->a = ms->temparray;
1338 ms->alloced = MERGESTATE_TEMP_SIZE;
1339 ms->n = 0;
Tim Peterse05f65a2002-08-10 05:21:15 +00001340 ms->min_gallop = MIN_GALLOP;
Tim Petersa64dc242002-08-01 02:13:36 +00001341}
1342
1343/* Free all the temp memory owned by the MergeState. This must be called
1344 * when you're done with a MergeState, and may be called before then if
1345 * you want to free the temp memory early.
1346 */
1347static void
1348merge_freemem(MergeState *ms)
1349{
1350 assert(ms != NULL);
1351 if (ms->a != ms->temparray)
1352 PyMem_Free(ms->a);
1353 ms->a = ms->temparray;
1354 ms->alloced = MERGESTATE_TEMP_SIZE;
1355}
1356
1357/* Ensure enough temp memory for 'need' array slots is available.
1358 * Returns 0 on success and -1 if the memory can't be gotten.
1359 */
1360static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001361merge_getmem(MergeState *ms, Py_ssize_t need)
Tim Petersa64dc242002-08-01 02:13:36 +00001362{
1363 assert(ms != NULL);
1364 if (need <= ms->alloced)
1365 return 0;
1366 /* Don't realloc! That can cost cycles to copy the old data, but
1367 * we don't care what's in the block.
1368 */
1369 merge_freemem(ms);
1370 ms->a = (PyObject **)PyMem_Malloc(need * sizeof(PyObject*));
1371 if (ms->a) {
1372 ms->alloced = need;
1373 return 0;
1374 }
1375 PyErr_NoMemory();
1376 merge_freemem(ms); /* reset to sane state */
1377 return -1;
1378}
1379#define MERGE_GETMEM(MS, NEED) ((NEED) <= (MS)->alloced ? 0 : \
1380 merge_getmem(MS, NEED))
1381
1382/* Merge the na elements starting at pa with the nb elements starting at pb
1383 * in a stable way, in-place. na and nb must be > 0, and pa + na == pb.
1384 * Must also have that *pb < *pa, that pa[na-1] belongs at the end of the
1385 * merge, and should have na <= nb. See listsort.txt for more info.
1386 * Return 0 if successful, -1 if error.
1387 */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001388static Py_ssize_t
1389merge_lo(MergeState *ms, PyObject **pa, Py_ssize_t na,
1390 PyObject **pb, Py_ssize_t nb)
Tim Petersa64dc242002-08-01 02:13:36 +00001391{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001392 Py_ssize_t k;
Tim Petersa64dc242002-08-01 02:13:36 +00001393 PyObject *compare;
1394 PyObject **dest;
1395 int result = -1; /* guilty until proved innocent */
Neal Norwitz7fd96072006-08-19 04:28:55 +00001396 Py_ssize_t 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, na) < 0)
1400 return -1;
1401 memcpy(ms->a, pa, na * sizeof(PyObject*));
1402 dest = pa;
1403 pa = ms->a;
1404
1405 *dest++ = *pb++;
1406 --nb;
1407 if (nb == 0)
1408 goto Succeed;
1409 if (na == 1)
1410 goto CopyB;
1411
Neal Norwitz7fd96072006-08-19 04:28:55 +00001412 min_gallop = ms->min_gallop;
Tim Petersa64dc242002-08-01 02:13:36 +00001413 compare = ms->compare;
1414 for (;;) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001415 Py_ssize_t acount = 0; /* # of times A won in a row */
1416 Py_ssize_t bcount = 0; /* # of times B won in a row */
Tim Petersa64dc242002-08-01 02:13:36 +00001417
1418 /* Do the straightforward thing until (if ever) one run
1419 * appears to win consistently.
1420 */
1421 for (;;) {
Tim Peterse05f65a2002-08-10 05:21:15 +00001422 assert(na > 1 && nb > 0);
Tim Peters66860f62002-08-04 17:47:26 +00001423 k = ISLT(*pb, *pa, compare);
Tim Petersa64dc242002-08-01 02:13:36 +00001424 if (k) {
1425 if (k < 0)
1426 goto Fail;
1427 *dest++ = *pb++;
1428 ++bcount;
1429 acount = 0;
1430 --nb;
1431 if (nb == 0)
1432 goto Succeed;
Tim Peterse05f65a2002-08-10 05:21:15 +00001433 if (bcount >= min_gallop)
Tim Petersa64dc242002-08-01 02:13:36 +00001434 break;
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001435 }
1436 else {
Tim Petersa64dc242002-08-01 02:13:36 +00001437 *dest++ = *pa++;
1438 ++acount;
1439 bcount = 0;
1440 --na;
1441 if (na == 1)
1442 goto CopyB;
Tim Peterse05f65a2002-08-10 05:21:15 +00001443 if (acount >= min_gallop)
Tim Petersa64dc242002-08-01 02:13:36 +00001444 break;
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001445 }
Tim Petersa64dc242002-08-01 02:13:36 +00001446 }
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001447
Tim Petersa64dc242002-08-01 02:13:36 +00001448 /* One run is winning so consistently that galloping may
1449 * be a huge win. So try that, and continue galloping until
1450 * (if ever) neither run appears to be winning consistently
1451 * anymore.
1452 */
Tim Peterse05f65a2002-08-10 05:21:15 +00001453 ++min_gallop;
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001454 do {
Tim Peterse05f65a2002-08-10 05:21:15 +00001455 assert(na > 1 && nb > 0);
1456 min_gallop -= min_gallop > 1;
1457 ms->min_gallop = min_gallop;
Tim Petersa64dc242002-08-01 02:13:36 +00001458 k = gallop_right(*pb, pa, na, 0, compare);
1459 acount = k;
1460 if (k) {
1461 if (k < 0)
1462 goto Fail;
1463 memcpy(dest, pa, k * sizeof(PyObject *));
1464 dest += k;
1465 pa += k;
1466 na -= k;
1467 if (na == 1)
1468 goto CopyB;
1469 /* na==0 is impossible now if the comparison
1470 * function is consistent, but we can't assume
1471 * that it is.
1472 */
1473 if (na == 0)
1474 goto Succeed;
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001475 }
Tim Petersa64dc242002-08-01 02:13:36 +00001476 *dest++ = *pb++;
1477 --nb;
1478 if (nb == 0)
1479 goto Succeed;
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001480
Tim Petersa64dc242002-08-01 02:13:36 +00001481 k = gallop_left(*pa, pb, nb, 0, compare);
1482 bcount = k;
1483 if (k) {
1484 if (k < 0)
1485 goto Fail;
1486 memmove(dest, pb, k * sizeof(PyObject *));
1487 dest += k;
1488 pb += k;
1489 nb -= k;
1490 if (nb == 0)
1491 goto Succeed;
1492 }
1493 *dest++ = *pa++;
1494 --na;
1495 if (na == 1)
1496 goto CopyB;
1497 } while (acount >= MIN_GALLOP || bcount >= MIN_GALLOP);
Tim Peterse05f65a2002-08-10 05:21:15 +00001498 ++min_gallop; /* penalize it for leaving galloping mode */
1499 ms->min_gallop = min_gallop;
Tim Petersa64dc242002-08-01 02:13:36 +00001500 }
1501Succeed:
1502 result = 0;
1503Fail:
1504 if (na)
1505 memcpy(dest, pa, na * sizeof(PyObject*));
1506 return result;
1507CopyB:
1508 assert(na == 1 && nb > 0);
1509 /* The last element of pa belongs at the end of the merge. */
1510 memmove(dest, pb, nb * sizeof(PyObject *));
1511 dest[nb] = *pa;
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001512 return 0;
Tim Petersa64dc242002-08-01 02:13:36 +00001513}
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001514
Tim Petersa64dc242002-08-01 02:13:36 +00001515/* Merge the na elements starting at pa with the nb elements starting at pb
1516 * in a stable way, in-place. na and nb must be > 0, and pa + na == pb.
1517 * Must also have that *pb < *pa, that pa[na-1] belongs at the end of the
1518 * merge, and should have na >= nb. See listsort.txt for more info.
1519 * Return 0 if successful, -1 if error.
1520 */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001521static Py_ssize_t
1522merge_hi(MergeState *ms, PyObject **pa, Py_ssize_t na, PyObject **pb, Py_ssize_t nb)
Tim Petersa64dc242002-08-01 02:13:36 +00001523{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001524 Py_ssize_t k;
Tim Petersa64dc242002-08-01 02:13:36 +00001525 PyObject *compare;
1526 PyObject **dest;
1527 int result = -1; /* guilty until proved innocent */
1528 PyObject **basea;
1529 PyObject **baseb;
Neal Norwitz7fd96072006-08-19 04:28:55 +00001530 Py_ssize_t min_gallop;
Tim Petersa64dc242002-08-01 02:13:36 +00001531
1532 assert(ms && pa && pb && na > 0 && nb > 0 && pa + na == pb);
1533 if (MERGE_GETMEM(ms, nb) < 0)
1534 return -1;
1535 dest = pb + nb - 1;
1536 memcpy(ms->a, pb, nb * sizeof(PyObject*));
1537 basea = pa;
1538 baseb = ms->a;
1539 pb = ms->a + nb - 1;
1540 pa += na - 1;
1541
1542 *dest-- = *pa--;
1543 --na;
1544 if (na == 0)
1545 goto Succeed;
1546 if (nb == 1)
1547 goto CopyA;
1548
Neal Norwitz7fd96072006-08-19 04:28:55 +00001549 min_gallop = ms->min_gallop;
Tim Petersa64dc242002-08-01 02:13:36 +00001550 compare = ms->compare;
1551 for (;;) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001552 Py_ssize_t acount = 0; /* # of times A won in a row */
1553 Py_ssize_t bcount = 0; /* # of times B won in a row */
Tim Petersa64dc242002-08-01 02:13:36 +00001554
1555 /* Do the straightforward thing until (if ever) one run
1556 * appears to win consistently.
1557 */
1558 for (;;) {
Tim Peterse05f65a2002-08-10 05:21:15 +00001559 assert(na > 0 && nb > 1);
Tim Peters66860f62002-08-04 17:47:26 +00001560 k = ISLT(*pb, *pa, compare);
Tim Petersa64dc242002-08-01 02:13:36 +00001561 if (k) {
1562 if (k < 0)
1563 goto Fail;
1564 *dest-- = *pa--;
1565 ++acount;
1566 bcount = 0;
1567 --na;
1568 if (na == 0)
1569 goto Succeed;
Tim Peterse05f65a2002-08-10 05:21:15 +00001570 if (acount >= min_gallop)
Tim Petersa64dc242002-08-01 02:13:36 +00001571 break;
1572 }
1573 else {
1574 *dest-- = *pb--;
1575 ++bcount;
1576 acount = 0;
1577 --nb;
1578 if (nb == 1)
1579 goto CopyA;
Tim Peterse05f65a2002-08-10 05:21:15 +00001580 if (bcount >= min_gallop)
Tim Petersa64dc242002-08-01 02:13:36 +00001581 break;
1582 }
1583 }
1584
1585 /* One run is winning so consistently that galloping may
1586 * be a huge win. So try that, and continue galloping until
1587 * (if ever) neither run appears to be winning consistently
1588 * anymore.
1589 */
Tim Peterse05f65a2002-08-10 05:21:15 +00001590 ++min_gallop;
Tim Petersa64dc242002-08-01 02:13:36 +00001591 do {
Tim Peterse05f65a2002-08-10 05:21:15 +00001592 assert(na > 0 && nb > 1);
1593 min_gallop -= min_gallop > 1;
1594 ms->min_gallop = min_gallop;
Tim Petersa64dc242002-08-01 02:13:36 +00001595 k = gallop_right(*pb, basea, na, na-1, compare);
1596 if (k < 0)
1597 goto Fail;
1598 k = na - k;
1599 acount = k;
1600 if (k) {
1601 dest -= k;
1602 pa -= k;
1603 memmove(dest+1, pa+1, k * sizeof(PyObject *));
1604 na -= k;
1605 if (na == 0)
1606 goto Succeed;
1607 }
1608 *dest-- = *pb--;
1609 --nb;
1610 if (nb == 1)
1611 goto CopyA;
1612
1613 k = gallop_left(*pa, baseb, nb, nb-1, compare);
1614 if (k < 0)
1615 goto Fail;
1616 k = nb - k;
1617 bcount = k;
1618 if (k) {
1619 dest -= k;
1620 pb -= k;
1621 memcpy(dest+1, pb+1, k * sizeof(PyObject *));
1622 nb -= k;
1623 if (nb == 1)
1624 goto CopyA;
1625 /* nb==0 is impossible now if the comparison
1626 * function is consistent, but we can't assume
1627 * that it is.
1628 */
1629 if (nb == 0)
1630 goto Succeed;
1631 }
1632 *dest-- = *pa--;
1633 --na;
1634 if (na == 0)
1635 goto Succeed;
1636 } while (acount >= MIN_GALLOP || bcount >= MIN_GALLOP);
Tim Peterse05f65a2002-08-10 05:21:15 +00001637 ++min_gallop; /* penalize it for leaving galloping mode */
1638 ms->min_gallop = min_gallop;
Tim Petersa64dc242002-08-01 02:13:36 +00001639 }
1640Succeed:
1641 result = 0;
1642Fail:
1643 if (nb)
1644 memcpy(dest-(nb-1), baseb, nb * sizeof(PyObject*));
1645 return result;
1646CopyA:
1647 assert(nb == 1 && na > 0);
1648 /* The first element of pb belongs at the front of the merge. */
1649 dest -= na;
1650 pa -= na;
1651 memmove(dest+1, pa+1, na * sizeof(PyObject *));
1652 *dest = *pb;
1653 return 0;
1654}
1655
1656/* Merge the two runs at stack indices i and i+1.
1657 * Returns 0 on success, -1 on error.
1658 */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001659static Py_ssize_t
1660merge_at(MergeState *ms, Py_ssize_t i)
Tim Petersa64dc242002-08-01 02:13:36 +00001661{
1662 PyObject **pa, **pb;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001663 Py_ssize_t na, nb;
1664 Py_ssize_t k;
Tim Petersa64dc242002-08-01 02:13:36 +00001665 PyObject *compare;
1666
1667 assert(ms != NULL);
1668 assert(ms->n >= 2);
1669 assert(i >= 0);
1670 assert(i == ms->n - 2 || i == ms->n - 3);
1671
Tim Peterse05f65a2002-08-10 05:21:15 +00001672 pa = ms->pending[i].base;
1673 na = ms->pending[i].len;
1674 pb = ms->pending[i+1].base;
1675 nb = ms->pending[i+1].len;
Tim Petersa64dc242002-08-01 02:13:36 +00001676 assert(na > 0 && nb > 0);
1677 assert(pa + na == pb);
1678
1679 /* Record the length of the combined runs; if i is the 3rd-last
1680 * run now, also slide over the last run (which isn't involved
1681 * in this merge). The current run i+1 goes away in any case.
1682 */
Tim Peterse05f65a2002-08-10 05:21:15 +00001683 ms->pending[i].len = na + nb;
1684 if (i == ms->n - 3)
1685 ms->pending[i+1] = ms->pending[i+2];
Tim Petersa64dc242002-08-01 02:13:36 +00001686 --ms->n;
1687
1688 /* Where does b start in a? Elements in a before that can be
1689 * ignored (already in place).
1690 */
1691 compare = ms->compare;
1692 k = gallop_right(*pb, pa, na, 0, compare);
1693 if (k < 0)
1694 return -1;
1695 pa += k;
1696 na -= k;
1697 if (na == 0)
1698 return 0;
1699
1700 /* Where does a end in b? Elements in b after that can be
1701 * ignored (already in place).
1702 */
1703 nb = gallop_left(pa[na-1], pb, nb, nb-1, compare);
1704 if (nb <= 0)
1705 return nb;
1706
1707 /* Merge what remains of the runs, using a temp array with
1708 * min(na, nb) elements.
1709 */
1710 if (na <= nb)
1711 return merge_lo(ms, pa, na, pb, nb);
1712 else
1713 return merge_hi(ms, pa, na, pb, nb);
1714}
1715
1716/* Examine the stack of runs waiting to be merged, merging adjacent runs
1717 * until the stack invariants are re-established:
1718 *
1719 * 1. len[-3] > len[-2] + len[-1]
1720 * 2. len[-2] > len[-1]
1721 *
1722 * See listsort.txt for more info.
1723 *
1724 * Returns 0 on success, -1 on error.
1725 */
1726static int
1727merge_collapse(MergeState *ms)
1728{
Tim Peterse05f65a2002-08-10 05:21:15 +00001729 struct s_slice *p = ms->pending;
Tim Petersa64dc242002-08-01 02:13:36 +00001730
1731 assert(ms);
1732 while (ms->n > 1) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001733 Py_ssize_t n = ms->n - 2;
Tim Peterse05f65a2002-08-10 05:21:15 +00001734 if (n > 0 && p[n-1].len <= p[n].len + p[n+1].len) {
1735 if (p[n-1].len < p[n+1].len)
Tim Petersa64dc242002-08-01 02:13:36 +00001736 --n;
1737 if (merge_at(ms, n) < 0)
1738 return -1;
1739 }
Tim Peterse05f65a2002-08-10 05:21:15 +00001740 else if (p[n].len <= p[n+1].len) {
Tim Petersa64dc242002-08-01 02:13:36 +00001741 if (merge_at(ms, n) < 0)
1742 return -1;
1743 }
1744 else
1745 break;
1746 }
1747 return 0;
1748}
1749
1750/* Regardless of invariants, merge all runs on the stack until only one
1751 * remains. This is used at the end of the mergesort.
1752 *
1753 * Returns 0 on success, -1 on error.
1754 */
1755static int
1756merge_force_collapse(MergeState *ms)
1757{
Tim Peterse05f65a2002-08-10 05:21:15 +00001758 struct s_slice *p = ms->pending;
Tim Petersa64dc242002-08-01 02:13:36 +00001759
1760 assert(ms);
1761 while (ms->n > 1) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001762 Py_ssize_t n = ms->n - 2;
Tim Peterse05f65a2002-08-10 05:21:15 +00001763 if (n > 0 && p[n-1].len < p[n+1].len)
Tim Petersa64dc242002-08-01 02:13:36 +00001764 --n;
1765 if (merge_at(ms, n) < 0)
1766 return -1;
1767 }
1768 return 0;
1769}
1770
1771/* Compute a good value for the minimum run length; natural runs shorter
1772 * than this are boosted artificially via binary insertion.
1773 *
1774 * If n < 64, return n (it's too small to bother with fancy stuff).
1775 * Else if n is an exact power of 2, return 32.
1776 * Else return an int k, 32 <= k <= 64, such that n/k is close to, but
1777 * strictly less than, an exact power of 2.
1778 *
1779 * See listsort.txt for more info.
1780 */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001781static Py_ssize_t
1782merge_compute_minrun(Py_ssize_t n)
Tim Petersa64dc242002-08-01 02:13:36 +00001783{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001784 Py_ssize_t r = 0; /* becomes 1 if any 1 bits are shifted off */
Tim Petersa64dc242002-08-01 02:13:36 +00001785
1786 assert(n >= 0);
1787 while (n >= 64) {
1788 r |= n & 1;
1789 n >>= 1;
1790 }
1791 return n + r;
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001792}
Guido van Rossuma119c0d1998-05-29 17:56:32 +00001793
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00001794/* Special wrapper to support stable sorting using the decorate-sort-undecorate
Andrew M. Kuchling55be9ea2004-09-10 12:59:54 +00001795 pattern. Holds a key which is used for comparisons and the original record
Tim Petersb38e2b62004-07-29 02:29:26 +00001796 which is returned during the undecorate phase. By exposing only the key
1797 during comparisons, the underlying sort stability characteristics are left
1798 unchanged. Also, if a custom comparison function is used, it will only see
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00001799 the key instead of a full record. */
1800
1801typedef struct {
1802 PyObject_HEAD
1803 PyObject *key;
1804 PyObject *value;
1805} sortwrapperobject;
1806
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00001807PyDoc_STRVAR(sortwrapper_doc, "Object wrapper with a custom sort key.");
Anthony Baxter377be112006-04-11 06:54:30 +00001808static PyObject *
1809sortwrapper_richcompare(sortwrapperobject *, sortwrapperobject *, int);
1810static void
1811sortwrapper_dealloc(sortwrapperobject *);
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00001812
1813static PyTypeObject sortwrapper_type = {
1814 PyObject_HEAD_INIT(&PyType_Type)
1815 0, /* ob_size */
1816 "sortwrapper", /* tp_name */
1817 sizeof(sortwrapperobject), /* tp_basicsize */
1818 0, /* tp_itemsize */
1819 /* methods */
1820 (destructor)sortwrapper_dealloc, /* tp_dealloc */
1821 0, /* tp_print */
1822 0, /* tp_getattr */
1823 0, /* tp_setattr */
1824 0, /* tp_compare */
1825 0, /* tp_repr */
1826 0, /* tp_as_number */
1827 0, /* tp_as_sequence */
1828 0, /* tp_as_mapping */
1829 0, /* tp_hash */
1830 0, /* tp_call */
1831 0, /* tp_str */
1832 PyObject_GenericGetAttr, /* tp_getattro */
1833 0, /* tp_setattro */
1834 0, /* tp_as_buffer */
Tim Petersb38e2b62004-07-29 02:29:26 +00001835 Py_TPFLAGS_DEFAULT |
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00001836 Py_TPFLAGS_HAVE_RICHCOMPARE, /* tp_flags */
1837 sortwrapper_doc, /* tp_doc */
1838 0, /* tp_traverse */
1839 0, /* tp_clear */
1840 (richcmpfunc)sortwrapper_richcompare, /* tp_richcompare */
1841};
1842
Anthony Baxter377be112006-04-11 06:54:30 +00001843
1844static PyObject *
1845sortwrapper_richcompare(sortwrapperobject *a, sortwrapperobject *b, int op)
1846{
1847 if (!PyObject_TypeCheck(b, &sortwrapper_type)) {
1848 PyErr_SetString(PyExc_TypeError,
1849 "expected a sortwrapperobject");
1850 return NULL;
1851 }
1852 return PyObject_RichCompare(a->key, b->key, op);
1853}
1854
1855static void
1856sortwrapper_dealloc(sortwrapperobject *so)
1857{
1858 Py_XDECREF(so->key);
1859 Py_XDECREF(so->value);
1860 PyObject_Del(so);
1861}
1862
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00001863/* Returns a new reference to a sortwrapper.
1864 Consumes the references to the two underlying objects. */
1865
1866static PyObject *
1867build_sortwrapper(PyObject *key, PyObject *value)
1868{
1869 sortwrapperobject *so;
Tim Petersb38e2b62004-07-29 02:29:26 +00001870
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00001871 so = PyObject_New(sortwrapperobject, &sortwrapper_type);
1872 if (so == NULL)
1873 return NULL;
1874 so->key = key;
1875 so->value = value;
1876 return (PyObject *)so;
1877}
1878
1879/* Returns a new reference to the value underlying the wrapper. */
1880static PyObject *
1881sortwrapper_getvalue(PyObject *so)
1882{
1883 PyObject *value;
1884
1885 if (!PyObject_TypeCheck(so, &sortwrapper_type)) {
Tim Petersb38e2b62004-07-29 02:29:26 +00001886 PyErr_SetString(PyExc_TypeError,
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00001887 "expected a sortwrapperobject");
1888 return NULL;
1889 }
1890 value = ((sortwrapperobject *)so)->value;
1891 Py_INCREF(value);
1892 return value;
1893}
1894
1895/* Wrapper for user specified cmp functions in combination with a
1896 specified key function. Makes sure the cmp function is presented
1897 with the actual key instead of the sortwrapper */
1898
1899typedef struct {
1900 PyObject_HEAD
1901 PyObject *func;
1902} cmpwrapperobject;
1903
1904static void
1905cmpwrapper_dealloc(cmpwrapperobject *co)
1906{
1907 Py_XDECREF(co->func);
1908 PyObject_Del(co);
1909}
1910
1911static PyObject *
1912cmpwrapper_call(cmpwrapperobject *co, PyObject *args, PyObject *kwds)
1913{
1914 PyObject *x, *y, *xx, *yy;
1915
1916 if (!PyArg_UnpackTuple(args, "", 2, 2, &x, &y))
1917 return NULL;
1918 if (!PyObject_TypeCheck(x, &sortwrapper_type) ||
Raymond Hettingerae4a2992003-10-16 17:16:30 +00001919 !PyObject_TypeCheck(y, &sortwrapper_type)) {
Tim Petersb38e2b62004-07-29 02:29:26 +00001920 PyErr_SetString(PyExc_TypeError,
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00001921 "expected a sortwrapperobject");
1922 return NULL;
1923 }
1924 xx = ((sortwrapperobject *)x)->key;
1925 yy = ((sortwrapperobject *)y)->key;
1926 return PyObject_CallFunctionObjArgs(co->func, xx, yy, NULL);
1927}
1928
1929PyDoc_STRVAR(cmpwrapper_doc, "cmp() wrapper for sort with custom keys.");
1930
1931static PyTypeObject cmpwrapper_type = {
1932 PyObject_HEAD_INIT(&PyType_Type)
1933 0, /* ob_size */
1934 "cmpwrapper", /* tp_name */
1935 sizeof(cmpwrapperobject), /* tp_basicsize */
1936 0, /* tp_itemsize */
1937 /* methods */
1938 (destructor)cmpwrapper_dealloc, /* tp_dealloc */
1939 0, /* tp_print */
1940 0, /* tp_getattr */
1941 0, /* tp_setattr */
1942 0, /* tp_compare */
1943 0, /* tp_repr */
1944 0, /* tp_as_number */
1945 0, /* tp_as_sequence */
1946 0, /* tp_as_mapping */
1947 0, /* tp_hash */
1948 (ternaryfunc)cmpwrapper_call, /* tp_call */
1949 0, /* tp_str */
1950 PyObject_GenericGetAttr, /* tp_getattro */
1951 0, /* tp_setattro */
1952 0, /* tp_as_buffer */
1953 Py_TPFLAGS_DEFAULT, /* tp_flags */
1954 cmpwrapper_doc, /* tp_doc */
1955};
1956
1957static PyObject *
1958build_cmpwrapper(PyObject *cmpfunc)
1959{
1960 cmpwrapperobject *co;
Tim Petersb38e2b62004-07-29 02:29:26 +00001961
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00001962 co = PyObject_New(cmpwrapperobject, &cmpwrapper_type);
1963 if (co == NULL)
1964 return NULL;
1965 Py_INCREF(cmpfunc);
1966 co->func = cmpfunc;
1967 return (PyObject *)co;
1968}
1969
Tim Petersa64dc242002-08-01 02:13:36 +00001970/* An adaptive, stable, natural mergesort. See listsort.txt.
1971 * Returns Py_None on success, NULL on error. Even in case of error, the
1972 * list will be some permutation of its input state (nothing is lost or
1973 * duplicated).
1974 */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001975static PyObject *
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00001976listsort(PyListObject *self, PyObject *args, PyObject *kwds)
Guido van Rossum3f236de1996-12-10 23:55:39 +00001977{
Tim Petersa64dc242002-08-01 02:13:36 +00001978 MergeState ms;
1979 PyObject **lo, **hi;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001980 Py_ssize_t nremaining;
1981 Py_ssize_t minrun;
1982 Py_ssize_t saved_ob_size, saved_allocated;
Tim Petersb9099c32002-11-12 22:08:10 +00001983 PyObject **saved_ob_item;
Armin Rigo93677f02004-07-29 12:40:23 +00001984 PyObject **final_ob_item;
Tim Petersa64dc242002-08-01 02:13:36 +00001985 PyObject *compare = NULL;
1986 PyObject *result = NULL; /* guilty until proved innocent */
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00001987 int reverse = 0;
1988 PyObject *keyfunc = NULL;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001989 Py_ssize_t i;
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00001990 PyObject *key, *value, *kvpair;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001991 static char *kwlist[] = {"cmp", "key", "reverse", 0};
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00001992
Tim Petersa64dc242002-08-01 02:13:36 +00001993 assert(self != NULL);
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00001994 assert (PyList_Check(self));
Guido van Rossum4aa24f92000-02-24 15:23:03 +00001995 if (args != NULL) {
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00001996 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OOi:sort",
1997 kwlist, &compare, &keyfunc, &reverse))
Guido van Rossum4aa24f92000-02-24 15:23:03 +00001998 return NULL;
1999 }
Skip Montanaro4abd5f02003-01-02 20:51:08 +00002000 if (compare == Py_None)
2001 compare = NULL;
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00002002 if (keyfunc == Py_None)
2003 keyfunc = NULL;
2004 if (compare != NULL && keyfunc != NULL) {
2005 compare = build_cmpwrapper(compare);
2006 if (compare == NULL)
Hye-Shik Chang19cb1932003-12-10 07:31:08 +00002007 return NULL;
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00002008 } else
2009 Py_XINCREF(compare);
2010
Tim Petersb9099c32002-11-12 22:08:10 +00002011 /* The list is temporarily made empty, so that mutations performed
2012 * by comparison functions can't affect the slice of memory we're
2013 * sorting (allowing mutations during sorting is a core-dump
2014 * factory, since ob_item may change).
2015 */
2016 saved_ob_size = self->ob_size;
2017 saved_ob_item = self->ob_item;
Raymond Hettinger4bb95402004-02-13 11:36:39 +00002018 saved_allocated = self->allocated;
Armin Rigo93677f02004-07-29 12:40:23 +00002019 self->ob_size = 0;
Tim Peters51b4ade2004-07-29 04:07:15 +00002020 self->ob_item = NULL;
Armin Rigo93677f02004-07-29 12:40:23 +00002021 self->allocated = -1; /* any operation will reset it to >= 0 */
Tim Peters330f9e92002-07-19 07:05:44 +00002022
Michael W. Hudson1df0f652003-12-04 11:25:46 +00002023 if (keyfunc != NULL) {
2024 for (i=0 ; i < saved_ob_size ; i++) {
2025 value = saved_ob_item[i];
Tim Petersb38e2b62004-07-29 02:29:26 +00002026 key = PyObject_CallFunctionObjArgs(keyfunc, value,
Michael W. Hudson1df0f652003-12-04 11:25:46 +00002027 NULL);
2028 if (key == NULL) {
2029 for (i=i-1 ; i>=0 ; i--) {
2030 kvpair = saved_ob_item[i];
2031 value = sortwrapper_getvalue(kvpair);
2032 saved_ob_item[i] = value;
2033 Py_DECREF(kvpair);
2034 }
Michael W. Hudson1df0f652003-12-04 11:25:46 +00002035 goto dsu_fail;
2036 }
2037 kvpair = build_sortwrapper(key, value);
2038 if (kvpair == NULL)
2039 goto dsu_fail;
2040 saved_ob_item[i] = kvpair;
2041 }
2042 }
2043
2044 /* Reverse sort stability achieved by initially reversing the list,
2045 applying a stable forward sort, then reversing the final result. */
2046 if (reverse && saved_ob_size > 1)
2047 reverse_slice(saved_ob_item, saved_ob_item + saved_ob_size);
2048
2049 merge_init(&ms, compare);
2050
Tim Petersb9099c32002-11-12 22:08:10 +00002051 nremaining = saved_ob_size;
Tim Petersa64dc242002-08-01 02:13:36 +00002052 if (nremaining < 2)
2053 goto succeed;
Tim Peters330f9e92002-07-19 07:05:44 +00002054
Tim Petersa64dc242002-08-01 02:13:36 +00002055 /* March over the array once, left to right, finding natural runs,
2056 * and extending short natural runs to minrun elements.
2057 */
Tim Petersb9099c32002-11-12 22:08:10 +00002058 lo = saved_ob_item;
Tim Petersa64dc242002-08-01 02:13:36 +00002059 hi = lo + nremaining;
2060 minrun = merge_compute_minrun(nremaining);
2061 do {
2062 int descending;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002063 Py_ssize_t n;
Tim Peters330f9e92002-07-19 07:05:44 +00002064
Tim Petersa64dc242002-08-01 02:13:36 +00002065 /* Identify next run. */
2066 n = count_run(lo, hi, compare, &descending);
2067 if (n < 0)
2068 goto fail;
2069 if (descending)
2070 reverse_slice(lo, lo + n);
2071 /* If short, extend to min(minrun, nremaining). */
2072 if (n < minrun) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00002073 const Py_ssize_t force = nremaining <= minrun ?
Tim Petersa64dc242002-08-01 02:13:36 +00002074 nremaining : minrun;
2075 if (binarysort(lo, lo + force, lo + n, compare) < 0)
2076 goto fail;
2077 n = force;
2078 }
2079 /* Push run onto pending-runs stack, and maybe merge. */
2080 assert(ms.n < MAX_MERGE_PENDING);
Tim Peterse05f65a2002-08-10 05:21:15 +00002081 ms.pending[ms.n].base = lo;
2082 ms.pending[ms.n].len = n;
Tim Petersa64dc242002-08-01 02:13:36 +00002083 ++ms.n;
2084 if (merge_collapse(&ms) < 0)
2085 goto fail;
2086 /* Advance to find next run. */
2087 lo += n;
2088 nremaining -= n;
2089 } while (nremaining);
2090 assert(lo == hi);
Tim Peters330f9e92002-07-19 07:05:44 +00002091
Tim Petersa64dc242002-08-01 02:13:36 +00002092 if (merge_force_collapse(&ms) < 0)
2093 goto fail;
2094 assert(ms.n == 1);
Tim Petersb9099c32002-11-12 22:08:10 +00002095 assert(ms.pending[0].base == saved_ob_item);
2096 assert(ms.pending[0].len == saved_ob_size);
Tim Petersa64dc242002-08-01 02:13:36 +00002097
2098succeed:
2099 result = Py_None;
Tim Peters330f9e92002-07-19 07:05:44 +00002100fail:
Michael W. Hudson1df0f652003-12-04 11:25:46 +00002101 if (keyfunc != NULL) {
2102 for (i=0 ; i < saved_ob_size ; i++) {
2103 kvpair = saved_ob_item[i];
2104 value = sortwrapper_getvalue(kvpair);
2105 saved_ob_item[i] = value;
2106 Py_DECREF(kvpair);
2107 }
2108 }
2109
Armin Rigo93677f02004-07-29 12:40:23 +00002110 if (self->allocated != -1 && result != NULL) {
Tim Peters51b4ade2004-07-29 04:07:15 +00002111 /* The user mucked with the list during the sort,
2112 * and we don't already have another error to report.
2113 */
2114 PyErr_SetString(PyExc_ValueError, "list modified during sort");
2115 result = NULL;
Tim Petersb9099c32002-11-12 22:08:10 +00002116 }
Michael W. Hudson1df0f652003-12-04 11:25:46 +00002117
2118 if (reverse && saved_ob_size > 1)
2119 reverse_slice(saved_ob_item, saved_ob_item + saved_ob_size);
2120
2121 merge_freemem(&ms);
2122
2123dsu_fail:
Armin Rigo93677f02004-07-29 12:40:23 +00002124 final_ob_item = self->ob_item;
2125 i = self->ob_size;
Tim Petersb9099c32002-11-12 22:08:10 +00002126 self->ob_size = saved_ob_size;
2127 self->ob_item = saved_ob_item;
Raymond Hettinger4bb95402004-02-13 11:36:39 +00002128 self->allocated = saved_allocated;
Armin Rigo93677f02004-07-29 12:40:23 +00002129 if (final_ob_item != NULL) {
2130 /* we cannot use list_clear() for this because it does not
2131 guarantee that the list is really empty when it returns */
2132 while (--i >= 0) {
2133 Py_XDECREF(final_ob_item[i]);
2134 }
2135 PyMem_FREE(final_ob_item);
2136 }
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00002137 Py_XDECREF(compare);
Tim Petersa64dc242002-08-01 02:13:36 +00002138 Py_XINCREF(result);
2139 return result;
Guido van Rossum3f236de1996-12-10 23:55:39 +00002140}
Tim Peters330f9e92002-07-19 07:05:44 +00002141#undef IFLT
Tim Peters66860f62002-08-04 17:47:26 +00002142#undef ISLT
Tim Peters330f9e92002-07-19 07:05:44 +00002143
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00002144int
Fred Drakea2f55112000-07-09 15:16:51 +00002145PyList_Sort(PyObject *v)
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00002146{
2147 if (v == NULL || !PyList_Check(v)) {
2148 PyErr_BadInternalCall();
2149 return -1;
2150 }
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00002151 v = listsort((PyListObject *)v, (PyObject *)NULL, (PyObject *)NULL);
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00002152 if (v == NULL)
2153 return -1;
2154 Py_DECREF(v);
2155 return 0;
2156}
2157
Guido van Rossumb86c5492001-02-12 22:06:02 +00002158static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00002159listreverse(PyListObject *self)
Guido van Rossumb86c5492001-02-12 22:06:02 +00002160{
Tim Peters326b4482002-07-19 04:04:16 +00002161 if (self->ob_size > 1)
2162 reverse_slice(self->ob_item, self->ob_item + self->ob_size);
Raymond Hettinger45d0b5c2004-04-12 17:21:03 +00002163 Py_RETURN_NONE;
Guido van Rossumed98d481991-03-06 13:07:53 +00002164}
2165
Guido van Rossum84c76f51990-10-30 13:32:20 +00002166int
Fred Drakea2f55112000-07-09 15:16:51 +00002167PyList_Reverse(PyObject *v)
Guido van Rossumb0fe3a91995-01-17 16:34:45 +00002168{
Tim Peters6063e262002-08-08 01:06:39 +00002169 PyListObject *self = (PyListObject *)v;
2170
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002171 if (v == NULL || !PyList_Check(v)) {
2172 PyErr_BadInternalCall();
Guido van Rossumb0fe3a91995-01-17 16:34:45 +00002173 return -1;
2174 }
Tim Peters6063e262002-08-08 01:06:39 +00002175 if (self->ob_size > 1)
2176 reverse_slice(self->ob_item, self->ob_item + self->ob_size);
Guido van Rossumb0fe3a91995-01-17 16:34:45 +00002177 return 0;
2178}
2179
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002180PyObject *
Fred Drakea2f55112000-07-09 15:16:51 +00002181PyList_AsTuple(PyObject *v)
Guido van Rossum6cd2fe01994-08-29 12:45:32 +00002182{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002183 PyObject *w;
2184 PyObject **p;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002185 Py_ssize_t n;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002186 if (v == NULL || !PyList_Check(v)) {
2187 PyErr_BadInternalCall();
Guido van Rossum6cd2fe01994-08-29 12:45:32 +00002188 return NULL;
2189 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002190 n = ((PyListObject *)v)->ob_size;
2191 w = PyTuple_New(n);
Guido van Rossum6cd2fe01994-08-29 12:45:32 +00002192 if (w == NULL)
2193 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002194 p = ((PyTupleObject *)w)->ob_item;
Thomas Wouters334fb892000-07-25 12:56:38 +00002195 memcpy((void *)p,
2196 (void *)((PyListObject *)v)->ob_item,
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002197 n*sizeof(PyObject *));
Guido van Rossum6cd2fe01994-08-29 12:45:32 +00002198 while (--n >= 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002199 Py_INCREF(*p);
Guido van Rossum6cd2fe01994-08-29 12:45:32 +00002200 p++;
2201 }
2202 return w;
2203}
2204
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002205static PyObject *
Raymond Hettingerd05abde2003-06-17 05:05:49 +00002206listindex(PyListObject *self, PyObject *args)
Guido van Rossumed98d481991-03-06 13:07:53 +00002207{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002208 Py_ssize_t i, start=0, stop=self->ob_size;
Raymond Hettingerd05abde2003-06-17 05:05:49 +00002209 PyObject *v;
Guido van Rossum4aa24f92000-02-24 15:23:03 +00002210
Walter Dörwalde8049bef2003-06-17 19:27:39 +00002211 if (!PyArg_ParseTuple(args, "O|O&O&:index", &v,
2212 _PyEval_SliceIndex, &start,
2213 _PyEval_SliceIndex, &stop))
Raymond Hettingerd05abde2003-06-17 05:05:49 +00002214 return NULL;
Guido van Rossum2743d872003-06-17 14:25:14 +00002215 if (start < 0) {
2216 start += self->ob_size;
2217 if (start < 0)
2218 start = 0;
2219 }
2220 if (stop < 0) {
2221 stop += self->ob_size;
2222 if (stop < 0)
2223 stop = 0;
2224 }
Neal Norwitzf0769532004-08-13 03:18:29 +00002225 for (i = start; i < stop && i < self->ob_size; i++) {
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002226 int cmp = PyObject_RichCompareBool(self->ob_item[i], v, Py_EQ);
2227 if (cmp > 0)
Martin v. Löwis18e16552006-02-15 17:27:45 +00002228 return PyInt_FromSsize_t(i);
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002229 else if (cmp < 0)
Guido van Rossumc8b6df91997-05-23 00:06:51 +00002230 return NULL;
Guido van Rossumed98d481991-03-06 13:07:53 +00002231 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002232 PyErr_SetString(PyExc_ValueError, "list.index(x): x not in list");
Guido van Rossumed98d481991-03-06 13:07:53 +00002233 return NULL;
2234}
2235
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002236static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00002237listcount(PyListObject *self, PyObject *v)
Guido van Rossume6f7d181991-10-20 20:20:40 +00002238{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002239 Py_ssize_t count = 0;
2240 Py_ssize_t i;
Guido van Rossum4aa24f92000-02-24 15:23:03 +00002241
Guido van Rossume6f7d181991-10-20 20:20:40 +00002242 for (i = 0; i < self->ob_size; i++) {
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002243 int cmp = PyObject_RichCompareBool(self->ob_item[i], v, Py_EQ);
2244 if (cmp > 0)
Guido van Rossume6f7d181991-10-20 20:20:40 +00002245 count++;
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002246 else if (cmp < 0)
Guido van Rossumc8b6df91997-05-23 00:06:51 +00002247 return NULL;
Guido van Rossume6f7d181991-10-20 20:20:40 +00002248 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002249 return PyInt_FromSsize_t(count);
Guido van Rossume6f7d181991-10-20 20:20:40 +00002250}
2251
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002252static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00002253listremove(PyListObject *self, PyObject *v)
Guido van Rossumed98d481991-03-06 13:07:53 +00002254{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002255 Py_ssize_t i;
Guido van Rossum4aa24f92000-02-24 15:23:03 +00002256
Guido van Rossumed98d481991-03-06 13:07:53 +00002257 for (i = 0; i < self->ob_size; i++) {
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002258 int cmp = PyObject_RichCompareBool(self->ob_item[i], v, Py_EQ);
2259 if (cmp > 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002260 if (list_ass_slice(self, i, i+1,
Raymond Hettinger45d0b5c2004-04-12 17:21:03 +00002261 (PyObject *)NULL) == 0)
2262 Py_RETURN_NONE;
2263 return NULL;
Guido van Rossumed98d481991-03-06 13:07:53 +00002264 }
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002265 else if (cmp < 0)
Guido van Rossumc8b6df91997-05-23 00:06:51 +00002266 return NULL;
Guido van Rossumed98d481991-03-06 13:07:53 +00002267 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002268 PyErr_SetString(PyExc_ValueError, "list.remove(x): x not in list");
Guido van Rossumed98d481991-03-06 13:07:53 +00002269 return NULL;
2270}
2271
Jeremy Hylton8caad492000-06-23 14:18:11 +00002272static int
2273list_traverse(PyListObject *o, visitproc visit, void *arg)
2274{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002275 Py_ssize_t i;
Jeremy Hylton8caad492000-06-23 14:18:11 +00002276
Thomas Woutersc6e55062006-04-15 21:47:09 +00002277 for (i = o->ob_size; --i >= 0; )
2278 Py_VISIT(o->ob_item[i]);
Jeremy Hylton8caad492000-06-23 14:18:11 +00002279 return 0;
2280}
2281
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002282static PyObject *
2283list_richcompare(PyObject *v, PyObject *w, int op)
2284{
2285 PyListObject *vl, *wl;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002286 Py_ssize_t i;
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002287
2288 if (!PyList_Check(v) || !PyList_Check(w)) {
2289 Py_INCREF(Py_NotImplemented);
2290 return Py_NotImplemented;
2291 }
2292
2293 vl = (PyListObject *)v;
2294 wl = (PyListObject *)w;
2295
2296 if (vl->ob_size != wl->ob_size && (op == Py_EQ || op == Py_NE)) {
2297 /* Shortcut: if the lengths differ, the lists differ */
2298 PyObject *res;
2299 if (op == Py_EQ)
2300 res = Py_False;
2301 else
2302 res = Py_True;
2303 Py_INCREF(res);
2304 return res;
2305 }
2306
2307 /* Search for the first index where items are different */
2308 for (i = 0; i < vl->ob_size && i < wl->ob_size; i++) {
2309 int k = PyObject_RichCompareBool(vl->ob_item[i],
2310 wl->ob_item[i], Py_EQ);
2311 if (k < 0)
2312 return NULL;
2313 if (!k)
2314 break;
2315 }
2316
2317 if (i >= vl->ob_size || i >= wl->ob_size) {
2318 /* No more items to compare -- compare sizes */
Martin v. Löwis18e16552006-02-15 17:27:45 +00002319 Py_ssize_t vs = vl->ob_size;
2320 Py_ssize_t ws = wl->ob_size;
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002321 int cmp;
2322 PyObject *res;
2323 switch (op) {
2324 case Py_LT: cmp = vs < ws; break;
Tim Peters6ee42342001-07-06 17:45:43 +00002325 case Py_LE: cmp = vs <= ws; break;
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002326 case Py_EQ: cmp = vs == ws; break;
2327 case Py_NE: cmp = vs != ws; break;
2328 case Py_GT: cmp = vs > ws; break;
2329 case Py_GE: cmp = vs >= ws; break;
2330 default: return NULL; /* cannot happen */
2331 }
2332 if (cmp)
2333 res = Py_True;
2334 else
2335 res = Py_False;
2336 Py_INCREF(res);
2337 return res;
2338 }
2339
2340 /* We have an item that differs -- shortcuts for EQ/NE */
2341 if (op == Py_EQ) {
2342 Py_INCREF(Py_False);
2343 return Py_False;
2344 }
2345 if (op == Py_NE) {
2346 Py_INCREF(Py_True);
2347 return Py_True;
2348 }
2349
2350 /* Compare the final item again using the proper operator */
2351 return PyObject_RichCompare(vl->ob_item[i], wl->ob_item[i], op);
2352}
2353
Tim Peters6d6c1a32001-08-02 04:15:00 +00002354static int
2355list_init(PyListObject *self, PyObject *args, PyObject *kw)
2356{
2357 PyObject *arg = NULL;
Martin v. Löwis15e62742006-02-27 16:46:16 +00002358 static char *kwlist[] = {"sequence", 0};
Tim Peters6d6c1a32001-08-02 04:15:00 +00002359
2360 if (!PyArg_ParseTupleAndKeywords(args, kw, "|O:list", kwlist, &arg))
2361 return -1;
Raymond Hettingerc0aaa2d2004-07-29 23:31:29 +00002362
2363 /* Verify list invariants established by PyType_GenericAlloc() */
Armin Rigoa37bbf22004-07-30 11:20:18 +00002364 assert(0 <= self->ob_size);
2365 assert(self->ob_size <= self->allocated || self->allocated == -1);
2366 assert(self->ob_item != NULL ||
2367 self->allocated == 0 || self->allocated == -1);
Raymond Hettingerc0aaa2d2004-07-29 23:31:29 +00002368
Raymond Hettinger90a39bf2004-02-15 03:57:00 +00002369 /* Empty previous contents */
Armin Rigo93677f02004-07-29 12:40:23 +00002370 if (self->ob_item != NULL) {
2371 (void)list_clear(self);
Raymond Hettinger90a39bf2004-02-15 03:57:00 +00002372 }
2373 if (arg != NULL) {
2374 PyObject *rv = listextend(self, arg);
2375 if (rv == NULL)
2376 return -1;
2377 Py_DECREF(rv);
2378 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002379 return 0;
2380}
2381
Guido van Rossumdbb53d92001-12-03 16:32:18 +00002382static long
2383list_nohash(PyObject *self)
2384{
2385 PyErr_SetString(PyExc_TypeError, "list objects are unhashable");
2386 return -1;
2387}
2388
Raymond Hettinger1021c442003-11-07 15:38:09 +00002389static PyObject *list_iter(PyObject *seq);
2390static PyObject *list_reversed(PyListObject* seq, PyObject* unused);
2391
Raymond Hettinger8f5cdaa2003-12-13 11:26:12 +00002392PyDoc_STRVAR(getitem_doc,
2393"x.__getitem__(y) <==> x[y]");
Raymond Hettinger1021c442003-11-07 15:38:09 +00002394PyDoc_STRVAR(reversed_doc,
2395"L.__reversed__() -- return a reverse iterator over the list");
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002396PyDoc_STRVAR(append_doc,
2397"L.append(object) -- append object to end");
2398PyDoc_STRVAR(extend_doc,
Raymond Hettingerf8bcfb12002-12-29 05:49:09 +00002399"L.extend(iterable) -- extend list by appending elements from the iterable");
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002400PyDoc_STRVAR(insert_doc,
2401"L.insert(index, object) -- insert object before index");
2402PyDoc_STRVAR(pop_doc,
2403"L.pop([index]) -> item -- remove and return item at index (default last)");
2404PyDoc_STRVAR(remove_doc,
2405"L.remove(value) -- remove first occurrence of value");
2406PyDoc_STRVAR(index_doc,
Raymond Hettingerd05abde2003-06-17 05:05:49 +00002407"L.index(value, [start, [stop]]) -> integer -- return first index of value");
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002408PyDoc_STRVAR(count_doc,
2409"L.count(value) -> integer -- return number of occurrences of value");
2410PyDoc_STRVAR(reverse_doc,
2411"L.reverse() -- reverse *IN PLACE*");
2412PyDoc_STRVAR(sort_doc,
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00002413"L.sort(cmp=None, key=None, reverse=False) -- stable sort *IN PLACE*;\n\
2414cmp(x, y) -> -1, 0, 1");
Guido van Rossum3dd7f3f1998-06-30 15:36:32 +00002415
Raymond Hettinger8f5cdaa2003-12-13 11:26:12 +00002416static PyObject *list_subscript(PyListObject*, PyObject*);
2417
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002418static PyMethodDef list_methods[] = {
Raymond Hettinger8f5cdaa2003-12-13 11:26:12 +00002419 {"__getitem__", (PyCFunction)list_subscript, METH_O|METH_COEXIST, getitem_doc},
Raymond Hettinger1021c442003-11-07 15:38:09 +00002420 {"__reversed__",(PyCFunction)list_reversed, METH_NOARGS, reversed_doc},
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00002421 {"append", (PyCFunction)listappend, METH_O, append_doc},
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002422 {"insert", (PyCFunction)listinsert, METH_VARARGS, insert_doc},
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00002423 {"extend", (PyCFunction)listextend, METH_O, extend_doc},
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002424 {"pop", (PyCFunction)listpop, METH_VARARGS, pop_doc},
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00002425 {"remove", (PyCFunction)listremove, METH_O, remove_doc},
Raymond Hettingerd05abde2003-06-17 05:05:49 +00002426 {"index", (PyCFunction)listindex, METH_VARARGS, index_doc},
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00002427 {"count", (PyCFunction)listcount, METH_O, count_doc},
2428 {"reverse", (PyCFunction)listreverse, METH_NOARGS, reverse_doc},
Raymond Hettinger42b1ba32003-10-16 03:41:09 +00002429 {"sort", (PyCFunction)listsort, METH_VARARGS | METH_KEYWORDS, sort_doc},
Tim Petersa64dc242002-08-01 02:13:36 +00002430 {NULL, NULL} /* sentinel */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002431};
2432
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002433static PySequenceMethods list_as_sequence = {
Martin v. Löwis18e16552006-02-15 17:27:45 +00002434 (lenfunc)list_length, /* sq_length */
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002435 (binaryfunc)list_concat, /* sq_concat */
Martin v. Löwis18e16552006-02-15 17:27:45 +00002436 (ssizeargfunc)list_repeat, /* sq_repeat */
2437 (ssizeargfunc)list_item, /* sq_item */
2438 (ssizessizeargfunc)list_slice, /* sq_slice */
2439 (ssizeobjargproc)list_ass_item, /* sq_ass_item */
2440 (ssizessizeobjargproc)list_ass_slice, /* sq_ass_slice */
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002441 (objobjproc)list_contains, /* sq_contains */
2442 (binaryfunc)list_inplace_concat, /* sq_inplace_concat */
Martin v. Löwis18e16552006-02-15 17:27:45 +00002443 (ssizeargfunc)list_inplace_repeat, /* sq_inplace_repeat */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002444};
2445
Neal Norwitz2c2e8272002-06-14 02:04:18 +00002446PyDoc_STRVAR(list_doc,
Tim Peters6d6c1a32001-08-02 04:15:00 +00002447"list() -> new list\n"
Neal Norwitz2c2e8272002-06-14 02:04:18 +00002448"list(sequence) -> new list initialized from sequence's items");
Tim Peters6d6c1a32001-08-02 04:15:00 +00002449
Guido van Rossum38fff8c2006-03-07 18:50:55 +00002450
Jeremy Hyltona4b4c3b2002-07-13 03:51:17 +00002451static PyObject *
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002452list_subscript(PyListObject* self, PyObject* item)
2453{
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00002454 if (PyIndex_Check(item)) {
2455 Py_ssize_t i;
2456 i = PyNumber_AsSsize_t(item, PyExc_IndexError);
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002457 if (i == -1 && PyErr_Occurred())
2458 return NULL;
2459 if (i < 0)
2460 i += PyList_GET_SIZE(self);
2461 return list_item(self, i);
2462 }
2463 else if (PySlice_Check(item)) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00002464 Py_ssize_t start, stop, step, slicelength, cur, i;
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002465 PyObject* result;
2466 PyObject* it;
Raymond Hettingera6366fe2004-03-09 13:05:22 +00002467 PyObject **src, **dest;
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002468
2469 if (PySlice_GetIndicesEx((PySliceObject*)item, self->ob_size,
2470 &start, &stop, &step, &slicelength) < 0) {
2471 return NULL;
2472 }
2473
2474 if (slicelength <= 0) {
2475 return PyList_New(0);
2476 }
2477 else {
2478 result = PyList_New(slicelength);
2479 if (!result) return NULL;
2480
Raymond Hettingera6366fe2004-03-09 13:05:22 +00002481 src = self->ob_item;
2482 dest = ((PyListObject *)result)->ob_item;
Tim Peters3b01a122002-07-19 02:35:45 +00002483 for (cur = start, i = 0; i < slicelength;
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002484 cur += step, i++) {
Raymond Hettingera6366fe2004-03-09 13:05:22 +00002485 it = src[cur];
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002486 Py_INCREF(it);
Raymond Hettingera6366fe2004-03-09 13:05:22 +00002487 dest[i] = it;
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002488 }
Tim Peters3b01a122002-07-19 02:35:45 +00002489
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002490 return result;
2491 }
2492 }
2493 else {
2494 PyErr_SetString(PyExc_TypeError,
2495 "list indices must be integers");
2496 return NULL;
2497 }
2498}
2499
Tim Peters3b01a122002-07-19 02:35:45 +00002500static int
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002501list_ass_subscript(PyListObject* self, PyObject* item, PyObject* value)
2502{
Neal Norwitz8a87f5d2006-08-12 17:03:09 +00002503 if (PyIndex_Check(item)) {
2504 Py_ssize_t i = PyNumber_AsSsize_t(item, PyExc_IndexError);
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002505 if (i == -1 && PyErr_Occurred())
2506 return -1;
2507 if (i < 0)
2508 i += PyList_GET_SIZE(self);
2509 return list_ass_item(self, i, value);
2510 }
2511 else if (PySlice_Check(item)) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00002512 Py_ssize_t start, stop, step, slicelength;
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002513
2514 if (PySlice_GetIndicesEx((PySliceObject*)item, self->ob_size,
2515 &start, &stop, &step, &slicelength) < 0) {
2516 return -1;
2517 }
2518
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00002519 /* treat L[slice(a,b)] = v _exactly_ like L[a:b] = v */
2520 if (step == 1 && ((PySliceObject*)item)->step == Py_None)
2521 return list_ass_slice(self, start, stop, value);
2522
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002523 if (value == NULL) {
2524 /* delete slice */
Raymond Hettinger4bb95402004-02-13 11:36:39 +00002525 PyObject **garbage;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002526 Py_ssize_t cur, i;
Tim Peters3b01a122002-07-19 02:35:45 +00002527
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002528 if (slicelength <= 0)
2529 return 0;
2530
2531 if (step < 0) {
2532 stop = start + 1;
2533 start = stop + step*(slicelength - 1) - 1;
2534 step = -step;
2535 }
2536
2537 garbage = (PyObject**)
2538 PyMem_MALLOC(slicelength*sizeof(PyObject*));
Neal Norwitzb88cfad2006-08-12 03:16:54 +00002539 if (!garbage) {
2540 PyErr_NoMemory();
2541 return -1;
2542 }
Tim Peters3b01a122002-07-19 02:35:45 +00002543
2544 /* drawing pictures might help
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002545 understand these for loops */
Guido van Rossum75a20b12002-06-11 12:22:28 +00002546 for (cur = start, i = 0;
2547 cur < stop;
Michael W. Hudson56796f62002-07-29 14:35:04 +00002548 cur += step, i++) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00002549 Py_ssize_t lim = step;
Michael W. Hudson56796f62002-07-29 14:35:04 +00002550
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002551 garbage[i] = PyList_GET_ITEM(self, cur);
2552
Michael W. Hudson56796f62002-07-29 14:35:04 +00002553 if (cur + step >= self->ob_size) {
2554 lim = self->ob_size - cur - 1;
2555 }
2556
Tim Petersb38e2b62004-07-29 02:29:26 +00002557 memmove(self->ob_item + cur - i,
Raymond Hettingera6366fe2004-03-09 13:05:22 +00002558 self->ob_item + cur + 1,
2559 lim * sizeof(PyObject *));
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002560 }
Raymond Hettingera6366fe2004-03-09 13:05:22 +00002561
Michael W. Hudson9c14bad2002-06-19 15:44:15 +00002562 for (cur = start + slicelength*step + 1;
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002563 cur < self->ob_size; cur++) {
2564 PyList_SET_ITEM(self, cur - slicelength,
2565 PyList_GET_ITEM(self, cur));
2566 }
Raymond Hettingera6366fe2004-03-09 13:05:22 +00002567
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002568 self->ob_size -= slicelength;
Raymond Hettingerd4ff7412004-03-15 09:01:31 +00002569 list_resize(self, self->ob_size);
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002570
2571 for (i = 0; i < slicelength; i++) {
2572 Py_DECREF(garbage[i]);
2573 }
2574 PyMem_FREE(garbage);
2575
2576 return 0;
2577 }
2578 else {
2579 /* assign slice */
Raymond Hettingera6366fe2004-03-09 13:05:22 +00002580 PyObject **garbage, *ins, *seq, **seqitems, **selfitems;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002581 Py_ssize_t cur, i;
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002582
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002583 /* protect against a[::-1] = a */
Tim Peters3b01a122002-07-19 02:35:45 +00002584 if (self == (PyListObject*)value) {
Michael W. Hudsona69c0302002-12-05 21:32:32 +00002585 seq = list_slice((PyListObject*)value, 0,
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002586 PyList_GET_SIZE(value));
Tim Peters3b01a122002-07-19 02:35:45 +00002587 }
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002588 else {
Tim Petersb38e2b62004-07-29 02:29:26 +00002589 seq = PySequence_Fast(value,
Raymond Hettingera6366fe2004-03-09 13:05:22 +00002590 "must assign iterable to extended slice");
Michael W. Hudsona69c0302002-12-05 21:32:32 +00002591 }
Neal Norwitzb88cfad2006-08-12 03:16:54 +00002592 if (!seq)
2593 return -1;
Michael W. Hudsona69c0302002-12-05 21:32:32 +00002594
2595 if (PySequence_Fast_GET_SIZE(seq) != slicelength) {
2596 PyErr_Format(PyExc_ValueError,
Martin v. Löwis2c95cc62006-02-16 06:54:25 +00002597 "attempt to assign sequence of size %zd to extended slice of size %zd",
Martin v. Löwise0e89f72006-02-16 06:59:22 +00002598 PySequence_Fast_GET_SIZE(seq),
2599 slicelength);
Michael W. Hudsona69c0302002-12-05 21:32:32 +00002600 Py_DECREF(seq);
2601 return -1;
2602 }
2603
2604 if (!slicelength) {
2605 Py_DECREF(seq);
2606 return 0;
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002607 }
2608
2609 garbage = (PyObject**)
2610 PyMem_MALLOC(slicelength*sizeof(PyObject*));
Tim Peters3b01a122002-07-19 02:35:45 +00002611
Raymond Hettingera6366fe2004-03-09 13:05:22 +00002612 selfitems = self->ob_item;
Raymond Hettinger42bec932004-03-12 16:38:17 +00002613 seqitems = PySequence_Fast_ITEMS(seq);
Tim Peters3b01a122002-07-19 02:35:45 +00002614 for (cur = start, i = 0; i < slicelength;
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002615 cur += step, i++) {
Raymond Hettingera6366fe2004-03-09 13:05:22 +00002616 garbage[i] = selfitems[cur];
2617 ins = seqitems[i];
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002618 Py_INCREF(ins);
Raymond Hettingera6366fe2004-03-09 13:05:22 +00002619 selfitems[cur] = ins;
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002620 }
2621
2622 for (i = 0; i < slicelength; i++) {
2623 Py_DECREF(garbage[i]);
2624 }
Tim Peters3b01a122002-07-19 02:35:45 +00002625
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002626 PyMem_FREE(garbage);
Michael W. Hudsona69c0302002-12-05 21:32:32 +00002627 Py_DECREF(seq);
Tim Peters3b01a122002-07-19 02:35:45 +00002628
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002629 return 0;
2630 }
Tim Peters3b01a122002-07-19 02:35:45 +00002631 }
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002632 else {
Tim Peters3b01a122002-07-19 02:35:45 +00002633 PyErr_SetString(PyExc_TypeError,
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002634 "list indices must be integers");
2635 return -1;
2636 }
2637}
2638
2639static PyMappingMethods list_as_mapping = {
Martin v. Löwis18e16552006-02-15 17:27:45 +00002640 (lenfunc)list_length,
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002641 (binaryfunc)list_subscript,
2642 (objobjargproc)list_ass_subscript
2643};
2644
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002645PyTypeObject PyList_Type = {
2646 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002647 0,
2648 "list",
Neil Schemenauere83c00e2001-08-29 23:54:21 +00002649 sizeof(PyListObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002650 0,
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002651 (destructor)list_dealloc, /* tp_dealloc */
2652 (printfunc)list_print, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002653 0, /* tp_getattr */
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002654 0, /* tp_setattr */
2655 0, /* tp_compare */
2656 (reprfunc)list_repr, /* tp_repr */
2657 0, /* tp_as_number */
2658 &list_as_sequence, /* tp_as_sequence */
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +00002659 &list_as_mapping, /* tp_as_mapping */
Guido van Rossumdbb53d92001-12-03 16:32:18 +00002660 list_nohash, /* tp_hash */
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002661 0, /* tp_call */
2662 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002663 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002664 0, /* tp_setattro */
2665 0, /* tp_as_buffer */
Neil Schemenauere83c00e2001-08-29 23:54:21 +00002666 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
Tim Peters6d6c1a32001-08-02 04:15:00 +00002667 Py_TPFLAGS_BASETYPE, /* tp_flags */
2668 list_doc, /* tp_doc */
Guido van Rossum65e1cea2001-01-17 22:11:59 +00002669 (traverseproc)list_traverse, /* tp_traverse */
2670 (inquiry)list_clear, /* tp_clear */
2671 list_richcompare, /* tp_richcompare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002672 0, /* tp_weaklistoffset */
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002673 list_iter, /* tp_iter */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002674 0, /* tp_iternext */
2675 list_methods, /* tp_methods */
2676 0, /* tp_members */
2677 0, /* tp_getset */
2678 0, /* tp_base */
2679 0, /* tp_dict */
2680 0, /* tp_descr_get */
2681 0, /* tp_descr_set */
2682 0, /* tp_dictoffset */
2683 (initproc)list_init, /* tp_init */
2684 PyType_GenericAlloc, /* tp_alloc */
2685 PyType_GenericNew, /* tp_new */
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002686 PyObject_GC_Del, /* tp_free */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002687};
Guido van Rossum4c4e7df1998-06-16 15:18:28 +00002688
2689
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002690/*********************** List Iterator **************************/
2691
2692typedef struct {
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002693 PyObject_HEAD
2694 long it_index;
Guido van Rossum86103ae2002-07-16 20:07:32 +00002695 PyListObject *it_seq; /* Set to NULL when iterator is exhausted */
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002696} listiterobject;
2697
Anthony Baxter377be112006-04-11 06:54:30 +00002698static PyObject *list_iter(PyObject *);
2699static void listiter_dealloc(listiterobject *);
2700static int listiter_traverse(listiterobject *, visitproc, void *);
2701static PyObject *listiter_next(listiterobject *);
2702static PyObject *listiter_len(listiterobject *);
2703
2704PyDoc_STRVAR(length_hint_doc, "Private method returning an estimate of len(list(it)).");
2705
2706static PyMethodDef listiter_methods[] = {
2707 {"__length_hint__", (PyCFunction)listiter_len, METH_NOARGS, length_hint_doc},
2708 {NULL, NULL} /* sentinel */
2709};
2710
2711PyTypeObject PyListIter_Type = {
2712 PyObject_HEAD_INIT(&PyType_Type)
2713 0, /* ob_size */
2714 "listiterator", /* tp_name */
2715 sizeof(listiterobject), /* tp_basicsize */
2716 0, /* tp_itemsize */
2717 /* methods */
2718 (destructor)listiter_dealloc, /* tp_dealloc */
2719 0, /* tp_print */
2720 0, /* tp_getattr */
2721 0, /* tp_setattr */
2722 0, /* tp_compare */
2723 0, /* tp_repr */
2724 0, /* tp_as_number */
2725 0, /* tp_as_sequence */
2726 0, /* tp_as_mapping */
2727 0, /* tp_hash */
2728 0, /* tp_call */
2729 0, /* tp_str */
2730 PyObject_GenericGetAttr, /* tp_getattro */
2731 0, /* tp_setattro */
2732 0, /* tp_as_buffer */
2733 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
2734 0, /* tp_doc */
2735 (traverseproc)listiter_traverse, /* tp_traverse */
2736 0, /* tp_clear */
2737 0, /* tp_richcompare */
2738 0, /* tp_weaklistoffset */
2739 PyObject_SelfIter, /* tp_iter */
2740 (iternextfunc)listiter_next, /* tp_iternext */
2741 listiter_methods, /* tp_methods */
2742 0, /* tp_members */
2743};
2744
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002745
Guido van Rossum5086e492002-07-16 15:56:52 +00002746static PyObject *
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002747list_iter(PyObject *seq)
2748{
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002749 listiterobject *it;
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002750
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002751 if (!PyList_Check(seq)) {
2752 PyErr_BadInternalCall();
2753 return NULL;
2754 }
2755 it = PyObject_GC_New(listiterobject, &PyListIter_Type);
2756 if (it == NULL)
2757 return NULL;
2758 it->it_index = 0;
2759 Py_INCREF(seq);
2760 it->it_seq = (PyListObject *)seq;
2761 _PyObject_GC_TRACK(it);
2762 return (PyObject *)it;
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002763}
2764
2765static void
2766listiter_dealloc(listiterobject *it)
2767{
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002768 _PyObject_GC_UNTRACK(it);
Guido van Rossum86103ae2002-07-16 20:07:32 +00002769 Py_XDECREF(it->it_seq);
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002770 PyObject_GC_Del(it);
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002771}
2772
2773static int
2774listiter_traverse(listiterobject *it, visitproc visit, void *arg)
2775{
Thomas Woutersc6e55062006-04-15 21:47:09 +00002776 Py_VISIT(it->it_seq);
2777 return 0;
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002778}
2779
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002780static PyObject *
Tim Peters93b2cc42002-06-01 05:22:55 +00002781listiter_next(listiterobject *it)
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002782{
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002783 PyListObject *seq;
2784 PyObject *item;
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002785
Tim Peters93b2cc42002-06-01 05:22:55 +00002786 assert(it != NULL);
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002787 seq = it->it_seq;
Guido van Rossum86103ae2002-07-16 20:07:32 +00002788 if (seq == NULL)
2789 return NULL;
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002790 assert(PyList_Check(seq));
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002791
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002792 if (it->it_index < PyList_GET_SIZE(seq)) {
Tim Peters93b2cc42002-06-01 05:22:55 +00002793 item = PyList_GET_ITEM(seq, it->it_index);
2794 ++it->it_index;
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002795 Py_INCREF(item);
2796 return item;
2797 }
Guido van Rossum86103ae2002-07-16 20:07:32 +00002798
2799 Py_DECREF(seq);
2800 it->it_seq = NULL;
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002801 return NULL;
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002802}
2803
Raymond Hettinger6b27cda2005-09-24 21:23:05 +00002804static PyObject *
Raymond Hettinger435bf582004-03-18 22:43:10 +00002805listiter_len(listiterobject *it)
2806{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002807 Py_ssize_t len;
Raymond Hettinger40a03822004-04-12 13:05:09 +00002808 if (it->it_seq) {
2809 len = PyList_GET_SIZE(it->it_seq) - it->it_index;
2810 if (len >= 0)
Martin v. Löwis18e16552006-02-15 17:27:45 +00002811 return PyInt_FromSsize_t(len);
Raymond Hettinger40a03822004-04-12 13:05:09 +00002812 }
Raymond Hettinger6b27cda2005-09-24 21:23:05 +00002813 return PyInt_FromLong(0);
Raymond Hettinger435bf582004-03-18 22:43:10 +00002814}
Anthony Baxter377be112006-04-11 06:54:30 +00002815/*********************** List Reverse Iterator **************************/
Raymond Hettinger435bf582004-03-18 22:43:10 +00002816
Anthony Baxter377be112006-04-11 06:54:30 +00002817typedef struct {
2818 PyObject_HEAD
2819 Py_ssize_t it_index;
2820 PyListObject *it_seq; /* Set to NULL when iterator is exhausted */
2821} listreviterobject;
Raymond Hettinger6b27cda2005-09-24 21:23:05 +00002822
Anthony Baxter377be112006-04-11 06:54:30 +00002823static PyObject *list_reversed(PyListObject *, PyObject *);
2824static void listreviter_dealloc(listreviterobject *);
2825static int listreviter_traverse(listreviterobject *, visitproc, void *);
2826static PyObject *listreviter_next(listreviterobject *);
2827static Py_ssize_t listreviter_len(listreviterobject *);
2828
2829static PySequenceMethods listreviter_as_sequence = {
2830 (lenfunc)listreviter_len, /* sq_length */
2831 0, /* sq_concat */
Raymond Hettinger435bf582004-03-18 22:43:10 +00002832};
2833
Anthony Baxter377be112006-04-11 06:54:30 +00002834PyTypeObject PyListRevIter_Type = {
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002835 PyObject_HEAD_INIT(&PyType_Type)
2836 0, /* ob_size */
Anthony Baxter377be112006-04-11 06:54:30 +00002837 "listreverseiterator", /* tp_name */
2838 sizeof(listreviterobject), /* tp_basicsize */
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002839 0, /* tp_itemsize */
2840 /* methods */
Anthony Baxter377be112006-04-11 06:54:30 +00002841 (destructor)listreviter_dealloc, /* tp_dealloc */
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002842 0, /* tp_print */
2843 0, /* tp_getattr */
2844 0, /* tp_setattr */
2845 0, /* tp_compare */
2846 0, /* tp_repr */
2847 0, /* tp_as_number */
Anthony Baxter377be112006-04-11 06:54:30 +00002848 &listreviter_as_sequence, /* tp_as_sequence */
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002849 0, /* tp_as_mapping */
2850 0, /* tp_hash */
2851 0, /* tp_call */
2852 0, /* tp_str */
2853 PyObject_GenericGetAttr, /* tp_getattro */
2854 0, /* tp_setattro */
2855 0, /* tp_as_buffer */
2856 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
2857 0, /* tp_doc */
Anthony Baxter377be112006-04-11 06:54:30 +00002858 (traverseproc)listreviter_traverse, /* tp_traverse */
Guido van Rossum6b6272c2002-07-16 20:10:23 +00002859 0, /* tp_clear */
2860 0, /* tp_richcompare */
2861 0, /* tp_weaklistoffset */
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +00002862 PyObject_SelfIter, /* tp_iter */
Anthony Baxter377be112006-04-11 06:54:30 +00002863 (iternextfunc)listreviter_next, /* tp_iternext */
2864 0,
Raymond Hettinger14bd6de2002-05-31 21:40:38 +00002865};
Raymond Hettinger1021c442003-11-07 15:38:09 +00002866
Raymond Hettinger1021c442003-11-07 15:38:09 +00002867static PyObject *
2868list_reversed(PyListObject *seq, PyObject *unused)
2869{
2870 listreviterobject *it;
2871
2872 it = PyObject_GC_New(listreviterobject, &PyListRevIter_Type);
2873 if (it == NULL)
2874 return NULL;
2875 assert(PyList_Check(seq));
2876 it->it_index = PyList_GET_SIZE(seq) - 1;
2877 Py_INCREF(seq);
2878 it->it_seq = seq;
2879 PyObject_GC_Track(it);
2880 return (PyObject *)it;
2881}
2882
2883static void
2884listreviter_dealloc(listreviterobject *it)
2885{
2886 PyObject_GC_UnTrack(it);
2887 Py_XDECREF(it->it_seq);
2888 PyObject_GC_Del(it);
2889}
2890
2891static int
2892listreviter_traverse(listreviterobject *it, visitproc visit, void *arg)
2893{
Thomas Woutersc6e55062006-04-15 21:47:09 +00002894 Py_VISIT(it->it_seq);
2895 return 0;
Raymond Hettinger1021c442003-11-07 15:38:09 +00002896}
2897
2898static PyObject *
2899listreviter_next(listreviterobject *it)
2900{
Raymond Hettingeref9bf402004-03-10 10:10:42 +00002901 PyObject *item;
Martin v. Löwiseb079f12006-02-16 14:32:27 +00002902 Py_ssize_t index = it->it_index;
Raymond Hettingeref9bf402004-03-10 10:10:42 +00002903 PyListObject *seq = it->it_seq;
Raymond Hettinger1021c442003-11-07 15:38:09 +00002904
Raymond Hettingeref9bf402004-03-10 10:10:42 +00002905 if (index>=0 && index < PyList_GET_SIZE(seq)) {
2906 item = PyList_GET_ITEM(seq, index);
Raymond Hettinger1021c442003-11-07 15:38:09 +00002907 it->it_index--;
2908 Py_INCREF(item);
Raymond Hettingeref9bf402004-03-10 10:10:42 +00002909 return item;
Raymond Hettinger1021c442003-11-07 15:38:09 +00002910 }
Raymond Hettingeref9bf402004-03-10 10:10:42 +00002911 it->it_index = -1;
2912 if (seq != NULL) {
2913 it->it_seq = NULL;
2914 Py_DECREF(seq);
2915 }
2916 return NULL;
Raymond Hettinger1021c442003-11-07 15:38:09 +00002917}
2918
Martin v. Löwis18e16552006-02-15 17:27:45 +00002919static Py_ssize_t
Raymond Hettingeref9bf402004-03-10 10:10:42 +00002920listreviter_len(listreviterobject *it)
2921{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002922 Py_ssize_t len = it->it_index + 1;
Raymond Hettinger40a03822004-04-12 13:05:09 +00002923 if (it->it_seq == NULL || PyList_GET_SIZE(it->it_seq) < len)
2924 return 0;
2925 return len;
Raymond Hettingeref9bf402004-03-10 10:10:42 +00002926}
2927