blob: 206bb88d5f8230a94b8ad6f0430f97ae53793996 [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum3f5da241990-12-20 15:06:42 +00002/* Generic object operations; and implementation of None (NoObject) */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004#include "Python.h"
Guido van Rossum50e9fb92006-08-17 05:42:55 +00005#include "sliceobject.h" /* For PyEllipsis_Type */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00006
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007#ifdef __cplusplus
8extern "C" {
9#endif
10
Tim Peters34592512002-07-11 06:23:50 +000011#ifdef Py_REF_DEBUG
Neal Norwitz84632ee2006-03-04 20:00:59 +000012Py_ssize_t _Py_RefTotal;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000013
14Py_ssize_t
15_Py_GetRefTotal(void)
16{
17 PyObject *o;
18 Py_ssize_t total = _Py_RefTotal;
19 /* ignore the references to the dummy object of the dicts and sets
20 because they are not reliable and not useful (now that the
21 hash table code is well-tested) */
22 o = _PyDict_Dummy();
23 if (o != NULL)
24 total -= o->ob_refcnt;
25 o = _PySet_Dummy();
26 if (o != NULL)
27 total -= o->ob_refcnt;
28 return total;
29}
30#endif /* Py_REF_DEBUG */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000031
Mark Hammonda2905272002-07-29 13:42:14 +000032int Py_DivisionWarningFlag;
Guido van Rossum393661d2001-08-31 17:40:15 +000033
Guido van Rossum3f5da241990-12-20 15:06:42 +000034/* Object allocation routines used by NEWOBJ and NEWVAROBJ macros.
35 These are used by the individual routines for object creation.
36 Do not call them otherwise, they do not initialize the object! */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000037
Tim Peters78be7992003-03-23 02:51:01 +000038#ifdef Py_TRACE_REFS
Tim Peters7571a0f2003-03-23 17:52:28 +000039/* Head of circular doubly-linked list of all objects. These are linked
40 * together via the _ob_prev and _ob_next members of a PyObject, which
41 * exist only in a Py_TRACE_REFS build.
42 */
Tim Peters78be7992003-03-23 02:51:01 +000043static PyObject refchain = {&refchain, &refchain};
Tim Peters36eb4df2003-03-23 03:33:13 +000044
Tim Peters7571a0f2003-03-23 17:52:28 +000045/* Insert op at the front of the list of all objects. If force is true,
46 * op is added even if _ob_prev and _ob_next are non-NULL already. If
47 * force is false amd _ob_prev or _ob_next are non-NULL, do nothing.
48 * force should be true if and only if op points to freshly allocated,
49 * uninitialized memory, or you've unlinked op from the list and are
Tim Peters51f8d382003-03-23 18:06:08 +000050 * relinking it into the front.
Tim Peters7571a0f2003-03-23 17:52:28 +000051 * Note that objects are normally added to the list via _Py_NewReference,
52 * which is called by PyObject_Init. Not all objects are initialized that
53 * way, though; exceptions include statically allocated type objects, and
54 * statically allocated singletons (like Py_True and Py_None).
55 */
Tim Peters36eb4df2003-03-23 03:33:13 +000056void
Tim Peters7571a0f2003-03-23 17:52:28 +000057_Py_AddToAllObjects(PyObject *op, int force)
Tim Peters36eb4df2003-03-23 03:33:13 +000058{
Tim Peters7571a0f2003-03-23 17:52:28 +000059#ifdef Py_DEBUG
60 if (!force) {
61 /* If it's initialized memory, op must be in or out of
62 * the list unambiguously.
63 */
64 assert((op->_ob_prev == NULL) == (op->_ob_next == NULL));
65 }
Tim Peters78be7992003-03-23 02:51:01 +000066#endif
Tim Peters7571a0f2003-03-23 17:52:28 +000067 if (force || op->_ob_prev == NULL) {
68 op->_ob_next = refchain._ob_next;
69 op->_ob_prev = &refchain;
70 refchain._ob_next->_ob_prev = op;
71 refchain._ob_next = op;
72 }
73}
74#endif /* Py_TRACE_REFS */
Tim Peters78be7992003-03-23 02:51:01 +000075
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000076#ifdef COUNT_ALLOCS
Guido van Rossumc0b618a1997-05-02 03:12:38 +000077static PyTypeObject *type_list;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000078/* All types are added to type_list, at least when
79 they get one object created. That makes them
80 immortal, which unfortunately contributes to
81 garbage itself. If unlist_types_without_objects
82 is set, they will be removed from the type_list
83 once the last object is deallocated. */
84int unlist_types_without_objects;
Sjoerd Mullender842d2cc1993-10-15 16:18:48 +000085extern int tuple_zero_allocs, fast_tuple_allocs;
86extern int quick_int_allocs, quick_neg_int_allocs;
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +000087extern int null_strings, one_strings;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000088void
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000089dump_counts(FILE* f)
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000090{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000091 PyTypeObject *tp;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000092
93 for (tp = type_list; tp; tp = tp->tp_next)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000094 fprintf(f, "%s alloc'd: %d, freed: %d, max in use: %d\n",
Tim Peters6d6c1a32001-08-02 04:15:00 +000095 tp->tp_name, tp->tp_allocs, tp->tp_frees,
Sjoerd Mullender52c1f511993-10-25 08:40:52 +000096 tp->tp_maxalloc);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000097 fprintf(f, "fast tuple allocs: %d, empty: %d\n",
Sjoerd Mullender52c1f511993-10-25 08:40:52 +000098 fast_tuple_allocs, tuple_zero_allocs);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000099 fprintf(f, "fast int allocs: pos: %d, neg: %d\n",
Sjoerd Mullender52c1f511993-10-25 08:40:52 +0000100 quick_int_allocs, quick_neg_int_allocs);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000101 fprintf(f, "null strings: %d, 1-strings: %d\n",
Sjoerd Mullender52c1f511993-10-25 08:40:52 +0000102 null_strings, one_strings);
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000103}
104
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000105PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000106get_counts(void)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000107{
108 PyTypeObject *tp;
109 PyObject *result;
110 PyObject *v;
111
112 result = PyList_New(0);
113 if (result == NULL)
114 return NULL;
115 for (tp = type_list; tp; tp = tp->tp_next) {
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000116 v = Py_BuildValue("(snnn)", tp->tp_name, tp->tp_allocs,
Tim Peters6d6c1a32001-08-02 04:15:00 +0000117 tp->tp_frees, tp->tp_maxalloc);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000118 if (v == NULL) {
119 Py_DECREF(result);
120 return NULL;
121 }
122 if (PyList_Append(result, v) < 0) {
123 Py_DECREF(v);
124 Py_DECREF(result);
125 return NULL;
126 }
127 Py_DECREF(v);
128 }
129 return result;
130}
131
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000132void
Fred Drake100814d2000-07-09 15:48:49 +0000133inc_count(PyTypeObject *tp)
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000134{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000135 if (tp->tp_next == NULL && tp->tp_prev == NULL) {
Guido van Rossumd8953cb1995-04-06 14:46:26 +0000136 /* first time; insert in linked list */
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000137 if (tp->tp_next != NULL) /* sanity check */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000138 Py_FatalError("XXX inc_count sanity check");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000139 if (type_list)
140 type_list->tp_prev = tp;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000141 tp->tp_next = type_list;
Tim Petersc6a3ff62002-07-08 22:11:52 +0000142 /* Note that as of Python 2.2, heap-allocated type objects
143 * can go away, but this code requires that they stay alive
144 * until program exit. That's why we're careful with
145 * refcounts here. type_list gets a new reference to tp,
146 * while ownership of the reference type_list used to hold
147 * (if any) was transferred to tp->tp_next in the line above.
148 * tp is thus effectively immortal after this.
149 */
150 Py_INCREF(tp);
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000151 type_list = tp;
Tim Peters3e40c7f2003-03-23 03:04:32 +0000152#ifdef Py_TRACE_REFS
Tim Peters7571a0f2003-03-23 17:52:28 +0000153 /* Also insert in the doubly-linked list of all objects,
154 * if not already there.
155 */
156 _Py_AddToAllObjects((PyObject *)tp, 0);
Tim Peters78be7992003-03-23 02:51:01 +0000157#endif
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000158 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000159 tp->tp_allocs++;
160 if (tp->tp_allocs - tp->tp_frees > tp->tp_maxalloc)
161 tp->tp_maxalloc = tp->tp_allocs - tp->tp_frees;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000162}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000163
164void dec_count(PyTypeObject *tp)
165{
166 tp->tp_frees++;
167 if (unlist_types_without_objects &&
168 tp->tp_allocs == tp->tp_frees) {
169 /* unlink the type from type_list */
170 if (tp->tp_prev)
171 tp->tp_prev->tp_next = tp->tp_next;
172 else
173 type_list = tp->tp_next;
174 if (tp->tp_next)
175 tp->tp_next->tp_prev = tp->tp_prev;
176 tp->tp_next = tp->tp_prev = NULL;
177 Py_DECREF(tp);
178 }
179}
180
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000181#endif
182
Tim Peters7c321a82002-07-09 02:57:01 +0000183#ifdef Py_REF_DEBUG
184/* Log a fatal error; doesn't return. */
185void
186_Py_NegativeRefcount(const char *fname, int lineno, PyObject *op)
187{
188 char buf[300];
189
190 PyOS_snprintf(buf, sizeof(buf),
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000191 "%s:%i object at %p has negative ref count "
192 "%" PY_FORMAT_SIZE_T "d",
193 fname, lineno, op, op->ob_refcnt);
Tim Peters7c321a82002-07-09 02:57:01 +0000194 Py_FatalError(buf);
195}
196
197#endif /* Py_REF_DEBUG */
198
Thomas Heller1328b522004-04-22 17:23:49 +0000199void
200Py_IncRef(PyObject *o)
201{
202 Py_XINCREF(o);
203}
204
205void
206Py_DecRef(PyObject *o)
207{
208 Py_XDECREF(o);
209}
210
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000211PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000212PyObject_Init(PyObject *op, PyTypeObject *tp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000213{
Guido van Rossum6e08c142002-10-11 20:37:24 +0000214 if (op == NULL)
215 return PyErr_NoMemory();
Guido van Rossumb18618d2000-05-03 23:44:39 +0000216 /* Any changes should be reflected in PyObject_INIT (objimpl.h) */
Christian Heimes90aa7642007-12-19 02:45:37 +0000217 Py_TYPE(op) = tp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000218 _Py_NewReference(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000219 return op;
220}
221
Guido van Rossumb18618d2000-05-03 23:44:39 +0000222PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000223PyObject_InitVar(PyVarObject *op, PyTypeObject *tp, Py_ssize_t size)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000224{
Guido van Rossum6e08c142002-10-11 20:37:24 +0000225 if (op == NULL)
226 return (PyVarObject *) PyErr_NoMemory();
Guido van Rossumb18618d2000-05-03 23:44:39 +0000227 /* Any changes should be reflected in PyObject_INIT_VAR */
228 op->ob_size = size;
Christian Heimes90aa7642007-12-19 02:45:37 +0000229 Py_TYPE(op) = tp;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000230 _Py_NewReference((PyObject *)op);
231 return op;
232}
233
234PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000235_PyObject_New(PyTypeObject *tp)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000236{
237 PyObject *op;
238 op = (PyObject *) PyObject_MALLOC(_PyObject_SIZE(tp));
239 if (op == NULL)
240 return PyErr_NoMemory();
241 return PyObject_INIT(op, tp);
242}
243
Guido van Rossumd0c87ee1997-05-15 21:31:03 +0000244PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000245_PyObject_NewVar(PyTypeObject *tp, Py_ssize_t nitems)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000246{
Guido van Rossumb18618d2000-05-03 23:44:39 +0000247 PyVarObject *op;
Tim Petersf2a67da2001-10-07 03:54:51 +0000248 const size_t size = _PyObject_VAR_SIZE(tp, nitems);
Tim Peters6d483d32001-10-06 21:27:34 +0000249 op = (PyVarObject *) PyObject_MALLOC(size);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000250 if (op == NULL)
Guido van Rossumd0c87ee1997-05-15 21:31:03 +0000251 return (PyVarObject *)PyErr_NoMemory();
Tim Peters6d483d32001-10-06 21:27:34 +0000252 return PyObject_INIT_VAR(op, tp, nitems);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000253}
254
Neal Norwitz1a997502003-01-13 20:13:12 +0000255/* Implementation of PyObject_Print with recursion checking */
256static int
257internal_print(PyObject *op, FILE *fp, int flags, int nesting)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000258{
Guido van Rossum278ef591991-07-27 21:40:24 +0000259 int ret = 0;
Neal Norwitz1a997502003-01-13 20:13:12 +0000260 if (nesting > 10) {
261 PyErr_SetString(PyExc_RuntimeError, "print recursion");
262 return -1;
263 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000264 if (PyErr_CheckSignals())
Guido van Rossum90933611991-06-07 16:10:43 +0000265 return -1;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000266#ifdef USE_STACKCHECK
267 if (PyOS_CheckStack()) {
Fred Drake661ea262000-10-24 19:57:45 +0000268 PyErr_SetString(PyExc_MemoryError, "stack overflow");
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000269 return -1;
270 }
271#endif
Guido van Rossum687ef6e2000-01-12 16:28:58 +0000272 clearerr(fp); /* Clear any previous error condition */
Guido van Rossum90933611991-06-07 16:10:43 +0000273 if (op == NULL) {
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000274 Py_BEGIN_ALLOW_THREADS
Guido van Rossum90933611991-06-07 16:10:43 +0000275 fprintf(fp, "<nil>");
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000276 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000277 }
Guido van Rossum90933611991-06-07 16:10:43 +0000278 else {
279 if (op->ob_refcnt <= 0)
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000280 /* XXX(twouters) cast refcount to long until %zd is
281 universally available */
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000282 Py_BEGIN_ALLOW_THREADS
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000283 fprintf(fp, "<refcnt %ld at %p>",
284 (long)op->ob_refcnt, op);
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000285 Py_END_ALLOW_THREADS
Guido van Rossum04dbf3b2007-08-07 19:51:00 +0000286 else {
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000287 PyObject *s;
288 if (flags & Py_PRINT_RAW)
289 s = PyObject_Str(op);
290 else
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000291 s = PyObject_Repr(op);
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000292 if (s == NULL)
293 ret = -1;
Christian Heimes72b710a2008-05-26 13:28:38 +0000294 else if (PyBytes_Check(s)) {
295 fwrite(PyBytes_AS_STRING(s), 1,
296 PyBytes_GET_SIZE(s), fp);
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000297 }
298 else if (PyUnicode_Check(s)) {
299 PyObject *t;
300 t = _PyUnicode_AsDefaultEncodedString(s, NULL);
301 if (t == NULL)
302 ret = 0;
303 else {
Christian Heimes72b710a2008-05-26 13:28:38 +0000304 fwrite(PyBytes_AS_STRING(t), 1,
305 PyBytes_GET_SIZE(t), fp);
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000306 }
307 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000308 else {
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000309 PyErr_Format(PyExc_TypeError,
310 "str() or repr() returned '%.100s'",
311 s->ob_type->tp_name);
312 ret = -1;
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000313 }
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000314 Py_XDECREF(s);
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000315 }
Guido van Rossum90933611991-06-07 16:10:43 +0000316 }
Guido van Rossum278ef591991-07-27 21:40:24 +0000317 if (ret == 0) {
318 if (ferror(fp)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000319 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum278ef591991-07-27 21:40:24 +0000320 clearerr(fp);
321 ret = -1;
322 }
323 }
324 return ret;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000325}
326
Neal Norwitz1a997502003-01-13 20:13:12 +0000327int
328PyObject_Print(PyObject *op, FILE *fp, int flags)
329{
330 return internal_print(op, fp, flags, 0);
331}
332
Guido van Rossum38938152006-08-21 23:36:26 +0000333/* For debugging convenience. Set a breakpoint here and call it from your DLL */
334void
Thomas Woutersb2137042007-02-01 18:02:27 +0000335_Py_BreakPoint(void)
Guido van Rossum38938152006-08-21 23:36:26 +0000336{
337}
338
Neal Norwitz1a997502003-01-13 20:13:12 +0000339
Barry Warsaw9bf16442001-01-23 16:24:35 +0000340/* For debugging convenience. See Misc/gdbinit for some useful gdb hooks */
Guido van Rossum38938152006-08-21 23:36:26 +0000341void
342_PyObject_Dump(PyObject* op)
Barry Warsaw9bf16442001-01-23 16:24:35 +0000343{
Barry Warsaweefb1072001-02-22 22:39:18 +0000344 if (op == NULL)
345 fprintf(stderr, "NULL\n");
346 else {
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000347 fprintf(stderr, "object : ");
Barry Warsaweefb1072001-02-22 22:39:18 +0000348 (void)PyObject_Print(op, stderr, 0);
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000349 /* XXX(twouters) cast refcount to long until %zd is
350 universally available */
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000351 fprintf(stderr, "\n"
352 "type : %s\n"
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000353 "refcount: %ld\n"
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000354 "address : %p\n",
Christian Heimes90aa7642007-12-19 02:45:37 +0000355 Py_TYPE(op)==NULL ? "NULL" : Py_TYPE(op)->tp_name,
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000356 (long)op->ob_refcnt,
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000357 op);
Barry Warsaweefb1072001-02-22 22:39:18 +0000358 }
Barry Warsaw9bf16442001-01-23 16:24:35 +0000359}
Barry Warsaw903138f2001-01-23 16:33:18 +0000360
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000361PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000362PyObject_Repr(PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000363{
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000364 PyObject *res;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000365 if (PyErr_CheckSignals())
Guido van Rossum90933611991-06-07 16:10:43 +0000366 return NULL;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000367#ifdef USE_STACKCHECK
368 if (PyOS_CheckStack()) {
Fred Drake661ea262000-10-24 19:57:45 +0000369 PyErr_SetString(PyExc_MemoryError, "stack overflow");
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000370 return NULL;
371 }
372#endif
Guido van Rossum90933611991-06-07 16:10:43 +0000373 if (v == NULL)
Walter Dörwald1ab83302007-05-18 17:15:44 +0000374 return PyUnicode_FromString("<NULL>");
Christian Heimes90aa7642007-12-19 02:45:37 +0000375 if (Py_TYPE(v)->tp_repr == NULL)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000376 return PyUnicode_FromFormat("<%s object at %p>",
377 v->ob_type->tp_name, v);
378 res = (*v->ob_type->tp_repr)(v);
379 if (res != NULL && !PyUnicode_Check(res)) {
380 PyErr_Format(PyExc_TypeError,
381 "__repr__ returned non-string (type %.200s)",
382 res->ob_type->tp_name);
383 Py_DECREF(res);
384 return NULL;
385 }
386 return res;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000387}
388
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000389PyObject *
Guido van Rossum98297ee2007-11-06 21:34:58 +0000390PyObject_Str(PyObject *v)
Guido van Rossumc6004111993-11-05 10:22:19 +0000391{
Guido van Rossum4c08d552000-03-10 22:55:18 +0000392 PyObject *res;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000393 if (PyErr_CheckSignals())
394 return NULL;
395#ifdef USE_STACKCHECK
396 if (PyOS_CheckStack()) {
397 PyErr_SetString(PyExc_MemoryError, "stack overflow");
398 return NULL;
399 }
400#endif
Guido van Rossumc6004111993-11-05 10:22:19 +0000401 if (v == NULL)
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000402 return PyUnicode_FromString("<NULL>");
Neil Schemenauercf52c072005-08-12 17:34:58 +0000403 if (PyUnicode_CheckExact(v)) {
404 Py_INCREF(v);
405 return v;
406 }
Christian Heimes90aa7642007-12-19 02:45:37 +0000407 if (Py_TYPE(v)->tp_str == NULL)
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000408 return PyObject_Repr(v);
409
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000410 /* It is possible for a type to have a tp_str representation that loops
411 infinitely. */
412 if (Py_EnterRecursiveCall(" while getting the str of an object"))
413 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +0000414 res = (*Py_TYPE(v)->tp_str)(v);
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000415 Py_LeaveRecursiveCall();
Guido van Rossum4c08d552000-03-10 22:55:18 +0000416 if (res == NULL)
417 return NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000418 if (!PyUnicode_Check(res)) {
Neil Schemenauercf52c072005-08-12 17:34:58 +0000419 PyErr_Format(PyExc_TypeError,
420 "__str__ returned non-string (type %.200s)",
Christian Heimes90aa7642007-12-19 02:45:37 +0000421 Py_TYPE(res)->tp_name);
Neil Schemenauercf52c072005-08-12 17:34:58 +0000422 Py_DECREF(res);
423 return NULL;
424 }
425 return res;
426}
427
Georg Brandl559e5d72008-06-11 18:37:52 +0000428PyObject *
429PyObject_ASCII(PyObject *v)
430{
431 PyObject *repr, *ascii, *res;
432
433 repr = PyObject_Repr(v);
434 if (repr == NULL)
435 return NULL;
436
437 /* repr is guaranteed to be a PyUnicode object by PyObject_Repr */
438 ascii = PyUnicode_EncodeASCII(
439 PyUnicode_AS_UNICODE(repr),
440 PyUnicode_GET_SIZE(repr),
441 "backslashreplace");
442
443 Py_DECREF(repr);
444 if (ascii == NULL)
445 return NULL;
446
447 res = PyUnicode_DecodeASCII(
448 PyBytes_AS_STRING(ascii),
449 PyBytes_GET_SIZE(ascii),
450 NULL);
451
452 Py_DECREF(ascii);
453 return res;
454}
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000455
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000456PyObject *
457PyObject_Bytes(PyObject *v)
458{
459 PyObject *bytesmeth, *result, *func;
460 static PyObject *bytesstring = NULL;
461
462 if (bytesstring == NULL) {
463 bytesstring = PyUnicode_InternFromString("__bytes__");
464 if (bytesstring == NULL)
465 return NULL;
466 }
467
468 if (v == NULL)
469 return PyBytes_FromString("<NULL>");
470
471 if (PyBytes_CheckExact(v)) {
472 Py_INCREF(v);
473 return v;
474 }
475
476 /* Doesn't create a reference */
477 func = _PyType_Lookup(Py_TYPE(v), bytesstring);
478 if (func != NULL) {
479 result = PyObject_CallFunctionObjArgs(func, v, NULL);
480 if (result == NULL)
481 return NULL;
482 if (!PyBytes_Check(result)) {
483 PyErr_Format(PyExc_TypeError,
484 "__bytes__ returned non-bytes (type %.200s)",
485 Py_TYPE(result)->tp_name);
486 Py_DECREF(result);
487 return NULL;
488 }
489 return result;
490 }
491 PyErr_Clear();
492 return PyBytes_FromObject(v);
493}
494
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000495/* The new comparison philosophy is: we completely separate three-way
496 comparison from rich comparison. That is, PyObject_Compare() and
497 PyObject_Cmp() *just* use the tp_compare slot. And PyObject_RichCompare()
498 and PyObject_RichCompareBool() *just* use the tp_richcompare slot.
Guido van Rossum98297ee2007-11-06 21:34:58 +0000499
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000500 See (*) below for practical amendments.
501
502 IOW, only cmp() uses tp_compare; the comparison operators (==, !=, <=, <,
503 >=, >) only use tp_richcompare. Note that list.sort() only uses <.
504
505 (And yes, eventually we'll rip out cmp() and tp_compare.)
506
507 The calling conventions are different: tp_compare only gets called with two
508 objects of the appropriate type; tp_richcompare gets called with a first
509 argument of the appropriate type and a second object of an arbitrary type.
510 We never do any kind of coercion.
511
512 The return conventions are also different.
513
514 The tp_compare slot should return a C int, as follows:
515
516 -1 if a < b or if an exception occurred
517 0 if a == b
518 +1 if a > b
519
520 No other return values are allowed. PyObject_Compare() has the same
521 calling convention.
522
523 The tp_richcompare slot should return an object, as follows:
524
525 NULL if an exception occurred
526 NotImplemented if the requested comparison is not implemented
527 any other false value if the requested comparison is false
528 any other true value if the requested comparison is true
529
530 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
531 NotImplemented.
532
533 (*) Practical amendments:
534
535 - If rich comparison returns NotImplemented, == and != are decided by
536 comparing the object pointer (i.e. falling back to the base object
537 implementation).
538
539 - If three-way comparison is not implemented, it falls back on rich
540 comparison (but not the other way around!).
541
Guido van Rossuma4073002002-05-31 20:03:54 +0000542*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000543
544/* Forward */
545static PyObject *do_richcompare(PyObject *v, PyObject *w, int op);
546
547/* Perform a three-way comparison, raising TypeError if three-way comparison
548 is not supported. */
Guido van Rossuma4073002002-05-31 20:03:54 +0000549static int
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000550do_compare(PyObject *v, PyObject *w)
Guido van Rossuma4073002002-05-31 20:03:54 +0000551{
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000552 cmpfunc f;
553 int ok;
554
Guido van Rossum98297ee2007-11-06 21:34:58 +0000555 if (v->ob_type == w->ob_type &&
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000556 (f = v->ob_type->tp_compare) != NULL) {
557 return (*f)(v, w);
Guido van Rossuma4073002002-05-31 20:03:54 +0000558 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000559
560 /* Now try three-way compare before giving up. This is intentionally
561 elaborate; if you have a it will raise TypeError if it detects two
562 objects that aren't ordered with respect to each other. */
563 ok = PyObject_RichCompareBool(v, w, Py_LT);
564 if (ok < 0)
565 return -1; /* Error */
566 if (ok)
567 return -1; /* Less than */
568 ok = PyObject_RichCompareBool(v, w, Py_GT);
569 if (ok < 0)
570 return -1; /* Error */
571 if (ok)
572 return 1; /* Greater than */
573 ok = PyObject_RichCompareBool(v, w, Py_EQ);
574 if (ok < 0)
575 return -1; /* Error */
576 if (ok)
577 return 0; /* Equal */
578
579 /* Give up */
580 PyErr_Format(PyExc_TypeError,
Neal Norwitz3bd844e2006-08-29 04:39:12 +0000581 "unorderable types: '%.100s' != '%.100s'",
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000582 v->ob_type->tp_name,
583 w->ob_type->tp_name);
584 return -1;
Guido van Rossuma4073002002-05-31 20:03:54 +0000585}
586
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000587/* Perform a three-way comparison. This wraps do_compare() with a check for
588 NULL arguments and a recursion check. */
589int
590PyObject_Compare(PyObject *v, PyObject *w)
591{
592 int res;
Guido van Rossuma4073002002-05-31 20:03:54 +0000593
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000594 if (v == NULL || w == NULL) {
595 if (!PyErr_Occurred())
596 PyErr_BadInternalCall();
597 return -1;
598 }
599 if (Py_EnterRecursiveCall(" in cmp"))
600 return -1;
601 res = do_compare(v, w);
602 Py_LeaveRecursiveCall();
603 return res < 0 ? -1 : res;
604}
Guido van Rossumd1f06b92001-01-24 22:14:43 +0000605
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000606/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000607int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000608
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000609static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000610
611/* Perform a rich comparison, raising TypeError when the requested comparison
612 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000613static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000614do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000615{
616 richcmpfunc f;
617 PyObject *res;
618
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000619 if (v->ob_type != w->ob_type &&
620 PyType_IsSubtype(w->ob_type, v->ob_type) &&
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000621 (f = w->ob_type->tp_richcompare) != NULL) {
Tim Petersf4aca752004-09-23 02:39:37 +0000622 res = (*f)(w, v, _Py_SwappedOp[op]);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000623 if (res != Py_NotImplemented)
624 return res;
625 Py_DECREF(res);
626 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000627 if ((f = v->ob_type->tp_richcompare) != NULL) {
Guido van Rossume797ec12001-01-17 15:24:28 +0000628 res = (*f)(v, w, op);
629 if (res != Py_NotImplemented)
630 return res;
631 Py_DECREF(res);
632 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000633 if ((f = w->ob_type->tp_richcompare) != NULL) {
634 res = (*f)(w, v, _Py_SwappedOp[op]);
635 if (res != Py_NotImplemented)
636 return res;
637 Py_DECREF(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000638 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000639 /* If neither object implements it, provide a sensible default
640 for == and !=, but raise an exception for ordering. */
641 switch (op) {
642 case Py_EQ:
643 res = (v == w) ? Py_True : Py_False;
644 break;
645 case Py_NE:
646 res = (v != w) ? Py_True : Py_False;
647 break;
648 default:
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000649 /* XXX Special-case None so it doesn't show as NoneType() */
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000650 PyErr_Format(PyExc_TypeError,
651 "unorderable types: %.100s() %s %.100s()",
652 v->ob_type->tp_name,
653 opstrings[op],
654 w->ob_type->tp_name);
655 return NULL;
656 }
Guido van Rossume797ec12001-01-17 15:24:28 +0000657 Py_INCREF(res);
658 return res;
659}
660
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000661/* Perform a rich comparison with object result. This wraps do_richcompare()
662 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000663
Guido van Rossume797ec12001-01-17 15:24:28 +0000664PyObject *
665PyObject_RichCompare(PyObject *v, PyObject *w, int op)
666{
667 PyObject *res;
668
669 assert(Py_LT <= op && op <= Py_GE);
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000670 if (v == NULL || w == NULL) {
671 if (!PyErr_Occurred())
672 PyErr_BadInternalCall();
673 return NULL;
674 }
Armin Rigo2b3eb402003-10-28 12:05:48 +0000675 if (Py_EnterRecursiveCall(" in cmp"))
676 return NULL;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000677 res = do_richcompare(v, w, op);
Armin Rigo2b3eb402003-10-28 12:05:48 +0000678 Py_LeaveRecursiveCall();
Guido van Rossume797ec12001-01-17 15:24:28 +0000679 return res;
680}
681
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000682/* Perform a rich comparison with integer result. This wraps
683 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000684int
685PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
686{
Raymond Hettinger93d44812004-03-21 17:01:44 +0000687 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000688 int ok;
689
Raymond Hettinger93d44812004-03-21 17:01:44 +0000690 res = PyObject_RichCompare(v, w, op);
Guido van Rossume797ec12001-01-17 15:24:28 +0000691 if (res == NULL)
692 return -1;
Guido van Rossum81912d42002-08-24 05:33:28 +0000693 if (PyBool_Check(res))
694 ok = (res == Py_True);
695 else
696 ok = PyObject_IsTrue(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000697 Py_DECREF(res);
698 return ok;
699}
Fred Drake13634cf2000-06-29 19:17:04 +0000700
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000701/* Turn the result of a three-way comparison into the result expected by a
702 rich comparison. */
703PyObject *
704Py_CmpToRich(int op, int cmp)
705{
706 PyObject *res;
707 int ok;
708
709 if (PyErr_Occurred())
710 return NULL;
711 switch (op) {
712 case Py_LT:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000713 ok = cmp < 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000714 break;
715 case Py_LE:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000716 ok = cmp <= 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000717 break;
718 case Py_EQ:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000719 ok = cmp == 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000720 break;
721 case Py_NE:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000722 ok = cmp != 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000723 break;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000724 case Py_GT:
725 ok = cmp > 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000726 break;
727 case Py_GE:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000728 ok = cmp >= 0;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000729 break;
730 default:
Guido van Rossum98297ee2007-11-06 21:34:58 +0000731 PyErr_BadArgument();
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000732 return NULL;
733 }
734 res = ok ? Py_True : Py_False;
735 Py_INCREF(res);
736 return res;
737}
738
Fred Drake13634cf2000-06-29 19:17:04 +0000739/* Set of hash utility functions to help maintaining the invariant that
Raymond Hettinger8183fa42004-03-21 17:35:06 +0000740 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000741
742 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
743*/
744
745long
Fred Drake100814d2000-07-09 15:48:49 +0000746_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000747{
Tim Peters39dce292000-08-15 03:34:48 +0000748 double intpart, fractpart;
749 int expo;
750 long hipart;
751 long x; /* the final hash value */
752 /* This is designed so that Python numbers of different types
753 * that compare equal hash to the same value; otherwise comparisons
754 * of mapping keys will turn out weird.
755 */
756
Tim Peters39dce292000-08-15 03:34:48 +0000757 fractpart = modf(v, &intpart);
Tim Peters39dce292000-08-15 03:34:48 +0000758 if (fractpart == 0.0) {
759 /* This must return the same hash as an equal int or long. */
760 if (intpart > LONG_MAX || -intpart > LONG_MAX) {
761 /* Convert to long and use its hash. */
762 PyObject *plong; /* converted to Python long */
763 if (Py_IS_INFINITY(intpart))
764 /* can't convert to long int -- arbitrary */
765 v = v < 0 ? -271828.0 : 314159.0;
766 plong = PyLong_FromDouble(v);
767 if (plong == NULL)
768 return -1;
769 x = PyObject_Hash(plong);
770 Py_DECREF(plong);
771 return x;
772 }
773 /* Fits in a C long == a Python int, so is its own hash. */
774 x = (long)intpart;
775 if (x == -1)
776 x = -2;
777 return x;
778 }
779 /* The fractional part is non-zero, so we don't have to worry about
780 * making this match the hash of some other type.
781 * Use frexp to get at the bits in the double.
Fred Drake13634cf2000-06-29 19:17:04 +0000782 * Since the VAX D double format has 56 mantissa bits, which is the
783 * most of any double format in use, each of these parts may have as
784 * many as (but no more than) 56 significant bits.
Tim Peters39dce292000-08-15 03:34:48 +0000785 * So, assuming sizeof(long) >= 4, each part can be broken into two
786 * longs; frexp and multiplication are used to do that.
787 * Also, since the Cray double format has 15 exponent bits, which is
788 * the most of any double format in use, shifting the exponent field
789 * left by 15 won't overflow a long (again assuming sizeof(long) >= 4).
Fred Drake13634cf2000-06-29 19:17:04 +0000790 */
Tim Peters39dce292000-08-15 03:34:48 +0000791 v = frexp(v, &expo);
792 v *= 2147483648.0; /* 2**31 */
793 hipart = (long)v; /* take the top 32 bits */
794 v = (v - (double)hipart) * 2147483648.0; /* get the next 32 bits */
795 x = hipart + (long)v + (expo << 15);
796 if (x == -1)
797 x = -2;
798 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000799}
800
801long
Fred Drake100814d2000-07-09 15:48:49 +0000802_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000803{
804#if SIZEOF_LONG >= SIZEOF_VOID_P
805 return (long)p;
806#else
807 /* convert to a Python long and hash that */
808 PyObject* longobj;
809 long x;
Tim Peters803526b2002-07-07 05:13:56 +0000810
Fred Drake13634cf2000-06-29 19:17:04 +0000811 if ((longobj = PyLong_FromVoidPtr(p)) == NULL) {
812 x = -1;
813 goto finally;
814 }
815 x = PyObject_Hash(longobj);
Tim Peters803526b2002-07-07 05:13:56 +0000816
Fred Drake13634cf2000-06-29 19:17:04 +0000817finally:
818 Py_XDECREF(longobj);
819 return x;
820#endif
821}
822
Nick Coghland1abd252008-07-15 15:46:38 +0000823long
824PyObject_HashNotImplemented(PyObject *v)
825{
826 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
827 Py_TYPE(v)->tp_name);
828 return -1;
829}
Fred Drake13634cf2000-06-29 19:17:04 +0000830
Guido van Rossum9bfef441993-03-29 10:43:31 +0000831long
Fred Drake100814d2000-07-09 15:48:49 +0000832PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000833{
Nick Coghland1abd252008-07-15 15:46:38 +0000834 PyTypeObject *tp = Py_TYPE(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000835 if (tp->tp_hash != NULL)
836 return (*tp->tp_hash)(v);
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000837 /* Otherwise, the object can't be hashed */
Nick Coghland1abd252008-07-15 15:46:38 +0000838 return PyObject_HashNotImplemented(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000839}
840
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000841PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000842PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000843{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000844 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000845
Christian Heimes90aa7642007-12-19 02:45:37 +0000846 if (Py_TYPE(v)->tp_getattr != NULL)
847 return (*Py_TYPE(v)->tp_getattr)(v, (char*)name);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000848 w = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000849 if (w == NULL)
850 return NULL;
851 res = PyObject_GetAttr(v, w);
852 Py_XDECREF(w);
853 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000854}
855
856int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000857PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000858{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000859 PyObject *res = PyObject_GetAttrString(v, name);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000860 if (res != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000861 Py_DECREF(res);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000862 return 1;
863 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000864 PyErr_Clear();
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000865 return 0;
866}
867
868int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000869PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000870{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000871 PyObject *s;
872 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000873
Christian Heimes90aa7642007-12-19 02:45:37 +0000874 if (Py_TYPE(v)->tp_setattr != NULL)
875 return (*Py_TYPE(v)->tp_setattr)(v, (char*)name, w);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000876 s = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000877 if (s == NULL)
878 return -1;
879 res = PyObject_SetAttr(v, s, w);
880 Py_XDECREF(s);
881 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000882}
883
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000884PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000885PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000886{
Christian Heimes90aa7642007-12-19 02:45:37 +0000887 PyTypeObject *tp = Py_TYPE(v);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000888
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000889 if (!PyUnicode_Check(name)) {
Martin v. Löwis5b222132007-06-10 09:51:05 +0000890 PyErr_Format(PyExc_TypeError,
891 "attribute name must be string, not '%.200s'",
892 name->ob_type->tp_name);
893 return NULL;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000894 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000895 if (tp->tp_getattro != NULL)
896 return (*tp->tp_getattro)(v, name);
897 if (tp->tp_getattr != NULL)
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000898 return (*tp->tp_getattr)(v, _PyUnicode_AsString(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +0000899 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000900 "'%.50s' object has no attribute '%U'",
901 tp->tp_name, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000902 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000903}
904
905int
Fred Drake100814d2000-07-09 15:48:49 +0000906PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000907{
908 PyObject *res = PyObject_GetAttr(v, name);
909 if (res != NULL) {
910 Py_DECREF(res);
911 return 1;
912 }
913 PyErr_Clear();
914 return 0;
915}
916
917int
Fred Drake100814d2000-07-09 15:48:49 +0000918PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000919{
Christian Heimes90aa7642007-12-19 02:45:37 +0000920 PyTypeObject *tp = Py_TYPE(v);
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000921 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000922
Martin v. Löwis5b222132007-06-10 09:51:05 +0000923 if (!PyUnicode_Check(name)) {
924 PyErr_Format(PyExc_TypeError,
925 "attribute name must be string, not '%.200s'",
926 name->ob_type->tp_name);
927 return -1;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000928 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000929 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000930
Martin v. Löwis5b222132007-06-10 09:51:05 +0000931 PyUnicode_InternInPlace(&name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000932 if (tp->tp_setattro != NULL) {
933 err = (*tp->tp_setattro)(v, name, value);
934 Py_DECREF(name);
935 return err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000936 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000937 if (tp->tp_setattr != NULL) {
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000938 err = (*tp->tp_setattr)(v, _PyUnicode_AsString(name), value);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000939 Py_DECREF(name);
940 return err;
941 }
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000942 Py_DECREF(name);
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000943 assert(name->ob_refcnt >= 1);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000944 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
945 PyErr_Format(PyExc_TypeError,
946 "'%.100s' object has no attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000947 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000948 tp->tp_name,
949 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000950 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000951 else
952 PyErr_Format(PyExc_TypeError,
953 "'%.100s' object has only read-only attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000954 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000955 tp->tp_name,
956 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000957 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000958 return -1;
959}
960
961/* Helper to get a pointer to an object's __dict__ slot, if any */
962
963PyObject **
964_PyObject_GetDictPtr(PyObject *obj)
965{
Martin v. Löwis725507b2006-03-07 12:08:51 +0000966 Py_ssize_t dictoffset;
Christian Heimes90aa7642007-12-19 02:45:37 +0000967 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000968
Tim Peters6d6c1a32001-08-02 04:15:00 +0000969 dictoffset = tp->tp_dictoffset;
970 if (dictoffset == 0)
971 return NULL;
972 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000973 Py_ssize_t tsize;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000974 size_t size;
975
976 tsize = ((PyVarObject *)obj)->ob_size;
977 if (tsize < 0)
978 tsize = -tsize;
979 size = _PyObject_VAR_SIZE(tp, tsize);
980
Tim Peters6d483d32001-10-06 21:27:34 +0000981 dictoffset += (long)size;
982 assert(dictoffset > 0);
983 assert(dictoffset % SIZEOF_VOID_P == 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000984 }
985 return (PyObject **) ((char *)obj + dictoffset);
986}
987
Tim Peters6d6c1a32001-08-02 04:15:00 +0000988PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000989PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +0000990{
991 Py_INCREF(obj);
992 return obj;
993}
994
Michael W. Hudson1593f502004-09-14 17:09:47 +0000995/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
996
Raymond Hettinger01538262003-03-17 08:24:35 +0000997PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000998PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
999{
Christian Heimes90aa7642007-12-19 02:45:37 +00001000 PyTypeObject *tp = Py_TYPE(obj);
Guido van Rossum056fbf42002-08-19 19:22:50 +00001001 PyObject *descr = NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001002 PyObject *res = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001003 descrgetfunc f;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001004 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001005 PyObject **dictptr;
1006
Martin v. Löwis5b222132007-06-10 09:51:05 +00001007 if (!PyUnicode_Check(name)){
1008 PyErr_Format(PyExc_TypeError,
1009 "attribute name must be string, not '%.200s'",
1010 name->ob_type->tp_name);
1011 return NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001012 }
1013 else
1014 Py_INCREF(name);
1015
Tim Peters6d6c1a32001-08-02 04:15:00 +00001016 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001017 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001018 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001019 }
1020
Christian Heimesa62da1d2008-01-12 19:39:10 +00001021#if 0 /* XXX this is not quite _PyType_Lookup anymore */
Guido van Rossum056fbf42002-08-19 19:22:50 +00001022 /* Inline _PyType_Lookup */
1023 {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001024 Py_ssize_t i, n;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001025 PyObject *mro, *base, *dict;
1026
1027 /* Look in tp_dict of types in MRO */
1028 mro = tp->tp_mro;
1029 assert(mro != NULL);
1030 assert(PyTuple_Check(mro));
1031 n = PyTuple_GET_SIZE(mro);
1032 for (i = 0; i < n; i++) {
1033 base = PyTuple_GET_ITEM(mro, i);
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001034 assert(PyType_Check(base));
1035 dict = ((PyTypeObject *)base)->tp_dict;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001036 assert(dict && PyDict_Check(dict));
1037 descr = PyDict_GetItem(dict, name);
1038 if (descr != NULL)
1039 break;
1040 }
1041 }
Christian Heimesa62da1d2008-01-12 19:39:10 +00001042#else
1043 descr = _PyType_Lookup(tp, name);
1044#endif
Guido van Rossum056fbf42002-08-19 19:22:50 +00001045
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001046 Py_XINCREF(descr);
1047
Tim Peters6d6c1a32001-08-02 04:15:00 +00001048 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001049 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001050 f = descr->ob_type->tp_descr_get;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001051 if (f != NULL && PyDescr_IsData(descr)) {
1052 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001053 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001054 goto done;
1055 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001056 }
1057
Guido van Rossumc66ff442002-08-19 16:50:48 +00001058 /* Inline _PyObject_GetDictPtr */
1059 dictoffset = tp->tp_dictoffset;
1060 if (dictoffset != 0) {
1061 PyObject *dict;
1062 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001063 Py_ssize_t tsize;
Guido van Rossumc66ff442002-08-19 16:50:48 +00001064 size_t size;
1065
1066 tsize = ((PyVarObject *)obj)->ob_size;
1067 if (tsize < 0)
1068 tsize = -tsize;
1069 size = _PyObject_VAR_SIZE(tp, tsize);
1070
1071 dictoffset += (long)size;
1072 assert(dictoffset > 0);
1073 assert(dictoffset % SIZEOF_VOID_P == 0);
1074 }
1075 dictptr = (PyObject **) ((char *)obj + dictoffset);
1076 dict = *dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001077 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +00001078 Py_INCREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001079 res = PyDict_GetItem(dict, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001080 if (res != NULL) {
1081 Py_INCREF(res);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001082 Py_XDECREF(descr);
Christian Heimes969fe572008-01-25 11:23:10 +00001083 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001084 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001085 }
Christian Heimes969fe572008-01-25 11:23:10 +00001086 Py_DECREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001087 }
1088 }
1089
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001090 if (f != NULL) {
Christian Heimes90aa7642007-12-19 02:45:37 +00001091 res = f(descr, obj, (PyObject *)Py_TYPE(obj));
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001092 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001093 goto done;
1094 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001095
1096 if (descr != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001097 res = descr;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001098 /* descr was already increfed above */
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001099 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001100 }
1101
1102 PyErr_Format(PyExc_AttributeError,
1103 "'%.50s' object has no attribute '%.400s'",
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +00001104 tp->tp_name, _PyUnicode_AsString(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001105 done:
1106 Py_DECREF(name);
1107 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001108}
1109
1110int
1111PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1112{
Christian Heimes90aa7642007-12-19 02:45:37 +00001113 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001114 PyObject *descr;
1115 descrsetfunc f;
1116 PyObject **dictptr;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001117 int res = -1;
1118
Martin v. Löwis5b222132007-06-10 09:51:05 +00001119 if (!PyUnicode_Check(name)){
1120 PyErr_Format(PyExc_TypeError,
1121 "attribute name must be string, not '%.200s'",
1122 name->ob_type->tp_name);
1123 return -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001124 }
1125 else
1126 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001127
1128 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001129 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001130 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001131 }
1132
1133 descr = _PyType_Lookup(tp, name);
1134 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001135 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001136 f = descr->ob_type->tp_descr_set;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001137 if (f != NULL && PyDescr_IsData(descr)) {
1138 res = f(descr, obj, value);
1139 goto done;
1140 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001141 }
1142
1143 dictptr = _PyObject_GetDictPtr(obj);
1144 if (dictptr != NULL) {
1145 PyObject *dict = *dictptr;
1146 if (dict == NULL && value != NULL) {
1147 dict = PyDict_New();
1148 if (dict == NULL)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001149 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001150 *dictptr = dict;
1151 }
1152 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +00001153 Py_INCREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001154 if (value == NULL)
1155 res = PyDict_DelItem(dict, name);
1156 else
1157 res = PyDict_SetItem(dict, name, value);
1158 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1159 PyErr_SetObject(PyExc_AttributeError, name);
Christian Heimes969fe572008-01-25 11:23:10 +00001160 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001161 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001162 }
1163 }
1164
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001165 if (f != NULL) {
1166 res = f(descr, obj, value);
1167 goto done;
1168 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001169
1170 if (descr == NULL) {
1171 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001172 "'%.100s' object has no attribute '%U'",
1173 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001174 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001175 }
1176
1177 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001178 "'%.50s' object attribute '%U' is read-only",
1179 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001180 done:
1181 Py_DECREF(name);
1182 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001183}
1184
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001185/* Test a value used as condition, e.g., in a for or if statement.
1186 Return -1 if an error occurred */
1187
1188int
Fred Drake100814d2000-07-09 15:48:49 +00001189PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001190{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001191 Py_ssize_t res;
Guido van Rossum6248f442002-08-24 06:31:34 +00001192 if (v == Py_True)
1193 return 1;
1194 if (v == Py_False)
1195 return 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001196 if (v == Py_None)
Neal Norwitz51290d32002-06-13 21:32:44 +00001197 return 0;
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001198 else if (v->ob_type->tp_as_number != NULL &&
Jack Diederich4dafcc42006-11-28 19:15:13 +00001199 v->ob_type->tp_as_number->nb_bool != NULL)
1200 res = (*v->ob_type->tp_as_number->nb_bool)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001201 else if (v->ob_type->tp_as_mapping != NULL &&
1202 v->ob_type->tp_as_mapping->mp_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001203 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001204 else if (v->ob_type->tp_as_sequence != NULL &&
1205 v->ob_type->tp_as_sequence->sq_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001206 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1207 else
Neal Norwitz51290d32002-06-13 21:32:44 +00001208 return 1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001209 /* if it is negative, it should be either -1 or -2 */
1210 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001211}
1212
Tim Peters803526b2002-07-07 05:13:56 +00001213/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001214 Return -1 if an error occurred */
1215
1216int
Fred Drake100814d2000-07-09 15:48:49 +00001217PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001218{
1219 int res;
1220 res = PyObject_IsTrue(v);
1221 if (res < 0)
1222 return res;
1223 return res == 0;
1224}
1225
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001226/* Test whether an object can be called */
1227
1228int
Fred Drake100814d2000-07-09 15:48:49 +00001229PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001230{
1231 if (x == NULL)
1232 return 0;
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001233 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001234}
1235
Georg Brandle32b4222007-03-10 22:13:27 +00001236/* ------------------------- PyObject_Dir() helpers ------------------------- */
1237
Tim Peters7eea37e2001-09-04 22:08:56 +00001238/* Helper for PyObject_Dir.
1239 Merge the __dict__ of aclass into dict, and recursively also all
1240 the __dict__s of aclass's base classes. The order of merging isn't
1241 defined, as it's expected that only the final set of dict keys is
1242 interesting.
1243 Return 0 on success, -1 on error.
1244*/
1245
1246static int
1247merge_class_dict(PyObject* dict, PyObject* aclass)
1248{
1249 PyObject *classdict;
1250 PyObject *bases;
1251
1252 assert(PyDict_Check(dict));
1253 assert(aclass);
1254
1255 /* Merge in the type's dict (if any). */
1256 classdict = PyObject_GetAttrString(aclass, "__dict__");
1257 if (classdict == NULL)
1258 PyErr_Clear();
1259 else {
1260 int status = PyDict_Update(dict, classdict);
1261 Py_DECREF(classdict);
1262 if (status < 0)
1263 return -1;
1264 }
1265
1266 /* Recursively merge in the base types' (if any) dicts. */
1267 bases = PyObject_GetAttrString(aclass, "__bases__");
Tim Petersbc7e8632001-09-16 20:33:22 +00001268 if (bases == NULL)
1269 PyErr_Clear();
1270 else {
Guido van Rossum44022412002-05-13 18:29:46 +00001271 /* We have no guarantee that bases is a real tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001272 Py_ssize_t i, n;
Guido van Rossum44022412002-05-13 18:29:46 +00001273 n = PySequence_Size(bases); /* This better be right */
1274 if (n < 0)
1275 PyErr_Clear();
1276 else {
1277 for (i = 0; i < n; i++) {
Tim Peters18e70832003-02-05 19:35:19 +00001278 int status;
Guido van Rossum44022412002-05-13 18:29:46 +00001279 PyObject *base = PySequence_GetItem(bases, i);
1280 if (base == NULL) {
1281 Py_DECREF(bases);
1282 return -1;
1283 }
Tim Peters18e70832003-02-05 19:35:19 +00001284 status = merge_class_dict(dict, base);
1285 Py_DECREF(base);
1286 if (status < 0) {
Guido van Rossum44022412002-05-13 18:29:46 +00001287 Py_DECREF(bases);
1288 return -1;
1289 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001290 }
1291 }
1292 Py_DECREF(bases);
1293 }
1294 return 0;
1295}
1296
Georg Brandle32b4222007-03-10 22:13:27 +00001297/* Helper for PyObject_Dir without arguments: returns the local scope. */
1298static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001299_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001300{
Georg Brandled3b8382007-03-12 13:15:14 +00001301 PyObject *names;
Georg Brandle32b4222007-03-10 22:13:27 +00001302 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001303
Georg Brandle32b4222007-03-10 22:13:27 +00001304 if (locals == NULL) {
1305 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1306 return NULL;
Tim Peters305b5852001-09-17 02:38:46 +00001307 }
1308
Georg Brandled3b8382007-03-12 13:15:14 +00001309 names = PyMapping_Keys(locals);
1310 if (!names)
1311 return NULL;
1312 if (!PyList_Check(names)) {
1313 PyErr_Format(PyExc_TypeError,
1314 "dir(): expected keys() of locals to be a list, "
Christian Heimes90aa7642007-12-19 02:45:37 +00001315 "not '%.200s'", Py_TYPE(names)->tp_name);
Georg Brandled3b8382007-03-12 13:15:14 +00001316 Py_DECREF(names);
1317 return NULL;
1318 }
Georg Brandle32b4222007-03-10 22:13:27 +00001319 /* the locals don't need to be DECREF'd */
Georg Brandled3b8382007-03-12 13:15:14 +00001320 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001321}
1322
1323/* Helper for PyObject_Dir of type objects: returns __dict__ and __bases__.
Guido van Rossum98297ee2007-11-06 21:34:58 +00001324 We deliberately don't suck up its __class__, as methods belonging to the
1325 metaclass would probably be more confusing than helpful.
Georg Brandle32b4222007-03-10 22:13:27 +00001326*/
Guido van Rossum98297ee2007-11-06 21:34:58 +00001327static PyObject *
Georg Brandle32b4222007-03-10 22:13:27 +00001328_specialized_dir_type(PyObject *obj)
1329{
1330 PyObject *result = NULL;
1331 PyObject *dict = PyDict_New();
1332
1333 if (dict != NULL && merge_class_dict(dict, obj) == 0)
1334 result = PyDict_Keys(dict);
1335
1336 Py_XDECREF(dict);
Tim Peters305b5852001-09-17 02:38:46 +00001337 return result;
1338}
1339
Georg Brandle32b4222007-03-10 22:13:27 +00001340/* Helper for PyObject_Dir of module objects: returns the module's __dict__. */
1341static PyObject *
1342_specialized_dir_module(PyObject *obj)
Tim Peters7eea37e2001-09-04 22:08:56 +00001343{
Georg Brandle32b4222007-03-10 22:13:27 +00001344 PyObject *result = NULL;
1345 PyObject *dict = PyObject_GetAttrString(obj, "__dict__");
Tim Peters7eea37e2001-09-04 22:08:56 +00001346
Georg Brandle32b4222007-03-10 22:13:27 +00001347 if (dict != NULL) {
1348 if (PyDict_Check(dict))
1349 result = PyDict_Keys(dict);
1350 else {
1351 PyErr_Format(PyExc_TypeError,
1352 "%.200s.__dict__ is not a dictionary",
1353 PyModule_GetName(obj));
Guido van Rossum8dbd3d82001-09-10 18:27:43 +00001354 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001355 }
1356
Georg Brandle32b4222007-03-10 22:13:27 +00001357 Py_XDECREF(dict);
1358 return result;
1359}
Tim Peters7eea37e2001-09-04 22:08:56 +00001360
Georg Brandle32b4222007-03-10 22:13:27 +00001361/* Helper for PyObject_Dir of generic objects: returns __dict__, __class__,
1362 and recursively up the __class__.__bases__ chain.
1363*/
1364static PyObject *
1365_generic_dir(PyObject *obj)
1366{
1367 PyObject *result = NULL;
1368 PyObject *dict = NULL;
1369 PyObject *itsclass = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001370
Georg Brandle32b4222007-03-10 22:13:27 +00001371 /* Get __dict__ (which may or may not be a real dict...) */
1372 dict = PyObject_GetAttrString(obj, "__dict__");
1373 if (dict == NULL) {
1374 PyErr_Clear();
1375 dict = PyDict_New();
1376 }
1377 else if (!PyDict_Check(dict)) {
1378 Py_DECREF(dict);
1379 dict = PyDict_New();
1380 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001381 else {
Georg Brandle32b4222007-03-10 22:13:27 +00001382 /* Copy __dict__ to avoid mutating it. */
1383 PyObject *temp = PyDict_Copy(dict);
1384 Py_DECREF(dict);
1385 dict = temp;
Tim Peters7eea37e2001-09-04 22:08:56 +00001386 }
1387
Georg Brandle32b4222007-03-10 22:13:27 +00001388 if (dict == NULL)
Raymond Hettinger2a7dede2004-08-07 04:55:30 +00001389 goto error;
Tim Peters7eea37e2001-09-04 22:08:56 +00001390
Georg Brandle32b4222007-03-10 22:13:27 +00001391 /* Merge in attrs reachable from its class. */
1392 itsclass = PyObject_GetAttrString(obj, "__class__");
1393 if (itsclass == NULL)
1394 /* XXX(tomer): Perhaps fall back to obj->ob_type if no
1395 __class__ exists? */
1396 PyErr_Clear();
1397 else {
1398 if (merge_class_dict(dict, itsclass) != 0)
1399 goto error;
1400 }
1401
1402 result = PyDict_Keys(dict);
Tim Peters7eea37e2001-09-04 22:08:56 +00001403 /* fall through */
Georg Brandle32b4222007-03-10 22:13:27 +00001404error:
1405 Py_XDECREF(itsclass);
1406 Py_XDECREF(dict);
1407 return result;
1408}
1409
1410/* Helper for PyObject_Dir: object introspection.
1411 This calls one of the above specialized versions if no __dir__ method
1412 exists. */
1413static PyObject *
1414_dir_object(PyObject *obj)
1415{
1416 PyObject * result = NULL;
1417 PyObject * dirfunc = PyObject_GetAttrString((PyObject*)obj->ob_type,
1418 "__dir__");
1419
1420 assert(obj);
1421 if (dirfunc == NULL) {
1422 /* use default implementation */
1423 PyErr_Clear();
1424 if (PyModule_Check(obj))
1425 result = _specialized_dir_module(obj);
1426 else if (PyType_Check(obj))
1427 result = _specialized_dir_type(obj);
1428 else
1429 result = _generic_dir(obj);
1430 }
1431 else {
1432 /* use __dir__ */
1433 result = PyObject_CallFunctionObjArgs(dirfunc, obj, NULL);
1434 Py_DECREF(dirfunc);
1435 if (result == NULL)
1436 return NULL;
1437
1438 /* result must be a list */
1439 /* XXX(gbrandl): could also check if all items are strings */
1440 if (!PyList_Check(result)) {
1441 PyErr_Format(PyExc_TypeError,
1442 "__dir__() must return a list, not %.200s",
Christian Heimes90aa7642007-12-19 02:45:37 +00001443 Py_TYPE(result)->tp_name);
Georg Brandle32b4222007-03-10 22:13:27 +00001444 Py_DECREF(result);
1445 result = NULL;
1446 }
1447 }
1448
1449 return result;
1450}
1451
1452/* Implementation of dir() -- if obj is NULL, returns the names in the current
1453 (local) scope. Otherwise, performs introspection of the object: returns a
1454 sorted list of attribute names (supposedly) accessible from the object
1455*/
1456PyObject *
1457PyObject_Dir(PyObject *obj)
1458{
1459 PyObject * result;
1460
1461 if (obj == NULL)
1462 /* no object -- introspect the locals */
1463 result = _dir_locals();
1464 else
1465 /* object -- introspect the object */
1466 result = _dir_object(obj);
1467
1468 assert(result == NULL || PyList_Check(result));
1469
1470 if (result != NULL && PyList_Sort(result) != 0) {
1471 /* sorting the list failed */
1472 Py_DECREF(result);
1473 result = NULL;
1474 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001475
Tim Peters7eea37e2001-09-04 22:08:56 +00001476 return result;
1477}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001478
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001479/*
1480NoObject is usable as a non-NULL undefined value, used by the macro None.
1481There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001482so there is exactly one (which is indestructible, by the way).
Guido van Rossumba21a492001-08-16 08:17:26 +00001483(XXX This type and the type of NotImplemented below should be unified.)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001484*/
1485
Guido van Rossum0c182a11992-03-27 17:26:13 +00001486/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001487static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001488none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001489{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001490 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001491}
1492
Barry Warsaw9bf16442001-01-23 16:24:35 +00001493/* ARGUSED */
1494static void
Tim Peters803526b2002-07-07 05:13:56 +00001495none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001496{
1497 /* This should never get called, but we also don't want to SEGV if
1498 * we accidently decref None out of existance.
1499 */
Martin v. Löwis3f19b102002-08-07 16:21:51 +00001500 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001501}
1502
1503
Guido van Rossumba21a492001-08-16 08:17:26 +00001504static PyTypeObject PyNone_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001505 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001506 "NoneType",
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001507 0,
1508 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001509 none_dealloc, /*tp_dealloc*/ /*never called*/
Guido van Rossum7066dd71992-09-17 17:54:56 +00001510 0, /*tp_print*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001511 0, /*tp_getattr*/
1512 0, /*tp_setattr*/
1513 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001514 none_repr, /*tp_repr*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001515 0, /*tp_as_number*/
1516 0, /*tp_as_sequence*/
1517 0, /*tp_as_mapping*/
Guido van Rossum9bfef441993-03-29 10:43:31 +00001518 0, /*tp_hash */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001519};
1520
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001521PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001522 _PyObject_EXTRA_INIT
1523 1, &PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001524};
1525
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001526/* NotImplemented is an object that can be used to signal that an
1527 operation is not implemented for the given type combination. */
1528
1529static PyObject *
1530NotImplemented_repr(PyObject *op)
1531{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001532 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001533}
1534
1535static PyTypeObject PyNotImplemented_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001536 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001537 "NotImplementedType",
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001538 0,
1539 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001540 none_dealloc, /*tp_dealloc*/ /*never called*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001541 0, /*tp_print*/
1542 0, /*tp_getattr*/
1543 0, /*tp_setattr*/
1544 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001545 NotImplemented_repr, /*tp_repr*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001546 0, /*tp_as_number*/
1547 0, /*tp_as_sequence*/
1548 0, /*tp_as_mapping*/
1549 0, /*tp_hash */
1550};
1551
1552PyObject _Py_NotImplementedStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001553 _PyObject_EXTRA_INIT
1554 1, &PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001555};
1556
Guido van Rossumba21a492001-08-16 08:17:26 +00001557void
1558_Py_ReadyTypes(void)
1559{
1560 if (PyType_Ready(&PyType_Type) < 0)
1561 Py_FatalError("Can't initialize 'type'");
1562
Fred Drake0a4dd392004-07-02 18:57:45 +00001563 if (PyType_Ready(&_PyWeakref_RefType) < 0)
1564 Py_FatalError("Can't initialize 'weakref'");
1565
Guido van Rossum77f6a652002-04-03 22:41:51 +00001566 if (PyType_Ready(&PyBool_Type) < 0)
1567 Py_FatalError("Can't initialize 'bool'");
1568
Christian Heimes9c4756e2008-05-26 13:22:05 +00001569 if (PyType_Ready(&PyByteArray_Type) < 0)
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001570 Py_FatalError("Can't initialize 'bytes'");
1571
Christian Heimes72b710a2008-05-26 13:28:38 +00001572 if (PyType_Ready(&PyBytes_Type) < 0)
Guido van Rossumcacfc072002-05-24 19:01:59 +00001573 Py_FatalError("Can't initialize 'str'");
1574
Guido van Rossumba21a492001-08-16 08:17:26 +00001575 if (PyType_Ready(&PyList_Type) < 0)
1576 Py_FatalError("Can't initialize 'list'");
1577
1578 if (PyType_Ready(&PyNone_Type) < 0)
1579 Py_FatalError("Can't initialize type(None)");
1580
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001581 if (PyType_Ready(Py_Ellipsis->ob_type) < 0)
1582 Py_FatalError("Can't initialize type(Ellipsis)");
1583
Guido van Rossumba21a492001-08-16 08:17:26 +00001584 if (PyType_Ready(&PyNotImplemented_Type) < 0)
1585 Py_FatalError("Can't initialize type(NotImplemented)");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001586
1587 if (PyType_Ready(&PyCode_Type) < 0)
1588 Py_FatalError("Can't initialize 'code'");
Guido van Rossum826d8972007-10-30 18:34:07 +00001589
1590 if (PyType_Ready(&PyStdPrinter_Type) < 0)
1591 Py_FatalError("Can't initialize StdPrinter");
Guido van Rossumba21a492001-08-16 08:17:26 +00001592}
1593
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001594
Guido van Rossum84a90321996-05-22 16:34:47 +00001595#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001596
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001597void
Fred Drake100814d2000-07-09 15:48:49 +00001598_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001599{
Tim Peters34592512002-07-11 06:23:50 +00001600 _Py_INC_REFTOTAL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001601 op->ob_refcnt = 1;
Tim Peters7571a0f2003-03-23 17:52:28 +00001602 _Py_AddToAllObjects(op, 1);
Tim Peters34592512002-07-11 06:23:50 +00001603 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001604}
1605
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001606void
Fred Drake100814d2000-07-09 15:48:49 +00001607_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001608{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001609#ifdef SLOW_UNREF_CHECK
Guido van Rossum4c08d552000-03-10 22:55:18 +00001610 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001611#endif
Guido van Rossumd7047b31995-01-02 19:07:15 +00001612 if (op->ob_refcnt < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001613 Py_FatalError("UNREF negative refcnt");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001614 if (op == &refchain ||
Christian Heimesc8967002007-11-30 10:18:26 +00001615 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op) {
1616 fprintf(stderr, "* ob\n");
1617 _PyObject_Dump(op);
1618 fprintf(stderr, "* op->_ob_prev->_ob_next\n");
1619 _PyObject_Dump(op->_ob_prev->_ob_next);
1620 fprintf(stderr, "* op->_ob_next->_ob_prev\n");
1621 _PyObject_Dump(op->_ob_next->_ob_prev);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001622 Py_FatalError("UNREF invalid object");
Christian Heimesc8967002007-11-30 10:18:26 +00001623 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001624#ifdef SLOW_UNREF_CHECK
Guido van Rossum3f5da241990-12-20 15:06:42 +00001625 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1626 if (p == op)
1627 break;
1628 }
Guido van Rossumd7047b31995-01-02 19:07:15 +00001629 if (p == &refchain) /* Not found */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001630 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001631#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001632 op->_ob_next->_ob_prev = op->_ob_prev;
1633 op->_ob_prev->_ob_next = op->_ob_next;
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001634 op->_ob_next = op->_ob_prev = NULL;
Tim Peters34592512002-07-11 06:23:50 +00001635 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001636}
1637
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001638void
Fred Drake100814d2000-07-09 15:48:49 +00001639_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001640{
Christian Heimes90aa7642007-12-19 02:45:37 +00001641 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001642 _Py_ForgetReference(op);
Guido van Rossum9776adf1994-09-07 14:36:45 +00001643 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001644}
1645
Tim Peters269b2a62003-04-17 19:52:29 +00001646/* Print all live objects. Because PyObject_Print is called, the
1647 * interpreter must be in a healthy state.
1648 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001649void
Fred Drake100814d2000-07-09 15:48:49 +00001650_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001651{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001652 PyObject *op;
Guido van Rossume09fb551997-08-05 02:04:34 +00001653 fprintf(fp, "Remaining objects:\n");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001654 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001655 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001656 if (PyObject_Print(op, fp, 0) != 0)
1657 PyErr_Clear();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001658 putc('\n', fp);
1659 }
1660}
1661
Tim Peters269b2a62003-04-17 19:52:29 +00001662/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1663 * doesn't make any calls to the Python C API, so is always safe to call.
1664 */
1665void
1666_Py_PrintReferenceAddresses(FILE *fp)
1667{
1668 PyObject *op;
1669 fprintf(fp, "Remaining object addresses:\n");
1670 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001671 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
Christian Heimes90aa7642007-12-19 02:45:37 +00001672 op->ob_refcnt, Py_TYPE(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001673}
1674
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001675PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001676_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001677{
1678 int i, n;
1679 PyObject *t = NULL;
1680 PyObject *res, *op;
1681
1682 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1683 return NULL;
1684 op = refchain._ob_next;
1685 res = PyList_New(0);
1686 if (res == NULL)
1687 return NULL;
1688 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1689 while (op == self || op == args || op == res || op == t ||
Christian Heimes90aa7642007-12-19 02:45:37 +00001690 (t != NULL && Py_TYPE(op) != (PyTypeObject *) t)) {
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001691 op = op->_ob_next;
1692 if (op == &refchain)
1693 return res;
1694 }
1695 if (PyList_Append(res, op) < 0) {
1696 Py_DECREF(res);
1697 return NULL;
1698 }
1699 op = op->_ob_next;
1700 }
1701 return res;
1702}
1703
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001704#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001705
1706
1707/* Hack to force loading of cobject.o */
Guido van Rossumda9c2711996-12-05 21:58:58 +00001708PyTypeObject *_Py_cobject_hack = &PyCObject_Type;
Guido van Rossum84a90321996-05-22 16:34:47 +00001709
1710
1711/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001712Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001713
1714
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001715/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001716
Thomas Wouters334fb892000-07-25 12:56:38 +00001717void *
Fred Drake100814d2000-07-09 15:48:49 +00001718PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001719{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001720 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001721}
1722
Thomas Wouters334fb892000-07-25 12:56:38 +00001723void *
1724PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001725{
Tim Petersaf3e8de2002-04-12 07:22:56 +00001726 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001727}
1728
1729void
Thomas Wouters334fb892000-07-25 12:56:38 +00001730PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001731{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001732 PyMem_FREE(p);
1733}
1734
1735
Guido van Rossum86610361998-04-10 22:32:46 +00001736/* These methods are used to control infinite recursion in repr, str, print,
1737 etc. Container objects that may recursively contain themselves,
1738 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1739 Py_ReprLeave() to avoid infinite recursion.
1740
1741 Py_ReprEnter() returns 0 the first time it is called for a particular
1742 object and 1 every time thereafter. It returns -1 if an exception
1743 occurred. Py_ReprLeave() has no return value.
1744
1745 See dictobject.c and listobject.c for examples of use.
1746*/
1747
1748#define KEY "Py_Repr"
1749
1750int
Fred Drake100814d2000-07-09 15:48:49 +00001751Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001752{
1753 PyObject *dict;
1754 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001755 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001756
1757 dict = PyThreadState_GetDict();
1758 if (dict == NULL)
Guido van Rossum0fc8f002003-04-15 15:12:39 +00001759 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001760 list = PyDict_GetItemString(dict, KEY);
1761 if (list == NULL) {
1762 list = PyList_New(0);
1763 if (list == NULL)
1764 return -1;
1765 if (PyDict_SetItemString(dict, KEY, list) < 0)
1766 return -1;
1767 Py_DECREF(list);
1768 }
1769 i = PyList_GET_SIZE(list);
1770 while (--i >= 0) {
1771 if (PyList_GET_ITEM(list, i) == obj)
1772 return 1;
1773 }
1774 PyList_Append(list, obj);
1775 return 0;
1776}
1777
1778void
Fred Drake100814d2000-07-09 15:48:49 +00001779Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001780{
1781 PyObject *dict;
1782 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001783 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001784
1785 dict = PyThreadState_GetDict();
Guido van Rossumeb909461998-04-11 15:17:34 +00001786 if (dict == NULL)
1787 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001788 list = PyDict_GetItemString(dict, KEY);
Guido van Rossumeb909461998-04-11 15:17:34 +00001789 if (list == NULL || !PyList_Check(list))
1790 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001791 i = PyList_GET_SIZE(list);
1792 /* Count backwards because we always expect obj to be list[-1] */
1793 while (--i >= 0) {
1794 if (PyList_GET_ITEM(list, i) == obj) {
1795 PyList_SetSlice(list, i, i + 1, NULL);
1796 break;
1797 }
1798 }
1799}
Guido van Rossumd724b232000-03-13 16:01:29 +00001800
Tim Peters803526b2002-07-07 05:13:56 +00001801/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001802
Tim Peters803526b2002-07-07 05:13:56 +00001803/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001804int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001805
Tim Peters803526b2002-07-07 05:13:56 +00001806/* List of objects that still need to be cleaned up, singly linked via their
1807 * gc headers' gc_prev pointers.
1808 */
1809PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001810
Tim Peters803526b2002-07-07 05:13:56 +00001811/* Add op to the _PyTrash_delete_later list. Called when the current
1812 * call-stack depth gets large. op must be a currently untracked gc'ed
1813 * object, with refcount 0. Py_DECREF must already have been called on it.
1814 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001815void
Fred Drake100814d2000-07-09 15:48:49 +00001816_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001817{
Tim Peters803526b2002-07-07 05:13:56 +00001818 assert(PyObject_IS_GC(op));
1819 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1820 assert(op->ob_refcnt == 0);
Neil Schemenauerf589c052002-03-29 03:05:54 +00001821 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
Guido van Rossume92e6102000-04-24 15:40:53 +00001822 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001823}
1824
Tim Peters803526b2002-07-07 05:13:56 +00001825/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1826 * the call-stack unwinds again.
1827 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001828void
Fred Drake100814d2000-07-09 15:48:49 +00001829_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001830{
1831 while (_PyTrash_delete_later) {
Tim Peters803526b2002-07-07 05:13:56 +00001832 PyObject *op = _PyTrash_delete_later;
Christian Heimes90aa7642007-12-19 02:45:37 +00001833 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001834
Neil Schemenauerf589c052002-03-29 03:05:54 +00001835 _PyTrash_delete_later =
Tim Peters803526b2002-07-07 05:13:56 +00001836 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001837
Tim Peters803526b2002-07-07 05:13:56 +00001838 /* Call the deallocator directly. This used to try to
1839 * fool Py_DECREF into calling it indirectly, but
1840 * Py_DECREF was already called on this object, and in
1841 * assorted non-release builds calling Py_DECREF again ends
1842 * up distorting allocation statistics.
1843 */
1844 assert(op->ob_refcnt == 0);
Guido van Rossumd724b232000-03-13 16:01:29 +00001845 ++_PyTrash_delete_nesting;
Tim Peters803526b2002-07-07 05:13:56 +00001846 (*dealloc)(op);
Guido van Rossumd724b232000-03-13 16:01:29 +00001847 --_PyTrash_delete_nesting;
1848 }
1849}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001850
1851#ifdef __cplusplus
1852}
1853#endif