blob: ef5cb8518b3ab105ffd56956dea913565ae6ae32 [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Tuple object implementation */
3
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004#include "Python.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00005
Guido van Rossum5ce78f82000-04-21 21:15:05 +00006/* Speed optimization to avoid frequent malloc/free of small tuples */
Sjoerd Mullender842d2cc1993-10-15 16:18:48 +00007#ifndef MAXSAVESIZE
Guido van Rossum5ce78f82000-04-21 21:15:05 +00008#define MAXSAVESIZE 20 /* Largest tuple to save on free list */
9#endif
10#ifndef MAXSAVEDTUPLES
11#define MAXSAVEDTUPLES 2000 /* Maximum number of tuples of each size to save */
Sjoerd Mullender842d2cc1993-10-15 16:18:48 +000012#endif
13
14#if MAXSAVESIZE > 0
Guido van Rossum5ce78f82000-04-21 21:15:05 +000015/* Entries 1 up to MAXSAVESIZE are free lists, entry 0 is the empty
Sjoerd Mullender842d2cc1993-10-15 16:18:48 +000016 tuple () of which at most one instance will be allocated.
17*/
Guido van Rossumc0b618a1997-05-02 03:12:38 +000018static PyTupleObject *free_tuples[MAXSAVESIZE];
Guido van Rossum5ce78f82000-04-21 21:15:05 +000019static int num_free_tuples[MAXSAVESIZE];
Sjoerd Mullender842d2cc1993-10-15 16:18:48 +000020#endif
21#ifdef COUNT_ALLOCS
22int fast_tuple_allocs;
23int tuple_zero_allocs;
24#endif
25
Guido van Rossumc0b618a1997-05-02 03:12:38 +000026PyObject *
Fred Drakeba096332000-07-09 07:04:36 +000027PyTuple_New(register int size)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000028{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000029 register PyTupleObject *op;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000030 if (size < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +000031 PyErr_BadInternalCall();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000032 return NULL;
33 }
Sjoerd Mullender842d2cc1993-10-15 16:18:48 +000034#if MAXSAVESIZE > 0
Sjoerd Mullender615194a1993-11-01 13:46:50 +000035 if (size == 0 && free_tuples[0]) {
36 op = free_tuples[0];
Guido van Rossumc0b618a1997-05-02 03:12:38 +000037 Py_INCREF(op);
Sjoerd Mullender842d2cc1993-10-15 16:18:48 +000038#ifdef COUNT_ALLOCS
39 tuple_zero_allocs++;
40#endif
Guido van Rossumc0b618a1997-05-02 03:12:38 +000041 return (PyObject *) op;
Sjoerd Mullender842d2cc1993-10-15 16:18:48 +000042 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +000043 if (0 < size && size < MAXSAVESIZE &&
44 (op = free_tuples[size]) != NULL)
45 {
46 free_tuples[size] = (PyTupleObject *) op->ob_item[0];
Guido van Rossum5ce78f82000-04-21 21:15:05 +000047 num_free_tuples[size]--;
Sjoerd Mullender842d2cc1993-10-15 16:18:48 +000048#ifdef COUNT_ALLOCS
49 fast_tuple_allocs++;
50#endif
Guido van Rossume3a8e7e2002-08-19 19:26:42 +000051 /* Inline PyObject_InitVar */
Guido van Rossum68055ce1998-12-11 14:56:38 +000052#ifdef Py_TRACE_REFS
Guido van Rossum68055ce1998-12-11 14:56:38 +000053 op->ob_size = size;
Guido van Rossumb18618d2000-05-03 23:44:39 +000054 op->ob_type = &PyTuple_Type;
Guido van Rossum68055ce1998-12-11 14:56:38 +000055#endif
Guido van Rossumb18618d2000-05-03 23:44:39 +000056 _Py_NewReference((PyObject *)op);
Guido van Rossumfbbd57e1997-08-05 02:16:08 +000057 }
58 else
Sjoerd Mullender842d2cc1993-10-15 16:18:48 +000059#endif
60 {
Guido van Rossum5bc51f21999-07-12 23:06:58 +000061 int nbytes = size * sizeof(PyObject *);
62 /* Check for overflow */
63 if (nbytes / sizeof(PyObject *) != (size_t)size ||
Neil Schemenauere83c00e2001-08-29 23:54:21 +000064 (nbytes += sizeof(PyTupleObject) - sizeof(PyObject *))
Guido van Rossum5bc51f21999-07-12 23:06:58 +000065 <= 0)
66 {
67 return PyErr_NoMemory();
68 }
Neil Schemenauere83c00e2001-08-29 23:54:21 +000069 op = PyObject_GC_NewVar(PyTupleObject, &PyTuple_Type, size);
Sjoerd Mullender842d2cc1993-10-15 16:18:48 +000070 if (op == NULL)
Neil Schemenauere83c00e2001-08-29 23:54:21 +000071 return NULL;
Sjoerd Mullender842d2cc1993-10-15 16:18:48 +000072 }
Neal Norwitz35fc7602002-06-13 21:11:11 +000073 memset(op->ob_item, 0, sizeof(*op->ob_item) * size);
Sjoerd Mullender842d2cc1993-10-15 16:18:48 +000074#if MAXSAVESIZE > 0
75 if (size == 0) {
Sjoerd Mullender615194a1993-11-01 13:46:50 +000076 free_tuples[0] = op;
Guido van Rossum5ce78f82000-04-21 21:15:05 +000077 ++num_free_tuples[0];
Guido van Rossumc0b618a1997-05-02 03:12:38 +000078 Py_INCREF(op); /* extra INCREF so that this is never freed */
Sjoerd Mullender842d2cc1993-10-15 16:18:48 +000079 }
80#endif
Neil Schemenauere83c00e2001-08-29 23:54:21 +000081 _PyObject_GC_TRACK(op);
Guido van Rossumc0b618a1997-05-02 03:12:38 +000082 return (PyObject *) op;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000083}
84
85int
Fred Drakeba096332000-07-09 07:04:36 +000086PyTuple_Size(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000087{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000088 if (!PyTuple_Check(op)) {
89 PyErr_BadInternalCall();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000090 return -1;
91 }
92 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +000093 return ((PyTupleObject *)op)->ob_size;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000094}
95
Guido van Rossumc0b618a1997-05-02 03:12:38 +000096PyObject *
Fred Drakeba096332000-07-09 07:04:36 +000097PyTuple_GetItem(register PyObject *op, register int i)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000098{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000099 if (!PyTuple_Check(op)) {
100 PyErr_BadInternalCall();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000101 return NULL;
102 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000103 if (i < 0 || i >= ((PyTupleObject *)op) -> ob_size) {
104 PyErr_SetString(PyExc_IndexError, "tuple index out of range");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000105 return NULL;
106 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000107 return ((PyTupleObject *)op) -> ob_item[i];
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000108}
109
110int
Fred Drakeba096332000-07-09 07:04:36 +0000111PyTuple_SetItem(register PyObject *op, register int i, PyObject *newitem)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000112{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000113 register PyObject *olditem;
114 register PyObject **p;
Guido van Rossum787bdd31997-08-17 16:25:45 +0000115 if (!PyTuple_Check(op) || op->ob_refcnt != 1) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000116 Py_XDECREF(newitem);
117 PyErr_BadInternalCall();
Guido van Rossum2a9096b1990-10-21 22:15:08 +0000118 return -1;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000119 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000120 if (i < 0 || i >= ((PyTupleObject *)op) -> ob_size) {
121 Py_XDECREF(newitem);
122 PyErr_SetString(PyExc_IndexError,
123 "tuple assignment index out of range");
Guido van Rossum2a9096b1990-10-21 22:15:08 +0000124 return -1;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000125 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000126 p = ((PyTupleObject *)op) -> ob_item + i;
Guido van Rossum5fe60581995-03-09 12:12:50 +0000127 olditem = *p;
128 *p = newitem;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000129 Py_XDECREF(olditem);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000130 return 0;
131}
132
Raymond Hettingercb2da432003-10-12 18:24:34 +0000133PyObject *
134PyTuple_Pack(int n, ...)
135{
136 int i;
137 PyObject *o;
138 PyObject *result;
139 va_list vargs;
140
141 va_start(vargs, n);
142 result = PyTuple_New(n);
143 if (result == NULL)
144 return NULL;
145 for (i = 0; i < n; i++) {
146 o = va_arg(vargs, PyObject *);
147 Py_INCREF(o);
148 PyTuple_SET_ITEM(result, i, o);
149 }
150 va_end(vargs);
151 return result;
152}
153
154
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000155/* Methods */
156
157static void
Fred Drakeba096332000-07-09 07:04:36 +0000158tupledealloc(register PyTupleObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000159{
160 register int i;
Guido van Rossum5ce78f82000-04-21 21:15:05 +0000161 register int len = op->ob_size;
Guido van Rossumff413af2002-03-28 20:34:59 +0000162 PyObject_GC_UnTrack(op);
Guido van Rossumd724b232000-03-13 16:01:29 +0000163 Py_TRASHCAN_SAFE_BEGIN(op)
Guido van Rossum5ce78f82000-04-21 21:15:05 +0000164 if (len > 0) {
165 i = len;
Guido van Rossum1bb26871998-06-26 15:53:50 +0000166 while (--i >= 0)
167 Py_XDECREF(op->ob_item[i]);
Sjoerd Mullender842d2cc1993-10-15 16:18:48 +0000168#if MAXSAVESIZE > 0
Guido van Rossum4b8c0f62001-08-30 18:31:30 +0000169 if (len < MAXSAVESIZE &&
170 num_free_tuples[len] < MAXSAVEDTUPLES &&
171 op->ob_type == &PyTuple_Type)
172 {
Guido van Rossum5ce78f82000-04-21 21:15:05 +0000173 op->ob_item[0] = (PyObject *) free_tuples[len];
174 num_free_tuples[len]++;
175 free_tuples[len] = op;
Guido van Rossumd724b232000-03-13 16:01:29 +0000176 goto done; /* return */
Guido van Rossum1bb26871998-06-26 15:53:50 +0000177 }
Sjoerd Mullender842d2cc1993-10-15 16:18:48 +0000178#endif
Guido van Rossum1bb26871998-06-26 15:53:50 +0000179 }
Guido van Rossum9475a232001-10-05 20:51:39 +0000180 op->ob_type->tp_free((PyObject *)op);
Guido van Rossumd724b232000-03-13 16:01:29 +0000181done:
182 Py_TRASHCAN_SAFE_END(op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000183}
184
Guido van Rossum49e85141991-06-07 22:59:30 +0000185static int
Fred Drakeba096332000-07-09 07:04:36 +0000186tupleprint(PyTupleObject *op, FILE *fp, int flags)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000187{
188 int i;
189 fprintf(fp, "(");
Guido van Rossum49e85141991-06-07 22:59:30 +0000190 for (i = 0; i < op->ob_size; i++) {
191 if (i > 0)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000192 fprintf(fp, ", ");
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000193 if (PyObject_Print(op->ob_item[i], fp, 0) != 0)
Guido van Rossum49e85141991-06-07 22:59:30 +0000194 return -1;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000195 }
196 if (op->ob_size == 1)
197 fprintf(fp, ",");
198 fprintf(fp, ")");
Guido van Rossum49e85141991-06-07 22:59:30 +0000199 return 0;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000200}
201
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000202static PyObject *
Fred Drakeba096332000-07-09 07:04:36 +0000203tuplerepr(PyTupleObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000204{
Tim Petersa7259592001-06-16 05:11:17 +0000205 int i, n;
206 PyObject *s, *temp;
207 PyObject *pieces, *result = NULL;
208
209 n = v->ob_size;
210 if (n == 0)
211 return PyString_FromString("()");
212
213 pieces = PyTuple_New(n);
214 if (pieces == NULL)
215 return NULL;
216
217 /* Do repr() on each element. */
218 for (i = 0; i < n; ++i) {
219 s = PyObject_Repr(v->ob_item[i]);
220 if (s == NULL)
221 goto Done;
222 PyTuple_SET_ITEM(pieces, i, s);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000223 }
Tim Petersa7259592001-06-16 05:11:17 +0000224
225 /* Add "()" decorations to the first and last items. */
226 assert(n > 0);
227 s = PyString_FromString("(");
228 if (s == NULL)
229 goto Done;
230 temp = PyTuple_GET_ITEM(pieces, 0);
231 PyString_ConcatAndDel(&s, temp);
232 PyTuple_SET_ITEM(pieces, 0, s);
233 if (s == NULL)
234 goto Done;
235
236 s = PyString_FromString(n == 1 ? ",)" : ")");
237 if (s == NULL)
238 goto Done;
239 temp = PyTuple_GET_ITEM(pieces, n-1);
240 PyString_ConcatAndDel(&temp, s);
241 PyTuple_SET_ITEM(pieces, n-1, temp);
242 if (temp == NULL)
243 goto Done;
244
245 /* Paste them all together with ", " between. */
246 s = PyString_FromString(", ");
247 if (s == NULL)
248 goto Done;
249 result = _PyString_Join(s, pieces);
250 Py_DECREF(s);
251
252Done:
253 Py_DECREF(pieces);
254 return result;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000255}
256
Guido van Rossum9bfef441993-03-29 10:43:31 +0000257static long
Fred Drakeba096332000-07-09 07:04:36 +0000258tuplehash(PyTupleObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000259{
260 register long x, y;
261 register int len = v->ob_size;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000262 register PyObject **p;
Guido van Rossum9bfef441993-03-29 10:43:31 +0000263 x = 0x345678L;
264 p = v->ob_item;
265 while (--len >= 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000266 y = PyObject_Hash(*p++);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000267 if (y == -1)
268 return -1;
Guido van Rossum0969ad21996-12-16 17:55:46 +0000269 x = (1000003*x) ^ y;
Guido van Rossum9bfef441993-03-29 10:43:31 +0000270 }
271 x ^= v->ob_size;
272 if (x == -1)
273 x = -2;
274 return x;
275}
276
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000277static int
Fred Drakeba096332000-07-09 07:04:36 +0000278tuplelength(PyTupleObject *a)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000279{
280 return a->ob_size;
281}
282
Jeremy Hylton37b1a262000-04-27 21:41:03 +0000283static int
Fred Drakeba096332000-07-09 07:04:36 +0000284tuplecontains(PyTupleObject *a, PyObject *el)
Jeremy Hylton37b1a262000-04-27 21:41:03 +0000285{
286 int i, cmp;
287
Raymond Hettingerbd9adab2002-09-05 20:18:08 +0000288 for (i = 0, cmp = 0 ; cmp == 0 && i < a->ob_size; ++i)
Guido van Rossumf77bc622001-01-18 00:00:53 +0000289 cmp = PyObject_RichCompareBool(el, PyTuple_GET_ITEM(a, i),
Raymond Hettingerbd9adab2002-09-05 20:18:08 +0000290 Py_EQ);
Neal Norwitzbb9c5f52002-09-05 21:32:55 +0000291 return cmp;
Jeremy Hylton37b1a262000-04-27 21:41:03 +0000292}
293
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000294static PyObject *
Fred Drakeba096332000-07-09 07:04:36 +0000295tupleitem(register PyTupleObject *a, register int i)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000296{
297 if (i < 0 || i >= a->ob_size) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000298 PyErr_SetString(PyExc_IndexError, "tuple index out of range");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000299 return NULL;
300 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000301 Py_INCREF(a->ob_item[i]);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000302 return a->ob_item[i];
303}
304
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000305static PyObject *
Fred Drakeba096332000-07-09 07:04:36 +0000306tupleslice(register PyTupleObject *a, register int ilow, register int ihigh)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000307{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000308 register PyTupleObject *np;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000309 register int i;
310 if (ilow < 0)
311 ilow = 0;
312 if (ihigh > a->ob_size)
313 ihigh = a->ob_size;
314 if (ihigh < ilow)
315 ihigh = ilow;
Tim Peters7b07a412001-09-11 19:48:03 +0000316 if (ilow == 0 && ihigh == a->ob_size && PyTuple_CheckExact(a)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000317 Py_INCREF(a);
318 return (PyObject *)a;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000319 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000320 np = (PyTupleObject *)PyTuple_New(ihigh - ilow);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000321 if (np == NULL)
322 return NULL;
323 for (i = ilow; i < ihigh; i++) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000324 PyObject *v = a->ob_item[i];
325 Py_INCREF(v);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000326 np->ob_item[i - ilow] = v;
327 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000328 return (PyObject *)np;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000329}
330
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000331PyObject *
Fred Drakeba096332000-07-09 07:04:36 +0000332PyTuple_GetSlice(PyObject *op, int i, int j)
Guido van Rossum7c36ad71992-01-14 18:45:33 +0000333{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000334 if (op == NULL || !PyTuple_Check(op)) {
335 PyErr_BadInternalCall();
Guido van Rossum7c36ad71992-01-14 18:45:33 +0000336 return NULL;
337 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000338 return tupleslice((PyTupleObject *)op, i, j);
Guido van Rossum7c36ad71992-01-14 18:45:33 +0000339}
340
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000341static PyObject *
Fred Drakeba096332000-07-09 07:04:36 +0000342tupleconcat(register PyTupleObject *a, register PyObject *bb)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000343{
344 register int size;
345 register int i;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000346 PyTupleObject *np;
347 if (!PyTuple_Check(bb)) {
Fred Drakeb6a9ada2000-06-01 03:12:13 +0000348 PyErr_Format(PyExc_TypeError,
Marc-André Lemburg29dc3812000-06-16 17:05:57 +0000349 "can only concatenate tuple (not \"%.200s\") to tuple",
Fred Drakeb6a9ada2000-06-01 03:12:13 +0000350 bb->ob_type->tp_name);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000351 return NULL;
352 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000353#define b ((PyTupleObject *)bb)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000354 size = a->ob_size + b->ob_size;
Guido van Rossuma5c0e6d2002-10-11 21:05:56 +0000355 if (size < 0)
356 return PyErr_NoMemory();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000357 np = (PyTupleObject *) PyTuple_New(size);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000358 if (np == NULL) {
Guido van Rossum49e85141991-06-07 22:59:30 +0000359 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000360 }
361 for (i = 0; i < a->ob_size; i++) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000362 PyObject *v = a->ob_item[i];
363 Py_INCREF(v);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000364 np->ob_item[i] = v;
365 }
366 for (i = 0; i < b->ob_size; i++) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000367 PyObject *v = b->ob_item[i];
368 Py_INCREF(v);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000369 np->ob_item[i + a->ob_size] = v;
370 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000371 return (PyObject *)np;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000372#undef b
373}
374
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000375static PyObject *
Fred Drakeba096332000-07-09 07:04:36 +0000376tuplerepeat(PyTupleObject *a, int n)
Guido van Rossumb8393da1991-06-04 19:35:24 +0000377{
378 int i, j;
379 int size;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000380 PyTupleObject *np;
381 PyObject **p;
Guido van Rossumb8393da1991-06-04 19:35:24 +0000382 if (n < 0)
383 n = 0;
Guido van Rossum5bc51f21999-07-12 23:06:58 +0000384 if (a->ob_size == 0 || n == 1) {
Tim Peters7b07a412001-09-11 19:48:03 +0000385 if (PyTuple_CheckExact(a)) {
386 /* Since tuples are immutable, we can return a shared
387 copy in this case */
388 Py_INCREF(a);
389 return (PyObject *)a;
390 }
391 if (a->ob_size == 0)
392 return PyTuple_New(0);
Guido van Rossumb8393da1991-06-04 19:35:24 +0000393 }
394 size = a->ob_size * n;
Guido van Rossum0eb55ac1999-07-13 05:41:12 +0000395 if (size/a->ob_size != n)
Guido van Rossum5bc51f21999-07-12 23:06:58 +0000396 return PyErr_NoMemory();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000397 np = (PyTupleObject *) PyTuple_New(size);
Guido van Rossumb8393da1991-06-04 19:35:24 +0000398 if (np == NULL)
399 return NULL;
400 p = np->ob_item;
401 for (i = 0; i < n; i++) {
402 for (j = 0; j < a->ob_size; j++) {
403 *p = a->ob_item[j];
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000404 Py_INCREF(*p);
Guido van Rossumb8393da1991-06-04 19:35:24 +0000405 p++;
406 }
407 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000408 return (PyObject *) np;
Guido van Rossumb8393da1991-06-04 19:35:24 +0000409}
410
Jeremy Hylton8caad492000-06-23 14:18:11 +0000411static int
412tupletraverse(PyTupleObject *o, visitproc visit, void *arg)
413{
414 int i, err;
415 PyObject *x;
416
417 for (i = o->ob_size; --i >= 0; ) {
418 x = o->ob_item[i];
419 if (x != NULL) {
420 err = visit(x, arg);
421 if (err)
422 return err;
423 }
424 }
425 return 0;
426}
427
Guido van Rossumf77bc622001-01-18 00:00:53 +0000428static PyObject *
429tuplerichcompare(PyObject *v, PyObject *w, int op)
430{
431 PyTupleObject *vt, *wt;
432 int i;
Tim Petersd7ed3bf2001-05-15 20:12:59 +0000433 int vlen, wlen;
Guido van Rossumf77bc622001-01-18 00:00:53 +0000434
435 if (!PyTuple_Check(v) || !PyTuple_Check(w)) {
436 Py_INCREF(Py_NotImplemented);
437 return Py_NotImplemented;
438 }
439
440 vt = (PyTupleObject *)v;
441 wt = (PyTupleObject *)w;
442
Tim Petersd7ed3bf2001-05-15 20:12:59 +0000443 vlen = vt->ob_size;
444 wlen = wt->ob_size;
Guido van Rossumf77bc622001-01-18 00:00:53 +0000445
Tim Petersd7ed3bf2001-05-15 20:12:59 +0000446 /* Note: the corresponding code for lists has an "early out" test
447 * here when op is EQ or NE and the lengths differ. That pays there,
448 * but Tim was unable to find any real code where EQ/NE tuple
449 * compares don't have the same length, so testing for it here would
450 * have cost without benefit.
451 */
452
453 /* Search for the first index where items are different.
454 * Note that because tuples are immutable, it's safe to reuse
455 * vlen and wlen across the comparison calls.
456 */
457 for (i = 0; i < vlen && i < wlen; i++) {
Guido van Rossumf77bc622001-01-18 00:00:53 +0000458 int k = PyObject_RichCompareBool(vt->ob_item[i],
459 wt->ob_item[i], Py_EQ);
460 if (k < 0)
461 return NULL;
462 if (!k)
463 break;
464 }
465
Tim Petersd7ed3bf2001-05-15 20:12:59 +0000466 if (i >= vlen || i >= wlen) {
Guido van Rossumf77bc622001-01-18 00:00:53 +0000467 /* No more items to compare -- compare sizes */
Guido van Rossumf77bc622001-01-18 00:00:53 +0000468 int cmp;
469 PyObject *res;
470 switch (op) {
Tim Petersd7ed3bf2001-05-15 20:12:59 +0000471 case Py_LT: cmp = vlen < wlen; break;
472 case Py_LE: cmp = vlen <= wlen; break;
473 case Py_EQ: cmp = vlen == wlen; break;
474 case Py_NE: cmp = vlen != wlen; break;
475 case Py_GT: cmp = vlen > wlen; break;
476 case Py_GE: cmp = vlen >= wlen; break;
Guido van Rossumf77bc622001-01-18 00:00:53 +0000477 default: return NULL; /* cannot happen */
478 }
479 if (cmp)
480 res = Py_True;
481 else
482 res = Py_False;
483 Py_INCREF(res);
484 return res;
485 }
486
487 /* We have an item that differs -- shortcuts for EQ/NE */
488 if (op == Py_EQ) {
489 Py_INCREF(Py_False);
490 return Py_False;
491 }
492 if (op == Py_NE) {
493 Py_INCREF(Py_True);
494 return Py_True;
495 }
496
497 /* Compare the final item again using the proper operator */
498 return PyObject_RichCompare(vt->ob_item[i], wt->ob_item[i], op);
499}
500
Jeremy Hylton938ace62002-07-17 16:30:39 +0000501static PyObject *
Guido van Rossumae960af2001-08-30 03:11:59 +0000502tuple_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
503
Tim Peters6d6c1a32001-08-02 04:15:00 +0000504static PyObject *
505tuple_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
506{
507 PyObject *arg = NULL;
508 static char *kwlist[] = {"sequence", 0};
509
Guido van Rossumae960af2001-08-30 03:11:59 +0000510 if (type != &PyTuple_Type)
511 return tuple_subtype_new(type, args, kwds);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000512 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|O:tuple", kwlist, &arg))
513 return NULL;
514
515 if (arg == NULL)
516 return PyTuple_New(0);
517 else
518 return PySequence_Tuple(arg);
519}
520
Guido van Rossumae960af2001-08-30 03:11:59 +0000521static PyObject *
522tuple_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
523{
524 PyObject *tmp, *new, *item;
525 int i, n;
526
527 assert(PyType_IsSubtype(type, &PyTuple_Type));
528 tmp = tuple_new(&PyTuple_Type, args, kwds);
529 if (tmp == NULL)
530 return NULL;
531 assert(PyTuple_Check(tmp));
532 new = type->tp_alloc(type, n = PyTuple_GET_SIZE(tmp));
533 if (new == NULL)
534 return NULL;
535 for (i = 0; i < n; i++) {
536 item = PyTuple_GET_ITEM(tmp, i);
537 Py_INCREF(item);
538 PyTuple_SET_ITEM(new, i, item);
539 }
540 Py_DECREF(tmp);
541 return new;
542}
543
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000544PyDoc_STRVAR(tuple_doc,
Tim Peters1b8ca0d2001-09-02 06:42:25 +0000545"tuple() -> an empty tuple\n"
546"tuple(sequence) -> tuple initialized from sequence's items\n"
547"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000548"If the argument is a tuple, the return value is the same object.");
Tim Peters6d6c1a32001-08-02 04:15:00 +0000549
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000550static PySequenceMethods tuple_as_sequence = {
Guido van Rossumf77bc622001-01-18 00:00:53 +0000551 (inquiry)tuplelength, /* sq_length */
552 (binaryfunc)tupleconcat, /* sq_concat */
553 (intargfunc)tuplerepeat, /* sq_repeat */
554 (intargfunc)tupleitem, /* sq_item */
555 (intintargfunc)tupleslice, /* sq_slice */
556 0, /* sq_ass_item */
557 0, /* sq_ass_slice */
558 (objobjproc)tuplecontains, /* sq_contains */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000559};
560
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +0000561static PyObject*
562tuplesubscript(PyTupleObject* self, PyObject* item)
563{
564 if (PyInt_Check(item)) {
565 long i = PyInt_AS_LONG(item);
566 if (i < 0)
567 i += PyTuple_GET_SIZE(self);
568 return tupleitem(self, i);
569 }
570 else if (PyLong_Check(item)) {
571 long i = PyLong_AsLong(item);
572 if (i == -1 && PyErr_Occurred())
573 return NULL;
574 if (i < 0)
575 i += PyTuple_GET_SIZE(self);
576 return tupleitem(self, i);
577 }
578 else if (PySlice_Check(item)) {
579 int start, stop, step, slicelength, cur, i;
580 PyObject* result;
581 PyObject* it;
582
583 if (PySlice_GetIndicesEx((PySliceObject*)item,
584 PyTuple_GET_SIZE(self),
585 &start, &stop, &step, &slicelength) < 0) {
586 return NULL;
587 }
588
589 if (slicelength <= 0) {
590 return PyTuple_New(0);
591 }
592 else {
593 result = PyTuple_New(slicelength);
594
595 for (cur = start, i = 0; i < slicelength;
596 cur += step, i++) {
597 it = PyTuple_GET_ITEM(self, cur);
598 Py_INCREF(it);
599 PyTuple_SET_ITEM(result, i, it);
600 }
601
602 return result;
603 }
604 }
605 else {
606 PyErr_SetString(PyExc_TypeError,
607 "tuple indices must be integers");
608 return NULL;
609 }
610}
611
Guido van Rossum5d9113d2003-01-29 17:58:45 +0000612static PyObject *
613tuple_getnewargs(PyTupleObject *v)
614{
615 return Py_BuildValue("(N)", tupleslice(v, 0, v->ob_size));
616
617}
618
619static PyMethodDef tuple_methods[] = {
620 {"__getnewargs__", (PyCFunction)tuple_getnewargs, METH_NOARGS},
621 {NULL, NULL} /* sentinel */
622};
623
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +0000624static PyMappingMethods tuple_as_mapping = {
625 (inquiry)tuplelength,
626 (binaryfunc)tuplesubscript,
627 0
628};
629
Raymond Hettinger48923c52002-08-09 01:30:17 +0000630static PyObject *tuple_iter(PyObject *seq);
631
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000632PyTypeObject PyTuple_Type = {
633 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000634 0,
635 "tuple",
Neil Schemenauere83c00e2001-08-29 23:54:21 +0000636 sizeof(PyTupleObject) - sizeof(PyObject *),
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000637 sizeof(PyObject *),
Guido van Rossumf77bc622001-01-18 00:00:53 +0000638 (destructor)tupledealloc, /* tp_dealloc */
639 (printfunc)tupleprint, /* tp_print */
640 0, /* tp_getattr */
641 0, /* tp_setattr */
642 0, /* tp_compare */
643 (reprfunc)tuplerepr, /* tp_repr */
644 0, /* tp_as_number */
645 &tuple_as_sequence, /* tp_as_sequence */
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +0000646 &tuple_as_mapping, /* tp_as_mapping */
Guido van Rossumf77bc622001-01-18 00:00:53 +0000647 (hashfunc)tuplehash, /* tp_hash */
648 0, /* tp_call */
649 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000650 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossumf77bc622001-01-18 00:00:53 +0000651 0, /* tp_setattro */
652 0, /* tp_as_buffer */
Guido van Rossumae960af2001-08-30 03:11:59 +0000653 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
654 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000655 tuple_doc, /* tp_doc */
Guido van Rossumf77bc622001-01-18 00:00:53 +0000656 (traverseproc)tupletraverse, /* tp_traverse */
657 0, /* tp_clear */
658 tuplerichcompare, /* tp_richcompare */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000659 0, /* tp_weaklistoffset */
Raymond Hettinger48923c52002-08-09 01:30:17 +0000660 tuple_iter, /* tp_iter */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000661 0, /* tp_iternext */
Guido van Rossum5d9113d2003-01-29 17:58:45 +0000662 tuple_methods, /* tp_methods */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000663 0, /* tp_members */
664 0, /* tp_getset */
665 0, /* tp_base */
666 0, /* tp_dict */
667 0, /* tp_descr_get */
668 0, /* tp_descr_set */
669 0, /* tp_dictoffset */
670 0, /* tp_init */
671 0, /* tp_alloc */
672 tuple_new, /* tp_new */
Neil Schemenauer626d7742002-04-12 03:05:52 +0000673 PyObject_GC_Del, /* tp_free */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000674};
Guido van Rossum12d12c51993-10-26 17:58:25 +0000675
676/* The following function breaks the notion that tuples are immutable:
677 it changes the size of a tuple. We get away with this only if there
678 is only one module referencing the object. You can also think of it
Neil Schemenauer08b53e62000-10-05 19:36:49 +0000679 as creating a new tuple object and destroying the old one, only more
680 efficiently. In any case, don't use this if the tuple may already be
Tim Peters4324aa32001-05-28 22:30:08 +0000681 known to some other part of the code. */
Guido van Rossum12d12c51993-10-26 17:58:25 +0000682
683int
Tim Peters4324aa32001-05-28 22:30:08 +0000684_PyTuple_Resize(PyObject **pv, int newsize)
Guido van Rossum12d12c51993-10-26 17:58:25 +0000685{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000686 register PyTupleObject *v;
687 register PyTupleObject *sv;
Sjoerd Mullender615194a1993-11-01 13:46:50 +0000688 int i;
Guido van Rossumf70590f2001-12-07 20:00:04 +0000689 int oldsize;
Sjoerd Mullender615194a1993-11-01 13:46:50 +0000690
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000691 v = (PyTupleObject *) *pv;
Guido van Rossum4b8c0f62001-08-30 18:31:30 +0000692 if (v == NULL || v->ob_type != &PyTuple_Type ||
Thomas Wouters6a922372001-05-28 13:11:02 +0000693 (v->ob_size != 0 && v->ob_refcnt != 1)) {
Guido van Rossum12d12c51993-10-26 17:58:25 +0000694 *pv = 0;
Neil Schemenauer08b53e62000-10-05 19:36:49 +0000695 Py_XDECREF(v);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000696 PyErr_BadInternalCall();
Guido van Rossum12d12c51993-10-26 17:58:25 +0000697 return -1;
698 }
Guido van Rossumf70590f2001-12-07 20:00:04 +0000699 oldsize = v->ob_size;
700 if (oldsize == newsize)
Sjoerd Mullender615194a1993-11-01 13:46:50 +0000701 return 0;
Neil Schemenauer08b53e62000-10-05 19:36:49 +0000702
Guido van Rossumf70590f2001-12-07 20:00:04 +0000703 if (oldsize == 0) {
Thomas Wouters6a922372001-05-28 13:11:02 +0000704 /* Empty tuples are often shared, so we should never
705 resize them in-place even if we do own the only
706 (current) reference */
707 Py_DECREF(v);
708 *pv = PyTuple_New(newsize);
Thomas Wouters0dcea592001-05-29 07:58:45 +0000709 return *pv == NULL ? -1 : 0;
Thomas Wouters6a922372001-05-28 13:11:02 +0000710 }
711
Guido van Rossum12d12c51993-10-26 17:58:25 +0000712 /* XXX UNREF/NEWREF interface should be more symmetrical */
Tim Peters34592512002-07-11 06:23:50 +0000713 _Py_DEC_REFTOTAL;
Neil Schemenauere83c00e2001-08-29 23:54:21 +0000714 _PyObject_GC_UNTRACK(v);
Neil Schemenauer08b53e62000-10-05 19:36:49 +0000715 _Py_ForgetReference((PyObject *) v);
Guido van Rossumf70590f2001-12-07 20:00:04 +0000716 /* DECREF items deleted by shrinkage */
717 for (i = newsize; i < oldsize; i++) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000718 Py_XDECREF(v->ob_item[i]);
Sjoerd Mullender615194a1993-11-01 13:46:50 +0000719 v->ob_item[i] = NULL;
720 }
Neil Schemenauere83c00e2001-08-29 23:54:21 +0000721 sv = PyObject_GC_Resize(PyTupleObject, v, newsize);
Neil Schemenauer08b53e62000-10-05 19:36:49 +0000722 if (sv == NULL) {
723 *pv = NULL;
Neil Schemenauere83c00e2001-08-29 23:54:21 +0000724 PyObject_GC_Del(v);
Neil Schemenauer08b53e62000-10-05 19:36:49 +0000725 return -1;
Guido van Rossum5ce78f82000-04-21 21:15:05 +0000726 }
Neil Schemenauer08b53e62000-10-05 19:36:49 +0000727 _Py_NewReference((PyObject *) sv);
Guido van Rossumf70590f2001-12-07 20:00:04 +0000728 /* Zero out items added by growing */
Neal Norwitz35fc7602002-06-13 21:11:11 +0000729 if (newsize > oldsize)
Jeremy Hylton8b47dff2002-06-20 23:13:17 +0000730 memset(&sv->ob_item[oldsize], 0,
731 sizeof(*sv->ob_item) * (newsize - oldsize));
Neil Schemenauer08b53e62000-10-05 19:36:49 +0000732 *pv = (PyObject *) sv;
Neil Schemenauere83c00e2001-08-29 23:54:21 +0000733 _PyObject_GC_TRACK(sv);
Guido van Rossum12d12c51993-10-26 17:58:25 +0000734 return 0;
735}
Guido van Rossumfbbd57e1997-08-05 02:16:08 +0000736
737void
Fred Drakeba096332000-07-09 07:04:36 +0000738PyTuple_Fini(void)
Guido van Rossumfbbd57e1997-08-05 02:16:08 +0000739{
740#if MAXSAVESIZE > 0
741 int i;
742
743 Py_XDECREF(free_tuples[0]);
744 free_tuples[0] = NULL;
745
746 for (i = 1; i < MAXSAVESIZE; i++) {
747 PyTupleObject *p, *q;
748 p = free_tuples[i];
749 free_tuples[i] = NULL;
750 while (p) {
751 q = p;
752 p = (PyTupleObject *)(p->ob_item[0]);
Neil Schemenauere83c00e2001-08-29 23:54:21 +0000753 PyObject_GC_Del(q);
Guido van Rossumfbbd57e1997-08-05 02:16:08 +0000754 }
755 }
756#endif
757}
Raymond Hettinger48923c52002-08-09 01:30:17 +0000758
759/*********************** Tuple Iterator **************************/
760
761typedef struct {
762 PyObject_HEAD
763 long it_index;
764 PyTupleObject *it_seq; /* Set to NULL when iterator is exhausted */
765} tupleiterobject;
766
767PyTypeObject PyTupleIter_Type;
768
769static PyObject *
770tuple_iter(PyObject *seq)
771{
772 tupleiterobject *it;
773
774 if (!PyTuple_Check(seq)) {
775 PyErr_BadInternalCall();
776 return NULL;
777 }
778 it = PyObject_GC_New(tupleiterobject, &PyTupleIter_Type);
779 if (it == NULL)
780 return NULL;
781 it->it_index = 0;
782 Py_INCREF(seq);
783 it->it_seq = (PyTupleObject *)seq;
784 _PyObject_GC_TRACK(it);
785 return (PyObject *)it;
786}
787
788static void
789tupleiter_dealloc(tupleiterobject *it)
790{
791 _PyObject_GC_UNTRACK(it);
792 Py_XDECREF(it->it_seq);
793 PyObject_GC_Del(it);
794}
795
796static int
797tupleiter_traverse(tupleiterobject *it, visitproc visit, void *arg)
798{
799 if (it->it_seq == NULL)
800 return 0;
801 return visit((PyObject *)it->it_seq, arg);
802}
803
Raymond Hettinger48923c52002-08-09 01:30:17 +0000804static PyObject *
805tupleiter_next(tupleiterobject *it)
806{
807 PyTupleObject *seq;
808 PyObject *item;
809
810 assert(it != NULL);
811 seq = it->it_seq;
812 if (seq == NULL)
813 return NULL;
814 assert(PyTuple_Check(seq));
815
816 if (it->it_index < PyTuple_GET_SIZE(seq)) {
817 item = PyTuple_GET_ITEM(seq, it->it_index);
818 ++it->it_index;
819 Py_INCREF(item);
820 return item;
821 }
822
823 Py_DECREF(seq);
824 it->it_seq = NULL;
825 return NULL;
826}
827
828PyTypeObject PyTupleIter_Type = {
829 PyObject_HEAD_INIT(&PyType_Type)
830 0, /* ob_size */
831 "tupleiterator", /* tp_name */
832 sizeof(tupleiterobject), /* tp_basicsize */
833 0, /* tp_itemsize */
834 /* methods */
835 (destructor)tupleiter_dealloc, /* tp_dealloc */
836 0, /* tp_print */
837 0, /* tp_getattr */
838 0, /* tp_setattr */
839 0, /* tp_compare */
840 0, /* tp_repr */
841 0, /* tp_as_number */
842 0, /* tp_as_sequence */
843 0, /* tp_as_mapping */
844 0, /* tp_hash */
845 0, /* tp_call */
846 0, /* tp_str */
847 PyObject_GenericGetAttr, /* tp_getattro */
848 0, /* tp_setattro */
849 0, /* tp_as_buffer */
850 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
851 0, /* tp_doc */
852 (traverseproc)tupleiter_traverse, /* tp_traverse */
853 0, /* tp_clear */
854 0, /* tp_richcompare */
855 0, /* tp_weaklistoffset */
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000856 PyObject_SelfIter, /* tp_iter */
Raymond Hettinger48923c52002-08-09 01:30:17 +0000857 (iternextfunc)tupleiter_next, /* tp_iternext */
858};