blob: 14cacb3b84dd7f59d3da1e1b0fa3cebdd2638644 [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. */
Benjamin Petersona4a37fe2009-01-11 17:13:55 +000084static int unlist_types_without_objects;
85extern Py_ssize_t tuple_zero_allocs, fast_tuple_allocs;
86extern Py_ssize_t quick_int_allocs, quick_neg_int_allocs;
87extern Py_ssize_t 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)
Benjamin Petersona4a37fe2009-01-11 17:13:55 +000094 fprintf(f, "%s alloc'd: %" PY_FORMAT_SIZE_T "d, "
95 "freed: %" PY_FORMAT_SIZE_T "d, "
96 "max in use: %" PY_FORMAT_SIZE_T "d\n",
Tim Peters6d6c1a32001-08-02 04:15:00 +000097 tp->tp_name, tp->tp_allocs, tp->tp_frees,
Sjoerd Mullender52c1f511993-10-25 08:40:52 +000098 tp->tp_maxalloc);
Benjamin Petersona4a37fe2009-01-11 17:13:55 +000099 fprintf(f, "fast tuple allocs: %" PY_FORMAT_SIZE_T "d, "
100 "empty: %" PY_FORMAT_SIZE_T "d\n",
Sjoerd Mullender52c1f511993-10-25 08:40:52 +0000101 fast_tuple_allocs, tuple_zero_allocs);
Benjamin Petersona4a37fe2009-01-11 17:13:55 +0000102 fprintf(f, "fast int allocs: pos: %" PY_FORMAT_SIZE_T "d, "
103 "neg: %" PY_FORMAT_SIZE_T "d\n",
Sjoerd Mullender52c1f511993-10-25 08:40:52 +0000104 quick_int_allocs, quick_neg_int_allocs);
Benjamin Petersona4a37fe2009-01-11 17:13:55 +0000105 fprintf(f, "null strings: %" PY_FORMAT_SIZE_T "d, "
106 "1-strings: %" PY_FORMAT_SIZE_T "d\n",
Sjoerd Mullender52c1f511993-10-25 08:40:52 +0000107 null_strings, one_strings);
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000108}
109
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000110PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000111get_counts(void)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000112{
113 PyTypeObject *tp;
114 PyObject *result;
115 PyObject *v;
116
117 result = PyList_New(0);
118 if (result == NULL)
119 return NULL;
120 for (tp = type_list; tp; tp = tp->tp_next) {
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000121 v = Py_BuildValue("(snnn)", tp->tp_name, tp->tp_allocs,
Tim Peters6d6c1a32001-08-02 04:15:00 +0000122 tp->tp_frees, tp->tp_maxalloc);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000123 if (v == NULL) {
124 Py_DECREF(result);
125 return NULL;
126 }
127 if (PyList_Append(result, v) < 0) {
128 Py_DECREF(v);
129 Py_DECREF(result);
130 return NULL;
131 }
132 Py_DECREF(v);
133 }
134 return result;
135}
136
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000137void
Fred Drake100814d2000-07-09 15:48:49 +0000138inc_count(PyTypeObject *tp)
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000139{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000140 if (tp->tp_next == NULL && tp->tp_prev == NULL) {
Guido van Rossumd8953cb1995-04-06 14:46:26 +0000141 /* first time; insert in linked list */
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000142 if (tp->tp_next != NULL) /* sanity check */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000143 Py_FatalError("XXX inc_count sanity check");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000144 if (type_list)
145 type_list->tp_prev = tp;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000146 tp->tp_next = type_list;
Tim Petersc6a3ff62002-07-08 22:11:52 +0000147 /* Note that as of Python 2.2, heap-allocated type objects
148 * can go away, but this code requires that they stay alive
149 * until program exit. That's why we're careful with
150 * refcounts here. type_list gets a new reference to tp,
151 * while ownership of the reference type_list used to hold
152 * (if any) was transferred to tp->tp_next in the line above.
153 * tp is thus effectively immortal after this.
154 */
155 Py_INCREF(tp);
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000156 type_list = tp;
Tim Peters3e40c7f2003-03-23 03:04:32 +0000157#ifdef Py_TRACE_REFS
Tim Peters7571a0f2003-03-23 17:52:28 +0000158 /* Also insert in the doubly-linked list of all objects,
159 * if not already there.
160 */
161 _Py_AddToAllObjects((PyObject *)tp, 0);
Tim Peters78be7992003-03-23 02:51:01 +0000162#endif
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000163 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000164 tp->tp_allocs++;
165 if (tp->tp_allocs - tp->tp_frees > tp->tp_maxalloc)
166 tp->tp_maxalloc = tp->tp_allocs - tp->tp_frees;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000167}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000168
169void dec_count(PyTypeObject *tp)
170{
171 tp->tp_frees++;
172 if (unlist_types_without_objects &&
173 tp->tp_allocs == tp->tp_frees) {
174 /* unlink the type from type_list */
175 if (tp->tp_prev)
176 tp->tp_prev->tp_next = tp->tp_next;
177 else
178 type_list = tp->tp_next;
179 if (tp->tp_next)
180 tp->tp_next->tp_prev = tp->tp_prev;
181 tp->tp_next = tp->tp_prev = NULL;
182 Py_DECREF(tp);
183 }
184}
185
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000186#endif
187
Tim Peters7c321a82002-07-09 02:57:01 +0000188#ifdef Py_REF_DEBUG
189/* Log a fatal error; doesn't return. */
190void
191_Py_NegativeRefcount(const char *fname, int lineno, PyObject *op)
192{
193 char buf[300];
194
195 PyOS_snprintf(buf, sizeof(buf),
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000196 "%s:%i object at %p has negative ref count "
197 "%" PY_FORMAT_SIZE_T "d",
198 fname, lineno, op, op->ob_refcnt);
Tim Peters7c321a82002-07-09 02:57:01 +0000199 Py_FatalError(buf);
200}
201
202#endif /* Py_REF_DEBUG */
203
Thomas Heller1328b522004-04-22 17:23:49 +0000204void
205Py_IncRef(PyObject *o)
206{
207 Py_XINCREF(o);
208}
209
210void
211Py_DecRef(PyObject *o)
212{
213 Py_XDECREF(o);
214}
215
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000216PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000217PyObject_Init(PyObject *op, PyTypeObject *tp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000218{
Guido van Rossum6e08c142002-10-11 20:37:24 +0000219 if (op == NULL)
220 return PyErr_NoMemory();
Guido van Rossumb18618d2000-05-03 23:44:39 +0000221 /* Any changes should be reflected in PyObject_INIT (objimpl.h) */
Christian Heimes90aa7642007-12-19 02:45:37 +0000222 Py_TYPE(op) = tp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000223 _Py_NewReference(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000224 return op;
225}
226
Guido van Rossumb18618d2000-05-03 23:44:39 +0000227PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000228PyObject_InitVar(PyVarObject *op, PyTypeObject *tp, Py_ssize_t size)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000229{
Guido van Rossum6e08c142002-10-11 20:37:24 +0000230 if (op == NULL)
231 return (PyVarObject *) PyErr_NoMemory();
Guido van Rossumb18618d2000-05-03 23:44:39 +0000232 /* Any changes should be reflected in PyObject_INIT_VAR */
233 op->ob_size = size;
Christian Heimes90aa7642007-12-19 02:45:37 +0000234 Py_TYPE(op) = tp;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000235 _Py_NewReference((PyObject *)op);
236 return op;
237}
238
239PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000240_PyObject_New(PyTypeObject *tp)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000241{
242 PyObject *op;
243 op = (PyObject *) PyObject_MALLOC(_PyObject_SIZE(tp));
244 if (op == NULL)
245 return PyErr_NoMemory();
246 return PyObject_INIT(op, tp);
247}
248
Guido van Rossumd0c87ee1997-05-15 21:31:03 +0000249PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000250_PyObject_NewVar(PyTypeObject *tp, Py_ssize_t nitems)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000251{
Guido van Rossumb18618d2000-05-03 23:44:39 +0000252 PyVarObject *op;
Tim Petersf2a67da2001-10-07 03:54:51 +0000253 const size_t size = _PyObject_VAR_SIZE(tp, nitems);
Tim Peters6d483d32001-10-06 21:27:34 +0000254 op = (PyVarObject *) PyObject_MALLOC(size);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000255 if (op == NULL)
Guido van Rossumd0c87ee1997-05-15 21:31:03 +0000256 return (PyVarObject *)PyErr_NoMemory();
Tim Peters6d483d32001-10-06 21:27:34 +0000257 return PyObject_INIT_VAR(op, tp, nitems);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000258}
259
Neal Norwitz1a997502003-01-13 20:13:12 +0000260/* Implementation of PyObject_Print with recursion checking */
261static int
262internal_print(PyObject *op, FILE *fp, int flags, int nesting)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000263{
Guido van Rossum278ef591991-07-27 21:40:24 +0000264 int ret = 0;
Neal Norwitz1a997502003-01-13 20:13:12 +0000265 if (nesting > 10) {
266 PyErr_SetString(PyExc_RuntimeError, "print recursion");
267 return -1;
268 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000269 if (PyErr_CheckSignals())
Guido van Rossum90933611991-06-07 16:10:43 +0000270 return -1;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000271#ifdef USE_STACKCHECK
272 if (PyOS_CheckStack()) {
Fred Drake661ea262000-10-24 19:57:45 +0000273 PyErr_SetString(PyExc_MemoryError, "stack overflow");
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000274 return -1;
275 }
276#endif
Guido van Rossum687ef6e2000-01-12 16:28:58 +0000277 clearerr(fp); /* Clear any previous error condition */
Guido van Rossum90933611991-06-07 16:10:43 +0000278 if (op == NULL) {
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000279 Py_BEGIN_ALLOW_THREADS
Guido van Rossum90933611991-06-07 16:10:43 +0000280 fprintf(fp, "<nil>");
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000281 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000282 }
Guido van Rossum90933611991-06-07 16:10:43 +0000283 else {
284 if (op->ob_refcnt <= 0)
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000285 /* XXX(twouters) cast refcount to long until %zd is
286 universally available */
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000287 Py_BEGIN_ALLOW_THREADS
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000288 fprintf(fp, "<refcnt %ld at %p>",
289 (long)op->ob_refcnt, op);
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000290 Py_END_ALLOW_THREADS
Guido van Rossum04dbf3b2007-08-07 19:51:00 +0000291 else {
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000292 PyObject *s;
293 if (flags & Py_PRINT_RAW)
294 s = PyObject_Str(op);
295 else
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000296 s = PyObject_Repr(op);
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000297 if (s == NULL)
298 ret = -1;
Christian Heimes72b710a2008-05-26 13:28:38 +0000299 else if (PyBytes_Check(s)) {
300 fwrite(PyBytes_AS_STRING(s), 1,
301 PyBytes_GET_SIZE(s), fp);
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000302 }
303 else if (PyUnicode_Check(s)) {
304 PyObject *t;
305 t = _PyUnicode_AsDefaultEncodedString(s, NULL);
306 if (t == NULL)
307 ret = 0;
308 else {
Christian Heimes72b710a2008-05-26 13:28:38 +0000309 fwrite(PyBytes_AS_STRING(t), 1,
310 PyBytes_GET_SIZE(t), fp);
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000311 }
312 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000313 else {
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000314 PyErr_Format(PyExc_TypeError,
315 "str() or repr() returned '%.100s'",
316 s->ob_type->tp_name);
317 ret = -1;
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000318 }
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000319 Py_XDECREF(s);
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000320 }
Guido van Rossum90933611991-06-07 16:10:43 +0000321 }
Guido van Rossum278ef591991-07-27 21:40:24 +0000322 if (ret == 0) {
323 if (ferror(fp)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000324 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum278ef591991-07-27 21:40:24 +0000325 clearerr(fp);
326 ret = -1;
327 }
328 }
329 return ret;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000330}
331
Neal Norwitz1a997502003-01-13 20:13:12 +0000332int
333PyObject_Print(PyObject *op, FILE *fp, int flags)
334{
335 return internal_print(op, fp, flags, 0);
336}
337
Guido van Rossum38938152006-08-21 23:36:26 +0000338/* For debugging convenience. Set a breakpoint here and call it from your DLL */
339void
Thomas Woutersb2137042007-02-01 18:02:27 +0000340_Py_BreakPoint(void)
Guido van Rossum38938152006-08-21 23:36:26 +0000341{
342}
343
Neal Norwitz1a997502003-01-13 20:13:12 +0000344
Barry Warsaw9bf16442001-01-23 16:24:35 +0000345/* For debugging convenience. See Misc/gdbinit for some useful gdb hooks */
Guido van Rossum38938152006-08-21 23:36:26 +0000346void
347_PyObject_Dump(PyObject* op)
Barry Warsaw9bf16442001-01-23 16:24:35 +0000348{
Barry Warsaweefb1072001-02-22 22:39:18 +0000349 if (op == NULL)
350 fprintf(stderr, "NULL\n");
351 else {
Georg Brandldfd73442009-04-05 11:47:34 +0000352#ifdef WITH_THREAD
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +0000353 PyGILState_STATE gil;
Georg Brandldfd73442009-04-05 11:47:34 +0000354#endif
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000355 fprintf(stderr, "object : ");
Georg Brandldfd73442009-04-05 11:47:34 +0000356#ifdef WITH_THREAD
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +0000357 gil = PyGILState_Ensure();
Georg Brandldfd73442009-04-05 11:47:34 +0000358#endif
Barry Warsaweefb1072001-02-22 22:39:18 +0000359 (void)PyObject_Print(op, stderr, 0);
Georg Brandldfd73442009-04-05 11:47:34 +0000360#ifdef WITH_THREAD
Benjamin Peterson6ebe78f2008-12-21 00:06:59 +0000361 PyGILState_Release(gil);
Georg Brandldfd73442009-04-05 11:47:34 +0000362#endif
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000363 /* XXX(twouters) cast refcount to long until %zd is
364 universally available */
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000365 fprintf(stderr, "\n"
366 "type : %s\n"
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000367 "refcount: %ld\n"
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000368 "address : %p\n",
Christian Heimes90aa7642007-12-19 02:45:37 +0000369 Py_TYPE(op)==NULL ? "NULL" : Py_TYPE(op)->tp_name,
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000370 (long)op->ob_refcnt,
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000371 op);
Barry Warsaweefb1072001-02-22 22:39:18 +0000372 }
Barry Warsaw9bf16442001-01-23 16:24:35 +0000373}
Barry Warsaw903138f2001-01-23 16:33:18 +0000374
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000375PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000376PyObject_Repr(PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000377{
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000378 PyObject *res;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000379 if (PyErr_CheckSignals())
Guido van Rossum90933611991-06-07 16:10:43 +0000380 return NULL;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000381#ifdef USE_STACKCHECK
382 if (PyOS_CheckStack()) {
Fred Drake661ea262000-10-24 19:57:45 +0000383 PyErr_SetString(PyExc_MemoryError, "stack overflow");
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000384 return NULL;
385 }
386#endif
Guido van Rossum90933611991-06-07 16:10:43 +0000387 if (v == NULL)
Walter Dörwald1ab83302007-05-18 17:15:44 +0000388 return PyUnicode_FromString("<NULL>");
Christian Heimes90aa7642007-12-19 02:45:37 +0000389 if (Py_TYPE(v)->tp_repr == NULL)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000390 return PyUnicode_FromFormat("<%s object at %p>",
391 v->ob_type->tp_name, v);
392 res = (*v->ob_type->tp_repr)(v);
393 if (res != NULL && !PyUnicode_Check(res)) {
394 PyErr_Format(PyExc_TypeError,
395 "__repr__ returned non-string (type %.200s)",
396 res->ob_type->tp_name);
397 Py_DECREF(res);
398 return NULL;
399 }
400 return res;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000401}
402
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000403PyObject *
Guido van Rossum98297ee2007-11-06 21:34:58 +0000404PyObject_Str(PyObject *v)
Guido van Rossumc6004111993-11-05 10:22:19 +0000405{
Guido van Rossum4c08d552000-03-10 22:55:18 +0000406 PyObject *res;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000407 if (PyErr_CheckSignals())
408 return NULL;
409#ifdef USE_STACKCHECK
410 if (PyOS_CheckStack()) {
411 PyErr_SetString(PyExc_MemoryError, "stack overflow");
412 return NULL;
413 }
414#endif
Guido van Rossumc6004111993-11-05 10:22:19 +0000415 if (v == NULL)
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000416 return PyUnicode_FromString("<NULL>");
Neil Schemenauercf52c072005-08-12 17:34:58 +0000417 if (PyUnicode_CheckExact(v)) {
418 Py_INCREF(v);
419 return v;
420 }
Christian Heimes90aa7642007-12-19 02:45:37 +0000421 if (Py_TYPE(v)->tp_str == NULL)
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000422 return PyObject_Repr(v);
423
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000424 /* It is possible for a type to have a tp_str representation that loops
425 infinitely. */
426 if (Py_EnterRecursiveCall(" while getting the str of an object"))
427 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +0000428 res = (*Py_TYPE(v)->tp_str)(v);
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000429 Py_LeaveRecursiveCall();
Guido van Rossum4c08d552000-03-10 22:55:18 +0000430 if (res == NULL)
431 return NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000432 if (!PyUnicode_Check(res)) {
Neil Schemenauercf52c072005-08-12 17:34:58 +0000433 PyErr_Format(PyExc_TypeError,
434 "__str__ returned non-string (type %.200s)",
Christian Heimes90aa7642007-12-19 02:45:37 +0000435 Py_TYPE(res)->tp_name);
Neil Schemenauercf52c072005-08-12 17:34:58 +0000436 Py_DECREF(res);
437 return NULL;
438 }
439 return res;
440}
441
Georg Brandl559e5d72008-06-11 18:37:52 +0000442PyObject *
443PyObject_ASCII(PyObject *v)
444{
445 PyObject *repr, *ascii, *res;
446
447 repr = PyObject_Repr(v);
448 if (repr == NULL)
449 return NULL;
450
451 /* repr is guaranteed to be a PyUnicode object by PyObject_Repr */
452 ascii = PyUnicode_EncodeASCII(
453 PyUnicode_AS_UNICODE(repr),
454 PyUnicode_GET_SIZE(repr),
455 "backslashreplace");
456
457 Py_DECREF(repr);
458 if (ascii == NULL)
459 return NULL;
460
461 res = PyUnicode_DecodeASCII(
462 PyBytes_AS_STRING(ascii),
463 PyBytes_GET_SIZE(ascii),
464 NULL);
465
466 Py_DECREF(ascii);
467 return res;
468}
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000469
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000470PyObject *
471PyObject_Bytes(PyObject *v)
472{
Christian Heimesff869fa2008-08-28 11:28:26 +0000473 PyObject *result, *func;
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000474 static PyObject *bytesstring = NULL;
475
476 if (bytesstring == NULL) {
477 bytesstring = PyUnicode_InternFromString("__bytes__");
478 if (bytesstring == NULL)
479 return NULL;
480 }
481
482 if (v == NULL)
483 return PyBytes_FromString("<NULL>");
484
485 if (PyBytes_CheckExact(v)) {
486 Py_INCREF(v);
487 return v;
488 }
489
490 /* Doesn't create a reference */
491 func = _PyType_Lookup(Py_TYPE(v), bytesstring);
492 if (func != NULL) {
493 result = PyObject_CallFunctionObjArgs(func, v, NULL);
494 if (result == NULL)
495 return NULL;
496 if (!PyBytes_Check(result)) {
497 PyErr_Format(PyExc_TypeError,
498 "__bytes__ returned non-bytes (type %.200s)",
499 Py_TYPE(result)->tp_name);
500 Py_DECREF(result);
501 return NULL;
502 }
503 return result;
504 }
505 PyErr_Clear();
506 return PyBytes_FromObject(v);
507}
508
Mark Dickinsonc008a172009-02-01 13:59:22 +0000509/* For Python 3.0.1 and later, the old three-way comparison has been
510 completely removed in favour of rich comparisons. PyObject_Compare() and
511 PyObject_Cmp() are gone, and the builtin cmp function no longer exists.
Mark Dickinsone94c6792009-02-02 20:36:42 +0000512 The old tp_compare slot has been renamed to tp_reserved, and should no
Mark Dickinsonc008a172009-02-01 13:59:22 +0000513 longer be used. Use tp_richcompare instead.
Guido van Rossum98297ee2007-11-06 21:34:58 +0000514
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000515 See (*) below for practical amendments.
516
Mark Dickinsonc008a172009-02-01 13:59:22 +0000517 tp_richcompare gets called with a first argument of the appropriate type
518 and a second object of an arbitrary type. We never do any kind of
519 coercion.
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000520
Mark Dickinsonc008a172009-02-01 13:59:22 +0000521 The tp_richcompare slot should return an object, as follows:
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000522
523 NULL if an exception occurred
524 NotImplemented if the requested comparison is not implemented
525 any other false value if the requested comparison is false
526 any other true value if the requested comparison is true
527
528 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
529 NotImplemented.
530
531 (*) Practical amendments:
532
533 - If rich comparison returns NotImplemented, == and != are decided by
534 comparing the object pointer (i.e. falling back to the base object
535 implementation).
536
Guido van Rossuma4073002002-05-31 20:03:54 +0000537*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000538
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000539/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000540int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000541
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000542static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000543
544/* Perform a rich comparison, raising TypeError when the requested comparison
545 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000546static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000547do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000548{
549 richcmpfunc f;
550 PyObject *res;
551
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000552 if (v->ob_type != w->ob_type &&
553 PyType_IsSubtype(w->ob_type, v->ob_type) &&
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000554 (f = w->ob_type->tp_richcompare) != NULL) {
Tim Petersf4aca752004-09-23 02:39:37 +0000555 res = (*f)(w, v, _Py_SwappedOp[op]);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000556 if (res != Py_NotImplemented)
557 return res;
558 Py_DECREF(res);
559 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000560 if ((f = v->ob_type->tp_richcompare) != NULL) {
Guido van Rossume797ec12001-01-17 15:24:28 +0000561 res = (*f)(v, w, op);
562 if (res != Py_NotImplemented)
563 return res;
564 Py_DECREF(res);
565 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000566 if ((f = w->ob_type->tp_richcompare) != NULL) {
567 res = (*f)(w, v, _Py_SwappedOp[op]);
568 if (res != Py_NotImplemented)
569 return res;
570 Py_DECREF(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000571 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000572 /* If neither object implements it, provide a sensible default
573 for == and !=, but raise an exception for ordering. */
574 switch (op) {
575 case Py_EQ:
576 res = (v == w) ? Py_True : Py_False;
577 break;
578 case Py_NE:
579 res = (v != w) ? Py_True : Py_False;
580 break;
581 default:
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000582 /* XXX Special-case None so it doesn't show as NoneType() */
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000583 PyErr_Format(PyExc_TypeError,
584 "unorderable types: %.100s() %s %.100s()",
585 v->ob_type->tp_name,
586 opstrings[op],
587 w->ob_type->tp_name);
588 return NULL;
589 }
Guido van Rossume797ec12001-01-17 15:24:28 +0000590 Py_INCREF(res);
591 return res;
592}
593
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000594/* Perform a rich comparison with object result. This wraps do_richcompare()
595 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000596
Guido van Rossume797ec12001-01-17 15:24:28 +0000597PyObject *
598PyObject_RichCompare(PyObject *v, PyObject *w, int op)
599{
600 PyObject *res;
601
602 assert(Py_LT <= op && op <= Py_GE);
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000603 if (v == NULL || w == NULL) {
604 if (!PyErr_Occurred())
605 PyErr_BadInternalCall();
606 return NULL;
607 }
Armin Rigo2b3eb402003-10-28 12:05:48 +0000608 if (Py_EnterRecursiveCall(" in cmp"))
609 return NULL;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000610 res = do_richcompare(v, w, op);
Armin Rigo2b3eb402003-10-28 12:05:48 +0000611 Py_LeaveRecursiveCall();
Guido van Rossume797ec12001-01-17 15:24:28 +0000612 return res;
613}
614
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000615/* Perform a rich comparison with integer result. This wraps
616 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000617int
618PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
619{
Raymond Hettinger93d44812004-03-21 17:01:44 +0000620 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000621 int ok;
622
Mark Dickinson4a1f5932008-11-12 23:23:36 +0000623 /* Quick result when objects are the same.
624 Guarantees that identity implies equality. */
625 if (v == w) {
626 if (op == Py_EQ)
627 return 1;
628 else if (op == Py_NE)
629 return 0;
630 }
631
Raymond Hettinger93d44812004-03-21 17:01:44 +0000632 res = PyObject_RichCompare(v, w, op);
Guido van Rossume797ec12001-01-17 15:24:28 +0000633 if (res == NULL)
634 return -1;
Guido van Rossum81912d42002-08-24 05:33:28 +0000635 if (PyBool_Check(res))
636 ok = (res == Py_True);
637 else
638 ok = PyObject_IsTrue(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000639 Py_DECREF(res);
640 return ok;
641}
Fred Drake13634cf2000-06-29 19:17:04 +0000642
643/* Set of hash utility functions to help maintaining the invariant that
Raymond Hettinger8183fa42004-03-21 17:35:06 +0000644 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000645
646 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
647*/
648
649long
Fred Drake100814d2000-07-09 15:48:49 +0000650_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000651{
Tim Peters39dce292000-08-15 03:34:48 +0000652 double intpart, fractpart;
653 int expo;
654 long hipart;
655 long x; /* the final hash value */
656 /* This is designed so that Python numbers of different types
657 * that compare equal hash to the same value; otherwise comparisons
658 * of mapping keys will turn out weird.
659 */
660
Tim Peters39dce292000-08-15 03:34:48 +0000661 fractpart = modf(v, &intpart);
Tim Peters39dce292000-08-15 03:34:48 +0000662 if (fractpart == 0.0) {
663 /* This must return the same hash as an equal int or long. */
Mark Dickinsonc96db472009-02-08 15:09:21 +0000664 if (intpart > LONG_MAX/2 || -intpart > LONG_MAX/2) {
Tim Peters39dce292000-08-15 03:34:48 +0000665 /* Convert to long and use its hash. */
666 PyObject *plong; /* converted to Python long */
667 if (Py_IS_INFINITY(intpart))
668 /* can't convert to long int -- arbitrary */
669 v = v < 0 ? -271828.0 : 314159.0;
670 plong = PyLong_FromDouble(v);
671 if (plong == NULL)
672 return -1;
673 x = PyObject_Hash(plong);
674 Py_DECREF(plong);
675 return x;
676 }
677 /* Fits in a C long == a Python int, so is its own hash. */
678 x = (long)intpart;
679 if (x == -1)
680 x = -2;
681 return x;
682 }
683 /* The fractional part is non-zero, so we don't have to worry about
684 * making this match the hash of some other type.
685 * Use frexp to get at the bits in the double.
Fred Drake13634cf2000-06-29 19:17:04 +0000686 * Since the VAX D double format has 56 mantissa bits, which is the
687 * most of any double format in use, each of these parts may have as
688 * many as (but no more than) 56 significant bits.
Tim Peters39dce292000-08-15 03:34:48 +0000689 * So, assuming sizeof(long) >= 4, each part can be broken into two
690 * longs; frexp and multiplication are used to do that.
691 * Also, since the Cray double format has 15 exponent bits, which is
692 * the most of any double format in use, shifting the exponent field
693 * left by 15 won't overflow a long (again assuming sizeof(long) >= 4).
Fred Drake13634cf2000-06-29 19:17:04 +0000694 */
Tim Peters39dce292000-08-15 03:34:48 +0000695 v = frexp(v, &expo);
696 v *= 2147483648.0; /* 2**31 */
697 hipart = (long)v; /* take the top 32 bits */
698 v = (v - (double)hipart) * 2147483648.0; /* get the next 32 bits */
699 x = hipart + (long)v + (expo << 15);
700 if (x == -1)
701 x = -2;
702 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000703}
704
705long
Fred Drake100814d2000-07-09 15:48:49 +0000706_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000707{
Fred Drake13634cf2000-06-29 19:17:04 +0000708 long x;
Antoine Pitrou79eee6b2009-02-13 14:01:05 +0000709 size_t y = (size_t)p;
710 /* bottom 3 or 4 bits are likely to be 0; rotate y by 4 to avoid
711 excessive hash collisions for dicts and sets */
712 y = (y >> 4) | (y << (8 * SIZEOF_VOID_P - 4));
713 x = (long)y;
714 if (x == -1)
715 x = -2;
Fred Drake13634cf2000-06-29 19:17:04 +0000716 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000717}
718
Nick Coghland1abd252008-07-15 15:46:38 +0000719long
720PyObject_HashNotImplemented(PyObject *v)
721{
722 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
723 Py_TYPE(v)->tp_name);
724 return -1;
725}
Fred Drake13634cf2000-06-29 19:17:04 +0000726
Guido van Rossum9bfef441993-03-29 10:43:31 +0000727long
Fred Drake100814d2000-07-09 15:48:49 +0000728PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000729{
Nick Coghland1abd252008-07-15 15:46:38 +0000730 PyTypeObject *tp = Py_TYPE(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000731 if (tp->tp_hash != NULL)
732 return (*tp->tp_hash)(v);
Nick Coghlanf1f2f682008-12-30 07:29:12 +0000733 /* To keep to the general practice that inheriting
734 * solely from object in C code should work without
735 * an explicit call to PyType_Ready, we implicitly call
736 * PyType_Ready here and then check the tp_hash slot again
737 */
738 if (tp->tp_dict == NULL) {
739 if (PyType_Ready(tp) < 0)
740 return -1;
741 if (tp->tp_hash != NULL)
742 return (*tp->tp_hash)(v);
743 }
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000744 /* Otherwise, the object can't be hashed */
Nick Coghland1abd252008-07-15 15:46:38 +0000745 return PyObject_HashNotImplemented(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000746}
747
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000748PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000749PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000750{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000751 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000752
Christian Heimes90aa7642007-12-19 02:45:37 +0000753 if (Py_TYPE(v)->tp_getattr != NULL)
754 return (*Py_TYPE(v)->tp_getattr)(v, (char*)name);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000755 w = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000756 if (w == NULL)
757 return NULL;
758 res = PyObject_GetAttr(v, w);
759 Py_XDECREF(w);
760 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000761}
762
763int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000764PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000765{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000766 PyObject *res = PyObject_GetAttrString(v, name);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000767 if (res != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000768 Py_DECREF(res);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000769 return 1;
770 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000771 PyErr_Clear();
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000772 return 0;
773}
774
775int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000776PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000777{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000778 PyObject *s;
779 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000780
Christian Heimes90aa7642007-12-19 02:45:37 +0000781 if (Py_TYPE(v)->tp_setattr != NULL)
782 return (*Py_TYPE(v)->tp_setattr)(v, (char*)name, w);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000783 s = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000784 if (s == NULL)
785 return -1;
786 res = PyObject_SetAttr(v, s, w);
787 Py_XDECREF(s);
788 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000789}
790
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000791PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000792PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000793{
Christian Heimes90aa7642007-12-19 02:45:37 +0000794 PyTypeObject *tp = Py_TYPE(v);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000795
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000796 if (!PyUnicode_Check(name)) {
Martin v. Löwis5b222132007-06-10 09:51:05 +0000797 PyErr_Format(PyExc_TypeError,
798 "attribute name must be string, not '%.200s'",
799 name->ob_type->tp_name);
800 return NULL;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000801 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000802 if (tp->tp_getattro != NULL)
803 return (*tp->tp_getattro)(v, name);
804 if (tp->tp_getattr != NULL)
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000805 return (*tp->tp_getattr)(v, _PyUnicode_AsString(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +0000806 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000807 "'%.50s' object has no attribute '%U'",
808 tp->tp_name, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000809 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000810}
811
812int
Fred Drake100814d2000-07-09 15:48:49 +0000813PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000814{
815 PyObject *res = PyObject_GetAttr(v, name);
816 if (res != NULL) {
817 Py_DECREF(res);
818 return 1;
819 }
820 PyErr_Clear();
821 return 0;
822}
823
824int
Fred Drake100814d2000-07-09 15:48:49 +0000825PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000826{
Christian Heimes90aa7642007-12-19 02:45:37 +0000827 PyTypeObject *tp = Py_TYPE(v);
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000828 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000829
Martin v. Löwis5b222132007-06-10 09:51:05 +0000830 if (!PyUnicode_Check(name)) {
831 PyErr_Format(PyExc_TypeError,
832 "attribute name must be string, not '%.200s'",
833 name->ob_type->tp_name);
834 return -1;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000835 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000836 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000837
Martin v. Löwis5b222132007-06-10 09:51:05 +0000838 PyUnicode_InternInPlace(&name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000839 if (tp->tp_setattro != NULL) {
840 err = (*tp->tp_setattro)(v, name, value);
841 Py_DECREF(name);
842 return err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000843 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000844 if (tp->tp_setattr != NULL) {
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000845 err = (*tp->tp_setattr)(v, _PyUnicode_AsString(name), value);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000846 Py_DECREF(name);
847 return err;
848 }
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000849 Py_DECREF(name);
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000850 assert(name->ob_refcnt >= 1);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000851 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
852 PyErr_Format(PyExc_TypeError,
853 "'%.100s' object has no attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000854 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000855 tp->tp_name,
856 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000857 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000858 else
859 PyErr_Format(PyExc_TypeError,
860 "'%.100s' object has only read-only attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000861 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000862 tp->tp_name,
863 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000864 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000865 return -1;
866}
867
868/* Helper to get a pointer to an object's __dict__ slot, if any */
869
870PyObject **
871_PyObject_GetDictPtr(PyObject *obj)
872{
Martin v. Löwis725507b2006-03-07 12:08:51 +0000873 Py_ssize_t dictoffset;
Christian Heimes90aa7642007-12-19 02:45:37 +0000874 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000875
Tim Peters6d6c1a32001-08-02 04:15:00 +0000876 dictoffset = tp->tp_dictoffset;
877 if (dictoffset == 0)
878 return NULL;
879 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000880 Py_ssize_t tsize;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000881 size_t size;
882
883 tsize = ((PyVarObject *)obj)->ob_size;
884 if (tsize < 0)
885 tsize = -tsize;
886 size = _PyObject_VAR_SIZE(tp, tsize);
887
Tim Peters6d483d32001-10-06 21:27:34 +0000888 dictoffset += (long)size;
889 assert(dictoffset > 0);
890 assert(dictoffset % SIZEOF_VOID_P == 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000891 }
892 return (PyObject **) ((char *)obj + dictoffset);
893}
894
Tim Peters6d6c1a32001-08-02 04:15:00 +0000895PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000896PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +0000897{
898 Py_INCREF(obj);
899 return obj;
900}
901
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +0000902/* Helper used when the __next__ method is removed from a type:
903 tp_iternext is never NULL and can be safely called without checking
904 on every iteration.
905 */
906
907PyObject *
908_PyObject_NextNotImplemented(PyObject *self)
909{
910 PyErr_Format(PyExc_TypeError,
911 "'%.200s' object is not iterable",
912 Py_TYPE(self)->tp_name);
913 return NULL;
914}
915
Michael W. Hudson1593f502004-09-14 17:09:47 +0000916/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
917
Raymond Hettinger01538262003-03-17 08:24:35 +0000918PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000919PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
920{
Christian Heimes90aa7642007-12-19 02:45:37 +0000921 PyTypeObject *tp = Py_TYPE(obj);
Guido van Rossum056fbf42002-08-19 19:22:50 +0000922 PyObject *descr = NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000923 PyObject *res = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000924 descrgetfunc f;
Martin v. Löwis725507b2006-03-07 12:08:51 +0000925 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000926 PyObject **dictptr;
927
Martin v. Löwis5b222132007-06-10 09:51:05 +0000928 if (!PyUnicode_Check(name)){
929 PyErr_Format(PyExc_TypeError,
930 "attribute name must be string, not '%.200s'",
931 name->ob_type->tp_name);
932 return NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000933 }
934 else
935 Py_INCREF(name);
936
Tim Peters6d6c1a32001-08-02 04:15:00 +0000937 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +0000938 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000939 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000940 }
941
Christian Heimesa62da1d2008-01-12 19:39:10 +0000942#if 0 /* XXX this is not quite _PyType_Lookup anymore */
Guido van Rossum056fbf42002-08-19 19:22:50 +0000943 /* Inline _PyType_Lookup */
944 {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000945 Py_ssize_t i, n;
Guido van Rossum056fbf42002-08-19 19:22:50 +0000946 PyObject *mro, *base, *dict;
947
948 /* Look in tp_dict of types in MRO */
949 mro = tp->tp_mro;
950 assert(mro != NULL);
951 assert(PyTuple_Check(mro));
952 n = PyTuple_GET_SIZE(mro);
953 for (i = 0; i < n; i++) {
954 base = PyTuple_GET_ITEM(mro, i);
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000955 assert(PyType_Check(base));
956 dict = ((PyTypeObject *)base)->tp_dict;
Guido van Rossum056fbf42002-08-19 19:22:50 +0000957 assert(dict && PyDict_Check(dict));
958 descr = PyDict_GetItem(dict, name);
959 if (descr != NULL)
960 break;
961 }
962 }
Christian Heimesa62da1d2008-01-12 19:39:10 +0000963#else
964 descr = _PyType_Lookup(tp, name);
965#endif
Guido van Rossum056fbf42002-08-19 19:22:50 +0000966
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +0000967 Py_XINCREF(descr);
968
Tim Peters6d6c1a32001-08-02 04:15:00 +0000969 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000970 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000971 f = descr->ob_type->tp_descr_get;
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000972 if (f != NULL && PyDescr_IsData(descr)) {
973 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +0000974 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +0000975 goto done;
976 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000977 }
978
Guido van Rossumc66ff442002-08-19 16:50:48 +0000979 /* Inline _PyObject_GetDictPtr */
980 dictoffset = tp->tp_dictoffset;
981 if (dictoffset != 0) {
982 PyObject *dict;
983 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000984 Py_ssize_t tsize;
Guido van Rossumc66ff442002-08-19 16:50:48 +0000985 size_t size;
986
987 tsize = ((PyVarObject *)obj)->ob_size;
988 if (tsize < 0)
989 tsize = -tsize;
990 size = _PyObject_VAR_SIZE(tp, tsize);
991
992 dictoffset += (long)size;
993 assert(dictoffset > 0);
994 assert(dictoffset % SIZEOF_VOID_P == 0);
995 }
996 dictptr = (PyObject **) ((char *)obj + dictoffset);
997 dict = *dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000998 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +0000999 Py_INCREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001000 res = PyDict_GetItem(dict, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001001 if (res != NULL) {
1002 Py_INCREF(res);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001003 Py_XDECREF(descr);
Christian Heimes969fe572008-01-25 11:23:10 +00001004 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001005 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001006 }
Christian Heimes969fe572008-01-25 11:23:10 +00001007 Py_DECREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001008 }
1009 }
1010
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001011 if (f != NULL) {
Christian Heimes90aa7642007-12-19 02:45:37 +00001012 res = f(descr, obj, (PyObject *)Py_TYPE(obj));
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001013 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001014 goto done;
1015 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001016
1017 if (descr != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001018 res = descr;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001019 /* descr was already increfed above */
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001020 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001021 }
1022
1023 PyErr_Format(PyExc_AttributeError,
1024 "'%.50s' object has no attribute '%.400s'",
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +00001025 tp->tp_name, _PyUnicode_AsString(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001026 done:
1027 Py_DECREF(name);
1028 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001029}
1030
1031int
1032PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1033{
Christian Heimes90aa7642007-12-19 02:45:37 +00001034 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001035 PyObject *descr;
1036 descrsetfunc f;
1037 PyObject **dictptr;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001038 int res = -1;
1039
Martin v. Löwis5b222132007-06-10 09:51:05 +00001040 if (!PyUnicode_Check(name)){
1041 PyErr_Format(PyExc_TypeError,
1042 "attribute name must be string, not '%.200s'",
1043 name->ob_type->tp_name);
1044 return -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001045 }
1046 else
1047 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001048
1049 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001050 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001051 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001052 }
1053
1054 descr = _PyType_Lookup(tp, name);
1055 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001056 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001057 f = descr->ob_type->tp_descr_set;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001058 if (f != NULL && PyDescr_IsData(descr)) {
1059 res = f(descr, obj, value);
1060 goto done;
1061 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001062 }
1063
1064 dictptr = _PyObject_GetDictPtr(obj);
1065 if (dictptr != NULL) {
1066 PyObject *dict = *dictptr;
1067 if (dict == NULL && value != NULL) {
1068 dict = PyDict_New();
1069 if (dict == NULL)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001070 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001071 *dictptr = dict;
1072 }
1073 if (dict != NULL) {
Christian Heimes969fe572008-01-25 11:23:10 +00001074 Py_INCREF(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001075 if (value == NULL)
1076 res = PyDict_DelItem(dict, name);
1077 else
1078 res = PyDict_SetItem(dict, name, value);
1079 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1080 PyErr_SetObject(PyExc_AttributeError, name);
Christian Heimes969fe572008-01-25 11:23:10 +00001081 Py_DECREF(dict);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001082 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001083 }
1084 }
1085
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001086 if (f != NULL) {
1087 res = f(descr, obj, value);
1088 goto done;
1089 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001090
1091 if (descr == NULL) {
1092 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001093 "'%.100s' object has no attribute '%U'",
1094 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001095 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001096 }
1097
1098 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001099 "'%.50s' object attribute '%U' is read-only",
1100 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001101 done:
1102 Py_DECREF(name);
1103 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001104}
1105
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001106/* Test a value used as condition, e.g., in a for or if statement.
1107 Return -1 if an error occurred */
1108
1109int
Fred Drake100814d2000-07-09 15:48:49 +00001110PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001111{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001112 Py_ssize_t res;
Guido van Rossum6248f442002-08-24 06:31:34 +00001113 if (v == Py_True)
1114 return 1;
1115 if (v == Py_False)
1116 return 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001117 if (v == Py_None)
Neal Norwitz51290d32002-06-13 21:32:44 +00001118 return 0;
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001119 else if (v->ob_type->tp_as_number != NULL &&
Jack Diederich4dafcc42006-11-28 19:15:13 +00001120 v->ob_type->tp_as_number->nb_bool != NULL)
1121 res = (*v->ob_type->tp_as_number->nb_bool)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001122 else if (v->ob_type->tp_as_mapping != NULL &&
1123 v->ob_type->tp_as_mapping->mp_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001124 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001125 else if (v->ob_type->tp_as_sequence != NULL &&
1126 v->ob_type->tp_as_sequence->sq_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001127 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1128 else
Neal Norwitz51290d32002-06-13 21:32:44 +00001129 return 1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001130 /* if it is negative, it should be either -1 or -2 */
1131 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001132}
1133
Tim Peters803526b2002-07-07 05:13:56 +00001134/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001135 Return -1 if an error occurred */
1136
1137int
Fred Drake100814d2000-07-09 15:48:49 +00001138PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001139{
1140 int res;
1141 res = PyObject_IsTrue(v);
1142 if (res < 0)
1143 return res;
1144 return res == 0;
1145}
1146
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001147/* Test whether an object can be called */
1148
1149int
Fred Drake100814d2000-07-09 15:48:49 +00001150PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001151{
1152 if (x == NULL)
1153 return 0;
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001154 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001155}
1156
Georg Brandle32b4222007-03-10 22:13:27 +00001157/* ------------------------- PyObject_Dir() helpers ------------------------- */
1158
Tim Peters7eea37e2001-09-04 22:08:56 +00001159/* Helper for PyObject_Dir.
1160 Merge the __dict__ of aclass into dict, and recursively also all
1161 the __dict__s of aclass's base classes. The order of merging isn't
1162 defined, as it's expected that only the final set of dict keys is
1163 interesting.
1164 Return 0 on success, -1 on error.
1165*/
1166
1167static int
1168merge_class_dict(PyObject* dict, PyObject* aclass)
1169{
1170 PyObject *classdict;
1171 PyObject *bases;
1172
1173 assert(PyDict_Check(dict));
1174 assert(aclass);
1175
1176 /* Merge in the type's dict (if any). */
1177 classdict = PyObject_GetAttrString(aclass, "__dict__");
1178 if (classdict == NULL)
1179 PyErr_Clear();
1180 else {
1181 int status = PyDict_Update(dict, classdict);
1182 Py_DECREF(classdict);
1183 if (status < 0)
1184 return -1;
1185 }
1186
1187 /* Recursively merge in the base types' (if any) dicts. */
1188 bases = PyObject_GetAttrString(aclass, "__bases__");
Tim Petersbc7e8632001-09-16 20:33:22 +00001189 if (bases == NULL)
1190 PyErr_Clear();
1191 else {
Guido van Rossum44022412002-05-13 18:29:46 +00001192 /* We have no guarantee that bases is a real tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001193 Py_ssize_t i, n;
Guido van Rossum44022412002-05-13 18:29:46 +00001194 n = PySequence_Size(bases); /* This better be right */
1195 if (n < 0)
1196 PyErr_Clear();
1197 else {
1198 for (i = 0; i < n; i++) {
Tim Peters18e70832003-02-05 19:35:19 +00001199 int status;
Guido van Rossum44022412002-05-13 18:29:46 +00001200 PyObject *base = PySequence_GetItem(bases, i);
1201 if (base == NULL) {
1202 Py_DECREF(bases);
1203 return -1;
1204 }
Tim Peters18e70832003-02-05 19:35:19 +00001205 status = merge_class_dict(dict, base);
1206 Py_DECREF(base);
1207 if (status < 0) {
Guido van Rossum44022412002-05-13 18:29:46 +00001208 Py_DECREF(bases);
1209 return -1;
1210 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001211 }
1212 }
1213 Py_DECREF(bases);
1214 }
1215 return 0;
1216}
1217
Georg Brandle32b4222007-03-10 22:13:27 +00001218/* Helper for PyObject_Dir without arguments: returns the local scope. */
1219static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001220_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001221{
Georg Brandled3b8382007-03-12 13:15:14 +00001222 PyObject *names;
Georg Brandle32b4222007-03-10 22:13:27 +00001223 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001224
Georg Brandle32b4222007-03-10 22:13:27 +00001225 if (locals == NULL) {
1226 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1227 return NULL;
Tim Peters305b5852001-09-17 02:38:46 +00001228 }
1229
Georg Brandled3b8382007-03-12 13:15:14 +00001230 names = PyMapping_Keys(locals);
1231 if (!names)
1232 return NULL;
1233 if (!PyList_Check(names)) {
1234 PyErr_Format(PyExc_TypeError,
1235 "dir(): expected keys() of locals to be a list, "
Christian Heimes90aa7642007-12-19 02:45:37 +00001236 "not '%.200s'", Py_TYPE(names)->tp_name);
Georg Brandled3b8382007-03-12 13:15:14 +00001237 Py_DECREF(names);
1238 return NULL;
1239 }
Georg Brandle32b4222007-03-10 22:13:27 +00001240 /* the locals don't need to be DECREF'd */
Georg Brandled3b8382007-03-12 13:15:14 +00001241 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001242}
1243
1244/* Helper for PyObject_Dir of type objects: returns __dict__ and __bases__.
Guido van Rossum98297ee2007-11-06 21:34:58 +00001245 We deliberately don't suck up its __class__, as methods belonging to the
1246 metaclass would probably be more confusing than helpful.
Georg Brandle32b4222007-03-10 22:13:27 +00001247*/
Guido van Rossum98297ee2007-11-06 21:34:58 +00001248static PyObject *
Georg Brandle32b4222007-03-10 22:13:27 +00001249_specialized_dir_type(PyObject *obj)
1250{
1251 PyObject *result = NULL;
1252 PyObject *dict = PyDict_New();
1253
1254 if (dict != NULL && merge_class_dict(dict, obj) == 0)
1255 result = PyDict_Keys(dict);
1256
1257 Py_XDECREF(dict);
Tim Peters305b5852001-09-17 02:38:46 +00001258 return result;
1259}
1260
Georg Brandle32b4222007-03-10 22:13:27 +00001261/* Helper for PyObject_Dir of module objects: returns the module's __dict__. */
1262static PyObject *
1263_specialized_dir_module(PyObject *obj)
Tim Peters7eea37e2001-09-04 22:08:56 +00001264{
Georg Brandle32b4222007-03-10 22:13:27 +00001265 PyObject *result = NULL;
1266 PyObject *dict = PyObject_GetAttrString(obj, "__dict__");
Tim Peters7eea37e2001-09-04 22:08:56 +00001267
Georg Brandle32b4222007-03-10 22:13:27 +00001268 if (dict != NULL) {
1269 if (PyDict_Check(dict))
1270 result = PyDict_Keys(dict);
1271 else {
1272 PyErr_Format(PyExc_TypeError,
1273 "%.200s.__dict__ is not a dictionary",
1274 PyModule_GetName(obj));
Guido van Rossum8dbd3d82001-09-10 18:27:43 +00001275 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001276 }
1277
Georg Brandle32b4222007-03-10 22:13:27 +00001278 Py_XDECREF(dict);
1279 return result;
1280}
Tim Peters7eea37e2001-09-04 22:08:56 +00001281
Georg Brandle32b4222007-03-10 22:13:27 +00001282/* Helper for PyObject_Dir of generic objects: returns __dict__, __class__,
1283 and recursively up the __class__.__bases__ chain.
1284*/
1285static PyObject *
1286_generic_dir(PyObject *obj)
1287{
1288 PyObject *result = NULL;
1289 PyObject *dict = NULL;
1290 PyObject *itsclass = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001291
Georg Brandle32b4222007-03-10 22:13:27 +00001292 /* Get __dict__ (which may or may not be a real dict...) */
1293 dict = PyObject_GetAttrString(obj, "__dict__");
1294 if (dict == NULL) {
1295 PyErr_Clear();
1296 dict = PyDict_New();
1297 }
1298 else if (!PyDict_Check(dict)) {
1299 Py_DECREF(dict);
1300 dict = PyDict_New();
1301 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001302 else {
Georg Brandle32b4222007-03-10 22:13:27 +00001303 /* Copy __dict__ to avoid mutating it. */
1304 PyObject *temp = PyDict_Copy(dict);
1305 Py_DECREF(dict);
1306 dict = temp;
Tim Peters7eea37e2001-09-04 22:08:56 +00001307 }
1308
Georg Brandle32b4222007-03-10 22:13:27 +00001309 if (dict == NULL)
Raymond Hettinger2a7dede2004-08-07 04:55:30 +00001310 goto error;
Tim Peters7eea37e2001-09-04 22:08:56 +00001311
Georg Brandle32b4222007-03-10 22:13:27 +00001312 /* Merge in attrs reachable from its class. */
1313 itsclass = PyObject_GetAttrString(obj, "__class__");
1314 if (itsclass == NULL)
1315 /* XXX(tomer): Perhaps fall back to obj->ob_type if no
1316 __class__ exists? */
1317 PyErr_Clear();
1318 else {
1319 if (merge_class_dict(dict, itsclass) != 0)
1320 goto error;
1321 }
1322
1323 result = PyDict_Keys(dict);
Tim Peters7eea37e2001-09-04 22:08:56 +00001324 /* fall through */
Georg Brandle32b4222007-03-10 22:13:27 +00001325error:
1326 Py_XDECREF(itsclass);
1327 Py_XDECREF(dict);
1328 return result;
1329}
1330
1331/* Helper for PyObject_Dir: object introspection.
1332 This calls one of the above specialized versions if no __dir__ method
1333 exists. */
1334static PyObject *
1335_dir_object(PyObject *obj)
1336{
1337 PyObject * result = NULL;
1338 PyObject * dirfunc = PyObject_GetAttrString((PyObject*)obj->ob_type,
1339 "__dir__");
1340
1341 assert(obj);
1342 if (dirfunc == NULL) {
1343 /* use default implementation */
1344 PyErr_Clear();
1345 if (PyModule_Check(obj))
1346 result = _specialized_dir_module(obj);
1347 else if (PyType_Check(obj))
1348 result = _specialized_dir_type(obj);
1349 else
1350 result = _generic_dir(obj);
1351 }
1352 else {
1353 /* use __dir__ */
1354 result = PyObject_CallFunctionObjArgs(dirfunc, obj, NULL);
1355 Py_DECREF(dirfunc);
1356 if (result == NULL)
1357 return NULL;
1358
1359 /* result must be a list */
1360 /* XXX(gbrandl): could also check if all items are strings */
1361 if (!PyList_Check(result)) {
1362 PyErr_Format(PyExc_TypeError,
1363 "__dir__() must return a list, not %.200s",
Christian Heimes90aa7642007-12-19 02:45:37 +00001364 Py_TYPE(result)->tp_name);
Georg Brandle32b4222007-03-10 22:13:27 +00001365 Py_DECREF(result);
1366 result = NULL;
1367 }
1368 }
1369
1370 return result;
1371}
1372
1373/* Implementation of dir() -- if obj is NULL, returns the names in the current
1374 (local) scope. Otherwise, performs introspection of the object: returns a
1375 sorted list of attribute names (supposedly) accessible from the object
1376*/
1377PyObject *
1378PyObject_Dir(PyObject *obj)
1379{
1380 PyObject * result;
1381
1382 if (obj == NULL)
1383 /* no object -- introspect the locals */
1384 result = _dir_locals();
1385 else
1386 /* object -- introspect the object */
1387 result = _dir_object(obj);
1388
1389 assert(result == NULL || PyList_Check(result));
1390
1391 if (result != NULL && PyList_Sort(result) != 0) {
1392 /* sorting the list failed */
1393 Py_DECREF(result);
1394 result = NULL;
1395 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001396
Tim Peters7eea37e2001-09-04 22:08:56 +00001397 return result;
1398}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001399
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001400/*
1401NoObject is usable as a non-NULL undefined value, used by the macro None.
1402There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001403so there is exactly one (which is indestructible, by the way).
Guido van Rossumba21a492001-08-16 08:17:26 +00001404(XXX This type and the type of NotImplemented below should be unified.)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001405*/
1406
Guido van Rossum0c182a11992-03-27 17:26:13 +00001407/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001408static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001409none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001410{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001411 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001412}
1413
Barry Warsaw9bf16442001-01-23 16:24:35 +00001414/* ARGUSED */
1415static void
Tim Peters803526b2002-07-07 05:13:56 +00001416none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001417{
1418 /* This should never get called, but we also don't want to SEGV if
Mark Dickinson934896d2009-02-21 20:59:32 +00001419 * we accidentally decref None out of existence.
Barry Warsaw9bf16442001-01-23 16:24:35 +00001420 */
Martin v. Löwis3f19b102002-08-07 16:21:51 +00001421 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001422}
1423
1424
Guido van Rossumba21a492001-08-16 08:17:26 +00001425static PyTypeObject PyNone_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001426 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001427 "NoneType",
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001428 0,
1429 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001430 none_dealloc, /*tp_dealloc*/ /*never called*/
Guido van Rossum7066dd71992-09-17 17:54:56 +00001431 0, /*tp_print*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001432 0, /*tp_getattr*/
1433 0, /*tp_setattr*/
Mark Dickinsone94c6792009-02-02 20:36:42 +00001434 0, /*tp_reserved*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001435 none_repr, /*tp_repr*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001436 0, /*tp_as_number*/
1437 0, /*tp_as_sequence*/
1438 0, /*tp_as_mapping*/
Guido van Rossum9bfef441993-03-29 10:43:31 +00001439 0, /*tp_hash */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001440};
1441
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001442PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001443 _PyObject_EXTRA_INIT
1444 1, &PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001445};
1446
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001447/* NotImplemented is an object that can be used to signal that an
1448 operation is not implemented for the given type combination. */
1449
1450static PyObject *
1451NotImplemented_repr(PyObject *op)
1452{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001453 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001454}
1455
1456static PyTypeObject PyNotImplemented_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001457 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001458 "NotImplementedType",
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001459 0,
1460 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001461 none_dealloc, /*tp_dealloc*/ /*never called*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001462 0, /*tp_print*/
1463 0, /*tp_getattr*/
1464 0, /*tp_setattr*/
Mark Dickinsone94c6792009-02-02 20:36:42 +00001465 0, /*tp_reserved*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001466 NotImplemented_repr, /*tp_repr*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001467 0, /*tp_as_number*/
1468 0, /*tp_as_sequence*/
1469 0, /*tp_as_mapping*/
1470 0, /*tp_hash */
1471};
1472
1473PyObject _Py_NotImplementedStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001474 _PyObject_EXTRA_INIT
1475 1, &PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001476};
1477
Guido van Rossumba21a492001-08-16 08:17:26 +00001478void
1479_Py_ReadyTypes(void)
1480{
1481 if (PyType_Ready(&PyType_Type) < 0)
1482 Py_FatalError("Can't initialize 'type'");
1483
Fred Drake0a4dd392004-07-02 18:57:45 +00001484 if (PyType_Ready(&_PyWeakref_RefType) < 0)
1485 Py_FatalError("Can't initialize 'weakref'");
1486
Guido van Rossum77f6a652002-04-03 22:41:51 +00001487 if (PyType_Ready(&PyBool_Type) < 0)
1488 Py_FatalError("Can't initialize 'bool'");
1489
Christian Heimes9c4756e2008-05-26 13:22:05 +00001490 if (PyType_Ready(&PyByteArray_Type) < 0)
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001491 Py_FatalError("Can't initialize 'bytes'");
1492
Christian Heimes72b710a2008-05-26 13:28:38 +00001493 if (PyType_Ready(&PyBytes_Type) < 0)
Guido van Rossumcacfc072002-05-24 19:01:59 +00001494 Py_FatalError("Can't initialize 'str'");
1495
Guido van Rossumba21a492001-08-16 08:17:26 +00001496 if (PyType_Ready(&PyList_Type) < 0)
1497 Py_FatalError("Can't initialize 'list'");
1498
1499 if (PyType_Ready(&PyNone_Type) < 0)
1500 Py_FatalError("Can't initialize type(None)");
1501
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001502 if (PyType_Ready(Py_Ellipsis->ob_type) < 0)
1503 Py_FatalError("Can't initialize type(Ellipsis)");
1504
Guido van Rossumba21a492001-08-16 08:17:26 +00001505 if (PyType_Ready(&PyNotImplemented_Type) < 0)
1506 Py_FatalError("Can't initialize type(NotImplemented)");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001507
1508 if (PyType_Ready(&PyCode_Type) < 0)
1509 Py_FatalError("Can't initialize 'code'");
Guido van Rossum826d8972007-10-30 18:34:07 +00001510
1511 if (PyType_Ready(&PyStdPrinter_Type) < 0)
1512 Py_FatalError("Can't initialize StdPrinter");
Guido van Rossumba21a492001-08-16 08:17:26 +00001513}
1514
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001515
Guido van Rossum84a90321996-05-22 16:34:47 +00001516#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001517
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001518void
Fred Drake100814d2000-07-09 15:48:49 +00001519_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001520{
Tim Peters34592512002-07-11 06:23:50 +00001521 _Py_INC_REFTOTAL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001522 op->ob_refcnt = 1;
Tim Peters7571a0f2003-03-23 17:52:28 +00001523 _Py_AddToAllObjects(op, 1);
Tim Peters34592512002-07-11 06:23:50 +00001524 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001525}
1526
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001527void
Fred Drake100814d2000-07-09 15:48:49 +00001528_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001529{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001530#ifdef SLOW_UNREF_CHECK
Guido van Rossum4c08d552000-03-10 22:55:18 +00001531 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001532#endif
Guido van Rossumd7047b31995-01-02 19:07:15 +00001533 if (op->ob_refcnt < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001534 Py_FatalError("UNREF negative refcnt");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001535 if (op == &refchain ||
Christian Heimesc8967002007-11-30 10:18:26 +00001536 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op) {
1537 fprintf(stderr, "* ob\n");
1538 _PyObject_Dump(op);
1539 fprintf(stderr, "* op->_ob_prev->_ob_next\n");
1540 _PyObject_Dump(op->_ob_prev->_ob_next);
1541 fprintf(stderr, "* op->_ob_next->_ob_prev\n");
1542 _PyObject_Dump(op->_ob_next->_ob_prev);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001543 Py_FatalError("UNREF invalid object");
Christian Heimesc8967002007-11-30 10:18:26 +00001544 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001545#ifdef SLOW_UNREF_CHECK
Guido van Rossum3f5da241990-12-20 15:06:42 +00001546 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1547 if (p == op)
1548 break;
1549 }
Guido van Rossumd7047b31995-01-02 19:07:15 +00001550 if (p == &refchain) /* Not found */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001551 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001552#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001553 op->_ob_next->_ob_prev = op->_ob_prev;
1554 op->_ob_prev->_ob_next = op->_ob_next;
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001555 op->_ob_next = op->_ob_prev = NULL;
Tim Peters34592512002-07-11 06:23:50 +00001556 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001557}
1558
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001559void
Fred Drake100814d2000-07-09 15:48:49 +00001560_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001561{
Christian Heimes90aa7642007-12-19 02:45:37 +00001562 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001563 _Py_ForgetReference(op);
Guido van Rossum9776adf1994-09-07 14:36:45 +00001564 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001565}
1566
Tim Peters269b2a62003-04-17 19:52:29 +00001567/* Print all live objects. Because PyObject_Print is called, the
1568 * interpreter must be in a healthy state.
1569 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001570void
Fred Drake100814d2000-07-09 15:48:49 +00001571_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001572{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001573 PyObject *op;
Guido van Rossume09fb551997-08-05 02:04:34 +00001574 fprintf(fp, "Remaining objects:\n");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001575 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001576 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001577 if (PyObject_Print(op, fp, 0) != 0)
1578 PyErr_Clear();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001579 putc('\n', fp);
1580 }
1581}
1582
Tim Peters269b2a62003-04-17 19:52:29 +00001583/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1584 * doesn't make any calls to the Python C API, so is always safe to call.
1585 */
1586void
1587_Py_PrintReferenceAddresses(FILE *fp)
1588{
1589 PyObject *op;
1590 fprintf(fp, "Remaining object addresses:\n");
1591 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001592 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
Christian Heimes90aa7642007-12-19 02:45:37 +00001593 op->ob_refcnt, Py_TYPE(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001594}
1595
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001596PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001597_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001598{
1599 int i, n;
1600 PyObject *t = NULL;
1601 PyObject *res, *op;
1602
1603 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1604 return NULL;
1605 op = refchain._ob_next;
1606 res = PyList_New(0);
1607 if (res == NULL)
1608 return NULL;
1609 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1610 while (op == self || op == args || op == res || op == t ||
Christian Heimes90aa7642007-12-19 02:45:37 +00001611 (t != NULL && Py_TYPE(op) != (PyTypeObject *) t)) {
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001612 op = op->_ob_next;
1613 if (op == &refchain)
1614 return res;
1615 }
1616 if (PyList_Append(res, op) < 0) {
1617 Py_DECREF(res);
1618 return NULL;
1619 }
1620 op = op->_ob_next;
1621 }
1622 return res;
1623}
1624
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001625#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001626
1627
1628/* Hack to force loading of cobject.o */
Guido van Rossumda9c2711996-12-05 21:58:58 +00001629PyTypeObject *_Py_cobject_hack = &PyCObject_Type;
Guido van Rossum84a90321996-05-22 16:34:47 +00001630
1631
1632/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001633Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001634
1635
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001636/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001637
Thomas Wouters334fb892000-07-25 12:56:38 +00001638void *
Fred Drake100814d2000-07-09 15:48:49 +00001639PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001640{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001641 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001642}
1643
Thomas Wouters334fb892000-07-25 12:56:38 +00001644void *
1645PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001646{
Tim Petersaf3e8de2002-04-12 07:22:56 +00001647 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001648}
1649
1650void
Thomas Wouters334fb892000-07-25 12:56:38 +00001651PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001652{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001653 PyMem_FREE(p);
1654}
1655
1656
Guido van Rossum86610361998-04-10 22:32:46 +00001657/* These methods are used to control infinite recursion in repr, str, print,
1658 etc. Container objects that may recursively contain themselves,
1659 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1660 Py_ReprLeave() to avoid infinite recursion.
1661
1662 Py_ReprEnter() returns 0 the first time it is called for a particular
1663 object and 1 every time thereafter. It returns -1 if an exception
1664 occurred. Py_ReprLeave() has no return value.
1665
1666 See dictobject.c and listobject.c for examples of use.
1667*/
1668
1669#define KEY "Py_Repr"
1670
1671int
Fred Drake100814d2000-07-09 15:48:49 +00001672Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001673{
1674 PyObject *dict;
1675 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001676 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001677
1678 dict = PyThreadState_GetDict();
1679 if (dict == NULL)
Guido van Rossum0fc8f002003-04-15 15:12:39 +00001680 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001681 list = PyDict_GetItemString(dict, KEY);
1682 if (list == NULL) {
1683 list = PyList_New(0);
1684 if (list == NULL)
1685 return -1;
1686 if (PyDict_SetItemString(dict, KEY, list) < 0)
1687 return -1;
1688 Py_DECREF(list);
1689 }
1690 i = PyList_GET_SIZE(list);
1691 while (--i >= 0) {
1692 if (PyList_GET_ITEM(list, i) == obj)
1693 return 1;
1694 }
1695 PyList_Append(list, obj);
1696 return 0;
1697}
1698
1699void
Fred Drake100814d2000-07-09 15:48:49 +00001700Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001701{
1702 PyObject *dict;
1703 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001704 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001705
1706 dict = PyThreadState_GetDict();
Guido van Rossumeb909461998-04-11 15:17:34 +00001707 if (dict == NULL)
1708 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001709 list = PyDict_GetItemString(dict, KEY);
Guido van Rossumeb909461998-04-11 15:17:34 +00001710 if (list == NULL || !PyList_Check(list))
1711 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001712 i = PyList_GET_SIZE(list);
1713 /* Count backwards because we always expect obj to be list[-1] */
1714 while (--i >= 0) {
1715 if (PyList_GET_ITEM(list, i) == obj) {
1716 PyList_SetSlice(list, i, i + 1, NULL);
1717 break;
1718 }
1719 }
1720}
Guido van Rossumd724b232000-03-13 16:01:29 +00001721
Tim Peters803526b2002-07-07 05:13:56 +00001722/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001723
Tim Peters803526b2002-07-07 05:13:56 +00001724/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001725int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001726
Tim Peters803526b2002-07-07 05:13:56 +00001727/* List of objects that still need to be cleaned up, singly linked via their
1728 * gc headers' gc_prev pointers.
1729 */
1730PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001731
Tim Peters803526b2002-07-07 05:13:56 +00001732/* Add op to the _PyTrash_delete_later list. Called when the current
1733 * call-stack depth gets large. op must be a currently untracked gc'ed
1734 * object, with refcount 0. Py_DECREF must already have been called on it.
1735 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001736void
Fred Drake100814d2000-07-09 15:48:49 +00001737_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001738{
Tim Peters803526b2002-07-07 05:13:56 +00001739 assert(PyObject_IS_GC(op));
1740 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1741 assert(op->ob_refcnt == 0);
Neil Schemenauerf589c052002-03-29 03:05:54 +00001742 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
Guido van Rossume92e6102000-04-24 15:40:53 +00001743 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001744}
1745
Tim Peters803526b2002-07-07 05:13:56 +00001746/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1747 * the call-stack unwinds again.
1748 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001749void
Fred Drake100814d2000-07-09 15:48:49 +00001750_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001751{
1752 while (_PyTrash_delete_later) {
Tim Peters803526b2002-07-07 05:13:56 +00001753 PyObject *op = _PyTrash_delete_later;
Christian Heimes90aa7642007-12-19 02:45:37 +00001754 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001755
Neil Schemenauerf589c052002-03-29 03:05:54 +00001756 _PyTrash_delete_later =
Tim Peters803526b2002-07-07 05:13:56 +00001757 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001758
Tim Peters803526b2002-07-07 05:13:56 +00001759 /* Call the deallocator directly. This used to try to
1760 * fool Py_DECREF into calling it indirectly, but
1761 * Py_DECREF was already called on this object, and in
1762 * assorted non-release builds calling Py_DECREF again ends
1763 * up distorting allocation statistics.
1764 */
1765 assert(op->ob_refcnt == 0);
Guido van Rossumd724b232000-03-13 16:01:29 +00001766 ++_PyTrash_delete_nesting;
Tim Peters803526b2002-07-07 05:13:56 +00001767 (*dealloc)(op);
Guido van Rossumd724b232000-03-13 16:01:29 +00001768 --_PyTrash_delete_nesting;
1769 }
1770}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001771
1772#ifdef __cplusplus
1773}
1774#endif