blob: 8597d888fb75003bfceaf4c746034e06da41e495 [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) */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000217 op->ob_type = 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;
229 op->ob_type = tp;
230 _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) {
274 fprintf(fp, "<nil>");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000275 }
Guido van Rossum90933611991-06-07 16:10:43 +0000276 else {
277 if (op->ob_refcnt <= 0)
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000278 /* XXX(twouters) cast refcount to long until %zd is
279 universally available */
280 fprintf(fp, "<refcnt %ld at %p>",
281 (long)op->ob_refcnt, op);
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000282 else if (op->ob_type->tp_print == NULL) {
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000283 PyObject *s;
284 if (flags & Py_PRINT_RAW)
285 s = PyObject_Str(op);
286 else
287 s = PyObject_Repr(op);
288 if (s == NULL)
289 ret = -1;
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000290 else {
Neal Norwitz1a997502003-01-13 20:13:12 +0000291 ret = internal_print(s, fp, Py_PRINT_RAW,
292 nesting+1);
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000293 }
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000294 Py_XDECREF(s);
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000295 }
Guido van Rossum90933611991-06-07 16:10:43 +0000296 else
Guido van Rossum278ef591991-07-27 21:40:24 +0000297 ret = (*op->ob_type->tp_print)(op, fp, flags);
Guido van Rossum90933611991-06-07 16:10:43 +0000298 }
Guido van Rossum278ef591991-07-27 21:40:24 +0000299 if (ret == 0) {
300 if (ferror(fp)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000301 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum278ef591991-07-27 21:40:24 +0000302 clearerr(fp);
303 ret = -1;
304 }
305 }
306 return ret;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000307}
308
Neal Norwitz1a997502003-01-13 20:13:12 +0000309int
310PyObject_Print(PyObject *op, FILE *fp, int flags)
311{
312 return internal_print(op, fp, flags, 0);
313}
314
Guido van Rossum38938152006-08-21 23:36:26 +0000315/* For debugging convenience. Set a breakpoint here and call it from your DLL */
316void
Thomas Woutersb2137042007-02-01 18:02:27 +0000317_Py_BreakPoint(void)
Guido van Rossum38938152006-08-21 23:36:26 +0000318{
319}
320
Neal Norwitz1a997502003-01-13 20:13:12 +0000321
Barry Warsaw9bf16442001-01-23 16:24:35 +0000322/* For debugging convenience. See Misc/gdbinit for some useful gdb hooks */
Guido van Rossum38938152006-08-21 23:36:26 +0000323void
324_PyObject_Dump(PyObject* op)
Barry Warsaw9bf16442001-01-23 16:24:35 +0000325{
Barry Warsaweefb1072001-02-22 22:39:18 +0000326 if (op == NULL)
327 fprintf(stderr, "NULL\n");
328 else {
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000329 fprintf(stderr, "object : ");
Barry Warsaweefb1072001-02-22 22:39:18 +0000330 (void)PyObject_Print(op, stderr, 0);
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000331 /* XXX(twouters) cast refcount to long until %zd is
332 universally available */
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000333 fprintf(stderr, "\n"
334 "type : %s\n"
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000335 "refcount: %ld\n"
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000336 "address : %p\n",
337 op->ob_type==NULL ? "NULL" : op->ob_type->tp_name,
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000338 (long)op->ob_refcnt,
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000339 op);
Barry Warsaweefb1072001-02-22 22:39:18 +0000340 }
Barry Warsaw9bf16442001-01-23 16:24:35 +0000341}
Barry Warsaw903138f2001-01-23 16:33:18 +0000342
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000343PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000344PyObject_Repr(PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000345{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000346 if (PyErr_CheckSignals())
Guido van Rossum90933611991-06-07 16:10:43 +0000347 return NULL;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000348#ifdef USE_STACKCHECK
349 if (PyOS_CheckStack()) {
Fred Drake661ea262000-10-24 19:57:45 +0000350 PyErr_SetString(PyExc_MemoryError, "stack overflow");
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000351 return NULL;
352 }
353#endif
Guido van Rossum90933611991-06-07 16:10:43 +0000354 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000355 return PyString_FromString("<NULL>");
Barry Warsaw7ce36942001-08-24 18:34:26 +0000356 else if (v->ob_type->tp_repr == NULL)
Guido van Rossum21922aa2001-08-30 20:26:05 +0000357 return PyString_FromFormat("<%s object at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +0000358 v->ob_type->tp_name, v);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000359 else {
360 PyObject *res;
361 res = (*v->ob_type->tp_repr)(v);
362 if (res == NULL)
363 return NULL;
Guido van Rossumc8c82332007-05-04 05:14:29 +0000364 if (PyUnicode_Check(res))
365 return res;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000366 if (!PyString_Check(res)) {
367 PyErr_Format(PyExc_TypeError,
Guido van Rossum5db862d2000-04-10 12:46:51 +0000368 "__repr__ returned non-string (type %.200s)",
Guido van Rossum4c08d552000-03-10 22:55:18 +0000369 res->ob_type->tp_name);
370 Py_DECREF(res);
371 return NULL;
372 }
373 return res;
374 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000375}
376
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000377PyObject *
Neil Schemenauercf52c072005-08-12 17:34:58 +0000378_PyObject_Str(PyObject *v)
Guido van Rossumc6004111993-11-05 10:22:19 +0000379{
Guido van Rossum4c08d552000-03-10 22:55:18 +0000380 PyObject *res;
Neil Schemenauercf52c072005-08-12 17:34:58 +0000381 int type_ok;
Guido van Rossumc6004111993-11-05 10:22:19 +0000382 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000383 return PyString_FromString("<NULL>");
Tim Peters5a49ade2001-09-11 01:41:59 +0000384 if (PyString_CheckExact(v)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000385 Py_INCREF(v);
Guido van Rossumc6004111993-11-05 10:22:19 +0000386 return v;
387 }
Neil Schemenauercf52c072005-08-12 17:34:58 +0000388 if (PyUnicode_CheckExact(v)) {
389 Py_INCREF(v);
390 return v;
391 }
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000392 if (v->ob_type->tp_str == NULL)
393 return PyObject_Repr(v);
394
395 res = (*v->ob_type->tp_str)(v);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000396 if (res == NULL)
397 return NULL;
Neil Schemenauercf52c072005-08-12 17:34:58 +0000398 type_ok = PyString_Check(res);
Neil Schemenauercf52c072005-08-12 17:34:58 +0000399 type_ok = type_ok || PyUnicode_Check(res);
Neil Schemenauercf52c072005-08-12 17:34:58 +0000400 if (!type_ok) {
401 PyErr_Format(PyExc_TypeError,
402 "__str__ returned non-string (type %.200s)",
403 res->ob_type->tp_name);
404 Py_DECREF(res);
405 return NULL;
406 }
407 return res;
408}
409
410PyObject *
411PyObject_Str(PyObject *v)
412{
413 PyObject *res = _PyObject_Str(v);
414 if (res == NULL)
415 return NULL;
Marc-André Lemburg891bc652000-07-03 09:57:53 +0000416 if (PyUnicode_Check(res)) {
417 PyObject* str;
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000418 str = _PyUnicode_AsDefaultEncodedString(res, NULL);
419 Py_XINCREF(str);
Marc-André Lemburg891bc652000-07-03 09:57:53 +0000420 Py_DECREF(res);
421 if (str)
422 res = str;
423 else
424 return NULL;
425 }
Neil Schemenauercf52c072005-08-12 17:34:58 +0000426 assert(PyString_Check(res));
Guido van Rossum4c08d552000-03-10 22:55:18 +0000427 return res;
Guido van Rossumc6004111993-11-05 10:22:19 +0000428}
429
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000430PyObject *
431PyObject_Unicode(PyObject *v)
432{
433 PyObject *res;
Brett Cannonc3647ac2005-04-26 03:45:26 +0000434 PyObject *func;
Neal Norwitz75801462006-03-14 06:02:16 +0000435 PyObject *str;
Brett Cannonc3647ac2005-04-26 03:45:26 +0000436 static PyObject *unicodestr;
Tim Peters803526b2002-07-07 05:13:56 +0000437
Georg Brandl3daf7582006-03-13 22:22:11 +0000438 if (v == NULL) {
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000439 res = PyString_FromString("<NULL>");
Neal Norwitz75801462006-03-14 06:02:16 +0000440 if (res == NULL)
441 return NULL;
442 str = PyUnicode_FromEncodedObject(res, NULL, "strict");
443 Py_DECREF(res);
444 return str;
Georg Brandl3daf7582006-03-13 22:22:11 +0000445 } else if (PyUnicode_CheckExact(v)) {
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000446 Py_INCREF(v);
447 return v;
448 }
Brett Cannonc3647ac2005-04-26 03:45:26 +0000449 /* XXX As soon as we have a tp_unicode slot, we should
450 check this before trying the __unicode__
451 method. */
452 if (unicodestr == NULL) {
453 unicodestr= PyString_InternFromString("__unicode__");
454 if (unicodestr == NULL)
455 return NULL;
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000456 }
Brett Cannonc3647ac2005-04-26 03:45:26 +0000457 func = PyObject_GetAttr(v, unicodestr);
458 if (func != NULL) {
459 res = PyEval_CallObject(func, (PyObject *)NULL);
460 Py_DECREF(func);
461 }
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000462 else {
Brett Cannonc3647ac2005-04-26 03:45:26 +0000463 PyErr_Clear();
464 if (PyUnicode_Check(v)) {
465 /* For a Unicode subtype that's didn't overwrite __unicode__,
466 return a true Unicode object with the same data. */
467 return PyUnicode_FromUnicode(PyUnicode_AS_UNICODE(v),
468 PyUnicode_GET_SIZE(v));
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000469 }
Brett Cannonc3647ac2005-04-26 03:45:26 +0000470 if (PyString_CheckExact(v)) {
471 Py_INCREF(v);
472 res = v;
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000473 }
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000474 else {
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000475 if (v->ob_type->tp_str != NULL)
476 res = (*v->ob_type->tp_str)(v);
477 else
478 res = PyObject_Repr(v);
479 }
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000480 }
481 if (res == NULL)
482 return NULL;
483 if (!PyUnicode_Check(res)) {
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000484 str = PyUnicode_FromEncodedObject(res, NULL, "strict");
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000485 Py_DECREF(res);
Neal Norwitz75801462006-03-14 06:02:16 +0000486 res = str;
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000487 }
488 return res;
489}
490
491
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000492/* The new comparison philosophy is: we completely separate three-way
493 comparison from rich comparison. That is, PyObject_Compare() and
494 PyObject_Cmp() *just* use the tp_compare slot. And PyObject_RichCompare()
495 and PyObject_RichCompareBool() *just* use the tp_richcompare slot.
496
497 See (*) below for practical amendments.
498
499 IOW, only cmp() uses tp_compare; the comparison operators (==, !=, <=, <,
500 >=, >) only use tp_richcompare. Note that list.sort() only uses <.
501
502 (And yes, eventually we'll rip out cmp() and tp_compare.)
503
504 The calling conventions are different: tp_compare only gets called with two
505 objects of the appropriate type; tp_richcompare gets called with a first
506 argument of the appropriate type and a second object of an arbitrary type.
507 We never do any kind of coercion.
508
509 The return conventions are also different.
510
511 The tp_compare slot should return a C int, as follows:
512
513 -1 if a < b or if an exception occurred
514 0 if a == b
515 +1 if a > b
516
517 No other return values are allowed. PyObject_Compare() has the same
518 calling convention.
519
520 The tp_richcompare slot should return an object, as follows:
521
522 NULL if an exception occurred
523 NotImplemented if the requested comparison is not implemented
524 any other false value if the requested comparison is false
525 any other true value if the requested comparison is true
526
527 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
528 NotImplemented.
529
530 (*) Practical amendments:
531
532 - If rich comparison returns NotImplemented, == and != are decided by
533 comparing the object pointer (i.e. falling back to the base object
534 implementation).
535
536 - If three-way comparison is not implemented, it falls back on rich
537 comparison (but not the other way around!).
538
Guido van Rossuma4073002002-05-31 20:03:54 +0000539*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000540
541/* Forward */
542static PyObject *do_richcompare(PyObject *v, PyObject *w, int op);
543
544/* Perform a three-way comparison, raising TypeError if three-way comparison
545 is not supported. */
Guido van Rossuma4073002002-05-31 20:03:54 +0000546static int
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000547do_compare(PyObject *v, PyObject *w)
Guido van Rossuma4073002002-05-31 20:03:54 +0000548{
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000549 cmpfunc f;
550 int ok;
551
552 if (v->ob_type == w->ob_type &&
553 (f = v->ob_type->tp_compare) != NULL) {
554 return (*f)(v, w);
Guido van Rossuma4073002002-05-31 20:03:54 +0000555 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000556
557 /* Now try three-way compare before giving up. This is intentionally
558 elaborate; if you have a it will raise TypeError if it detects two
559 objects that aren't ordered with respect to each other. */
560 ok = PyObject_RichCompareBool(v, w, Py_LT);
561 if (ok < 0)
562 return -1; /* Error */
563 if (ok)
564 return -1; /* Less than */
565 ok = PyObject_RichCompareBool(v, w, Py_GT);
566 if (ok < 0)
567 return -1; /* Error */
568 if (ok)
569 return 1; /* Greater than */
570 ok = PyObject_RichCompareBool(v, w, Py_EQ);
571 if (ok < 0)
572 return -1; /* Error */
573 if (ok)
574 return 0; /* Equal */
575
576 /* Give up */
577 PyErr_Format(PyExc_TypeError,
Neal Norwitz3bd844e2006-08-29 04:39:12 +0000578 "unorderable types: '%.100s' != '%.100s'",
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000579 v->ob_type->tp_name,
580 w->ob_type->tp_name);
581 return -1;
Guido van Rossuma4073002002-05-31 20:03:54 +0000582}
583
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000584/* Perform a three-way comparison. This wraps do_compare() with a check for
585 NULL arguments and a recursion check. */
586int
587PyObject_Compare(PyObject *v, PyObject *w)
588{
589 int res;
Guido van Rossuma4073002002-05-31 20:03:54 +0000590
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000591 if (v == NULL || w == NULL) {
592 if (!PyErr_Occurred())
593 PyErr_BadInternalCall();
594 return -1;
595 }
596 if (Py_EnterRecursiveCall(" in cmp"))
597 return -1;
598 res = do_compare(v, w);
599 Py_LeaveRecursiveCall();
600 return res < 0 ? -1 : res;
601}
Guido van Rossumd1f06b92001-01-24 22:14:43 +0000602
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000603/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000604int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000605
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000606static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000607
608/* Perform a rich comparison, raising TypeError when the requested comparison
609 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000610static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000611do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000612{
613 richcmpfunc f;
614 PyObject *res;
615
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000616 if (v->ob_type != w->ob_type &&
617 PyType_IsSubtype(w->ob_type, v->ob_type) &&
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000618 (f = w->ob_type->tp_richcompare) != NULL) {
Tim Petersf4aca752004-09-23 02:39:37 +0000619 res = (*f)(w, v, _Py_SwappedOp[op]);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000620 if (res != Py_NotImplemented)
621 return res;
622 Py_DECREF(res);
623 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000624 if ((f = v->ob_type->tp_richcompare) != NULL) {
Guido van Rossume797ec12001-01-17 15:24:28 +0000625 res = (*f)(v, w, op);
626 if (res != Py_NotImplemented)
627 return res;
628 Py_DECREF(res);
629 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000630 if ((f = w->ob_type->tp_richcompare) != NULL) {
631 res = (*f)(w, v, _Py_SwappedOp[op]);
632 if (res != Py_NotImplemented)
633 return res;
634 Py_DECREF(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000635 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000636 /* If neither object implements it, provide a sensible default
637 for == and !=, but raise an exception for ordering. */
638 switch (op) {
639 case Py_EQ:
640 res = (v == w) ? Py_True : Py_False;
641 break;
642 case Py_NE:
643 res = (v != w) ? Py_True : Py_False;
644 break;
645 default:
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000646 /* XXX Special-case None so it doesn't show as NoneType() */
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000647 PyErr_Format(PyExc_TypeError,
648 "unorderable types: %.100s() %s %.100s()",
649 v->ob_type->tp_name,
650 opstrings[op],
651 w->ob_type->tp_name);
652 return NULL;
653 }
Guido van Rossume797ec12001-01-17 15:24:28 +0000654 Py_INCREF(res);
655 return res;
656}
657
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000658/* Perform a rich comparison with object result. This wraps do_richcompare()
659 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000660
Guido van Rossume797ec12001-01-17 15:24:28 +0000661PyObject *
662PyObject_RichCompare(PyObject *v, PyObject *w, int op)
663{
664 PyObject *res;
665
666 assert(Py_LT <= op && op <= Py_GE);
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000667 if (v == NULL || w == NULL) {
668 if (!PyErr_Occurred())
669 PyErr_BadInternalCall();
670 return NULL;
671 }
Armin Rigo2b3eb402003-10-28 12:05:48 +0000672 if (Py_EnterRecursiveCall(" in cmp"))
673 return NULL;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000674 res = do_richcompare(v, w, op);
Armin Rigo2b3eb402003-10-28 12:05:48 +0000675 Py_LeaveRecursiveCall();
Guido van Rossume797ec12001-01-17 15:24:28 +0000676 return res;
677}
678
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000679/* Perform a rich comparison with integer result. This wraps
680 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000681int
682PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
683{
Raymond Hettinger93d44812004-03-21 17:01:44 +0000684 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000685 int ok;
686
Raymond Hettinger93d44812004-03-21 17:01:44 +0000687 res = PyObject_RichCompare(v, w, op);
Guido van Rossume797ec12001-01-17 15:24:28 +0000688 if (res == NULL)
689 return -1;
Guido van Rossum81912d42002-08-24 05:33:28 +0000690 if (PyBool_Check(res))
691 ok = (res == Py_True);
692 else
693 ok = PyObject_IsTrue(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000694 Py_DECREF(res);
695 return ok;
696}
Fred Drake13634cf2000-06-29 19:17:04 +0000697
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000698/* Turn the result of a three-way comparison into the result expected by a
699 rich comparison. */
700PyObject *
701Py_CmpToRich(int op, int cmp)
702{
703 PyObject *res;
704 int ok;
705
706 if (PyErr_Occurred())
707 return NULL;
708 switch (op) {
709 case Py_LT:
710 ok = cmp < 0;
711 break;
712 case Py_LE:
713 ok = cmp <= 0;
714 break;
715 case Py_EQ:
716 ok = cmp == 0;
717 break;
718 case Py_NE:
719 ok = cmp != 0;
720 break;
721 case Py_GT:
722 ok = cmp > 0;
723 break;
724 case Py_GE:
725 ok = cmp >= 0;
726 break;
727 default:
728 PyErr_BadArgument();
729 return NULL;
730 }
731 res = ok ? Py_True : Py_False;
732 Py_INCREF(res);
733 return res;
734}
735
Fred Drake13634cf2000-06-29 19:17:04 +0000736/* Set of hash utility functions to help maintaining the invariant that
Raymond Hettinger8183fa42004-03-21 17:35:06 +0000737 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000738
739 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
740*/
741
742long
Fred Drake100814d2000-07-09 15:48:49 +0000743_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000744{
Tim Peters39dce292000-08-15 03:34:48 +0000745 double intpart, fractpart;
746 int expo;
747 long hipart;
748 long x; /* the final hash value */
749 /* This is designed so that Python numbers of different types
750 * that compare equal hash to the same value; otherwise comparisons
751 * of mapping keys will turn out weird.
752 */
753
Tim Peters39dce292000-08-15 03:34:48 +0000754 fractpart = modf(v, &intpart);
Tim Peters39dce292000-08-15 03:34:48 +0000755 if (fractpart == 0.0) {
756 /* This must return the same hash as an equal int or long. */
757 if (intpart > LONG_MAX || -intpart > LONG_MAX) {
758 /* Convert to long and use its hash. */
759 PyObject *plong; /* converted to Python long */
760 if (Py_IS_INFINITY(intpart))
761 /* can't convert to long int -- arbitrary */
762 v = v < 0 ? -271828.0 : 314159.0;
763 plong = PyLong_FromDouble(v);
764 if (plong == NULL)
765 return -1;
766 x = PyObject_Hash(plong);
767 Py_DECREF(plong);
768 return x;
769 }
770 /* Fits in a C long == a Python int, so is its own hash. */
771 x = (long)intpart;
772 if (x == -1)
773 x = -2;
774 return x;
775 }
776 /* The fractional part is non-zero, so we don't have to worry about
777 * making this match the hash of some other type.
778 * Use frexp to get at the bits in the double.
Fred Drake13634cf2000-06-29 19:17:04 +0000779 * Since the VAX D double format has 56 mantissa bits, which is the
780 * most of any double format in use, each of these parts may have as
781 * many as (but no more than) 56 significant bits.
Tim Peters39dce292000-08-15 03:34:48 +0000782 * So, assuming sizeof(long) >= 4, each part can be broken into two
783 * longs; frexp and multiplication are used to do that.
784 * Also, since the Cray double format has 15 exponent bits, which is
785 * the most of any double format in use, shifting the exponent field
786 * left by 15 won't overflow a long (again assuming sizeof(long) >= 4).
Fred Drake13634cf2000-06-29 19:17:04 +0000787 */
Tim Peters39dce292000-08-15 03:34:48 +0000788 v = frexp(v, &expo);
789 v *= 2147483648.0; /* 2**31 */
790 hipart = (long)v; /* take the top 32 bits */
791 v = (v - (double)hipart) * 2147483648.0; /* get the next 32 bits */
792 x = hipart + (long)v + (expo << 15);
793 if (x == -1)
794 x = -2;
795 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000796}
797
798long
Fred Drake100814d2000-07-09 15:48:49 +0000799_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000800{
801#if SIZEOF_LONG >= SIZEOF_VOID_P
802 return (long)p;
803#else
804 /* convert to a Python long and hash that */
805 PyObject* longobj;
806 long x;
Tim Peters803526b2002-07-07 05:13:56 +0000807
Fred Drake13634cf2000-06-29 19:17:04 +0000808 if ((longobj = PyLong_FromVoidPtr(p)) == NULL) {
809 x = -1;
810 goto finally;
811 }
812 x = PyObject_Hash(longobj);
Tim Peters803526b2002-07-07 05:13:56 +0000813
Fred Drake13634cf2000-06-29 19:17:04 +0000814finally:
815 Py_XDECREF(longobj);
816 return x;
817#endif
818}
819
820
Guido van Rossum9bfef441993-03-29 10:43:31 +0000821long
Fred Drake100814d2000-07-09 15:48:49 +0000822PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000823{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000824 PyTypeObject *tp = v->ob_type;
Guido van Rossum9bfef441993-03-29 10:43:31 +0000825 if (tp->tp_hash != NULL)
826 return (*tp->tp_hash)(v);
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000827 /* Otherwise, the object can't be hashed */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000828 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
829 v->ob_type->tp_name);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000830 return -1;
831}
832
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000833PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000834PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000835{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000836 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000837
Tim Peters6d6c1a32001-08-02 04:15:00 +0000838 if (v->ob_type->tp_getattr != NULL)
Martin v. Löwis15e62742006-02-27 16:46:16 +0000839 return (*v->ob_type->tp_getattr)(v, (char*)name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000840 w = PyString_InternFromString(name);
841 if (w == NULL)
842 return NULL;
843 res = PyObject_GetAttr(v, w);
844 Py_XDECREF(w);
845 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000846}
847
848int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000849PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000850{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000851 PyObject *res = PyObject_GetAttrString(v, name);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000852 if (res != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000853 Py_DECREF(res);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000854 return 1;
855 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000856 PyErr_Clear();
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000857 return 0;
858}
859
860int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000861PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000862{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000863 PyObject *s;
864 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000865
Tim Peters6d6c1a32001-08-02 04:15:00 +0000866 if (v->ob_type->tp_setattr != NULL)
Martin v. Löwis15e62742006-02-27 16:46:16 +0000867 return (*v->ob_type->tp_setattr)(v, (char*)name, w);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000868 s = PyString_InternFromString(name);
869 if (s == NULL)
870 return -1;
871 res = PyObject_SetAttr(v, s, w);
872 Py_XDECREF(s);
873 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000874}
875
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000876PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000877PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000878{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000879 PyTypeObject *tp = v->ob_type;
880
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000881 if (!PyString_Check(name)) {
Martin v. Löwis0c160a02002-03-15 13:40:30 +0000882 /* The Unicode to string conversion is done here because the
883 existing tp_getattro slots expect a string object as name
884 and we wouldn't want to break those. */
885 if (PyUnicode_Check(name)) {
886 name = _PyUnicode_AsDefaultEncodedString(name, NULL);
887 if (name == NULL)
888 return NULL;
889 }
890 else
Martin v. Löwis0c160a02002-03-15 13:40:30 +0000891 {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000892 PyErr_Format(PyExc_TypeError,
893 "attribute name must be string, not '%.200s'",
894 name->ob_type->tp_name);
Martin v. Löwis0c160a02002-03-15 13:40:30 +0000895 return NULL;
896 }
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000897 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000898 if (tp->tp_getattro != NULL)
899 return (*tp->tp_getattro)(v, name);
900 if (tp->tp_getattr != NULL)
901 return (*tp->tp_getattr)(v, PyString_AS_STRING(name));
902 PyErr_Format(PyExc_AttributeError,
903 "'%.50s' object has no attribute '%.400s'",
904 tp->tp_name, PyString_AS_STRING(name));
905 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000906}
907
908int
Fred Drake100814d2000-07-09 15:48:49 +0000909PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000910{
911 PyObject *res = PyObject_GetAttr(v, name);
912 if (res != NULL) {
913 Py_DECREF(res);
914 return 1;
915 }
916 PyErr_Clear();
917 return 0;
918}
919
920int
Fred Drake100814d2000-07-09 15:48:49 +0000921PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000922{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000923 PyTypeObject *tp = v->ob_type;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000924 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000925
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000926 if (!PyString_Check(name)) {
Martin v. Löwis0c160a02002-03-15 13:40:30 +0000927 /* The Unicode to string conversion is done here because the
928 existing tp_setattro slots expect a string object as name
929 and we wouldn't want to break those. */
930 if (PyUnicode_Check(name)) {
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000931 name = _PyUnicode_AsDefaultEncodedString(name, NULL);
Martin v. Löwis0c160a02002-03-15 13:40:30 +0000932 if (name == NULL)
933 return -1;
934 }
Tim Peters803526b2002-07-07 05:13:56 +0000935 else
Martin v. Löwis0c160a02002-03-15 13:40:30 +0000936 {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000937 PyErr_Format(PyExc_TypeError,
938 "attribute name must be string, not '%.200s'",
939 name->ob_type->tp_name);
Martin v. Löwis0c160a02002-03-15 13:40:30 +0000940 return -1;
941 }
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000942 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000943 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000944
945 PyString_InternInPlace(&name);
946 if (tp->tp_setattro != NULL) {
947 err = (*tp->tp_setattro)(v, name, value);
948 Py_DECREF(name);
949 return err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000950 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000951 if (tp->tp_setattr != NULL) {
952 err = (*tp->tp_setattr)(v, PyString_AS_STRING(name), value);
953 Py_DECREF(name);
954 return err;
955 }
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000956 Py_DECREF(name);
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000957 assert(name->ob_refcnt >= 1);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000958 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
959 PyErr_Format(PyExc_TypeError,
960 "'%.100s' object has no attributes "
961 "(%s .%.100s)",
962 tp->tp_name,
963 value==NULL ? "del" : "assign to",
964 PyString_AS_STRING(name));
965 else
966 PyErr_Format(PyExc_TypeError,
967 "'%.100s' object has only read-only attributes "
968 "(%s .%.100s)",
969 tp->tp_name,
970 value==NULL ? "del" : "assign to",
971 PyString_AS_STRING(name));
972 return -1;
973}
974
975/* Helper to get a pointer to an object's __dict__ slot, if any */
976
977PyObject **
978_PyObject_GetDictPtr(PyObject *obj)
979{
Martin v. Löwis725507b2006-03-07 12:08:51 +0000980 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000981 PyTypeObject *tp = obj->ob_type;
982
Tim Peters6d6c1a32001-08-02 04:15:00 +0000983 dictoffset = tp->tp_dictoffset;
984 if (dictoffset == 0)
985 return NULL;
986 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000987 Py_ssize_t tsize;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000988 size_t size;
989
990 tsize = ((PyVarObject *)obj)->ob_size;
991 if (tsize < 0)
992 tsize = -tsize;
993 size = _PyObject_VAR_SIZE(tp, tsize);
994
Tim Peters6d483d32001-10-06 21:27:34 +0000995 dictoffset += (long)size;
996 assert(dictoffset > 0);
997 assert(dictoffset % SIZEOF_VOID_P == 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000998 }
999 return (PyObject **) ((char *)obj + dictoffset);
1000}
1001
Tim Peters6d6c1a32001-08-02 04:15:00 +00001002PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +00001003PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +00001004{
1005 Py_INCREF(obj);
1006 return obj;
1007}
1008
Michael W. Hudson1593f502004-09-14 17:09:47 +00001009/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
1010
Raymond Hettinger01538262003-03-17 08:24:35 +00001011PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001012PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
1013{
1014 PyTypeObject *tp = obj->ob_type;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001015 PyObject *descr = NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001016 PyObject *res = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001017 descrgetfunc f;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001018 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001019 PyObject **dictptr;
1020
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001021 if (!PyString_Check(name)){
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001022 /* The Unicode to string conversion is done here because the
1023 existing tp_setattro slots expect a string object as name
1024 and we wouldn't want to break those. */
1025 if (PyUnicode_Check(name)) {
1026 name = PyUnicode_AsEncodedString(name, NULL, NULL);
1027 if (name == NULL)
1028 return NULL;
1029 }
Tim Peters803526b2002-07-07 05:13:56 +00001030 else
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001031 {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001032 PyErr_Format(PyExc_TypeError,
1033 "attribute name must be string, not '%.200s'",
1034 name->ob_type->tp_name);
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001035 return NULL;
1036 }
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001037 }
1038 else
1039 Py_INCREF(name);
1040
Tim Peters6d6c1a32001-08-02 04:15:00 +00001041 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001042 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001043 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001044 }
1045
Guido van Rossum056fbf42002-08-19 19:22:50 +00001046 /* Inline _PyType_Lookup */
1047 {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001048 Py_ssize_t i, n;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001049 PyObject *mro, *base, *dict;
1050
1051 /* Look in tp_dict of types in MRO */
1052 mro = tp->tp_mro;
1053 assert(mro != NULL);
1054 assert(PyTuple_Check(mro));
1055 n = PyTuple_GET_SIZE(mro);
1056 for (i = 0; i < n; i++) {
1057 base = PyTuple_GET_ITEM(mro, i);
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001058 assert(PyType_Check(base));
1059 dict = ((PyTypeObject *)base)->tp_dict;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001060 assert(dict && PyDict_Check(dict));
1061 descr = PyDict_GetItem(dict, name);
1062 if (descr != NULL)
1063 break;
1064 }
1065 }
1066
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001067 Py_XINCREF(descr);
1068
Tim Peters6d6c1a32001-08-02 04:15:00 +00001069 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001070 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001071 f = descr->ob_type->tp_descr_get;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001072 if (f != NULL && PyDescr_IsData(descr)) {
1073 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001074 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001075 goto done;
1076 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001077 }
1078
Guido van Rossumc66ff442002-08-19 16:50:48 +00001079 /* Inline _PyObject_GetDictPtr */
1080 dictoffset = tp->tp_dictoffset;
1081 if (dictoffset != 0) {
1082 PyObject *dict;
1083 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001084 Py_ssize_t tsize;
Guido van Rossumc66ff442002-08-19 16:50:48 +00001085 size_t size;
1086
1087 tsize = ((PyVarObject *)obj)->ob_size;
1088 if (tsize < 0)
1089 tsize = -tsize;
1090 size = _PyObject_VAR_SIZE(tp, tsize);
1091
1092 dictoffset += (long)size;
1093 assert(dictoffset > 0);
1094 assert(dictoffset % SIZEOF_VOID_P == 0);
1095 }
1096 dictptr = (PyObject **) ((char *)obj + dictoffset);
1097 dict = *dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001098 if (dict != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001099 res = PyDict_GetItem(dict, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001100 if (res != NULL) {
1101 Py_INCREF(res);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001102 Py_XDECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001103 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001104 }
1105 }
1106 }
1107
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001108 if (f != NULL) {
1109 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001110 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001111 goto done;
1112 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001113
1114 if (descr != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001115 res = descr;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001116 /* descr was already increfed above */
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001117 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001118 }
1119
1120 PyErr_Format(PyExc_AttributeError,
1121 "'%.50s' object has no attribute '%.400s'",
1122 tp->tp_name, PyString_AS_STRING(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001123 done:
1124 Py_DECREF(name);
1125 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001126}
1127
1128int
1129PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1130{
1131 PyTypeObject *tp = obj->ob_type;
1132 PyObject *descr;
1133 descrsetfunc f;
1134 PyObject **dictptr;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001135 int res = -1;
1136
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001137 if (!PyString_Check(name)){
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001138 /* The Unicode to string conversion is done here because the
1139 existing tp_setattro slots expect a string object as name
1140 and we wouldn't want to break those. */
1141 if (PyUnicode_Check(name)) {
1142 name = PyUnicode_AsEncodedString(name, NULL, NULL);
1143 if (name == NULL)
1144 return -1;
1145 }
Tim Peters803526b2002-07-07 05:13:56 +00001146 else
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001147 {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001148 PyErr_Format(PyExc_TypeError,
1149 "attribute name must be string, not '%.200s'",
1150 name->ob_type->tp_name);
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001151 return -1;
1152 }
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001153 }
1154 else
1155 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001156
1157 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001158 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001159 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001160 }
1161
1162 descr = _PyType_Lookup(tp, name);
1163 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001164 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001165 f = descr->ob_type->tp_descr_set;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001166 if (f != NULL && PyDescr_IsData(descr)) {
1167 res = f(descr, obj, value);
1168 goto done;
1169 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001170 }
1171
1172 dictptr = _PyObject_GetDictPtr(obj);
1173 if (dictptr != NULL) {
1174 PyObject *dict = *dictptr;
1175 if (dict == NULL && value != NULL) {
1176 dict = PyDict_New();
1177 if (dict == NULL)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001178 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001179 *dictptr = dict;
1180 }
1181 if (dict != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001182 if (value == NULL)
1183 res = PyDict_DelItem(dict, name);
1184 else
1185 res = PyDict_SetItem(dict, name, value);
1186 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1187 PyErr_SetObject(PyExc_AttributeError, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001188 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001189 }
1190 }
1191
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001192 if (f != NULL) {
1193 res = f(descr, obj, value);
1194 goto done;
1195 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001196
1197 if (descr == NULL) {
1198 PyErr_Format(PyExc_AttributeError,
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001199 "'%.100s' object has no attribute '%.200s'",
Tim Peters6d6c1a32001-08-02 04:15:00 +00001200 tp->tp_name, PyString_AS_STRING(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001201 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001202 }
1203
1204 PyErr_Format(PyExc_AttributeError,
1205 "'%.50s' object attribute '%.400s' is read-only",
1206 tp->tp_name, PyString_AS_STRING(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001207 done:
1208 Py_DECREF(name);
1209 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001210}
1211
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001212/* Test a value used as condition, e.g., in a for or if statement.
1213 Return -1 if an error occurred */
1214
1215int
Fred Drake100814d2000-07-09 15:48:49 +00001216PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001217{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001218 Py_ssize_t res;
Guido van Rossum6248f442002-08-24 06:31:34 +00001219 if (v == Py_True)
1220 return 1;
1221 if (v == Py_False)
1222 return 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001223 if (v == Py_None)
Neal Norwitz51290d32002-06-13 21:32:44 +00001224 return 0;
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001225 else if (v->ob_type->tp_as_number != NULL &&
Jack Diederich4dafcc42006-11-28 19:15:13 +00001226 v->ob_type->tp_as_number->nb_bool != NULL)
1227 res = (*v->ob_type->tp_as_number->nb_bool)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001228 else if (v->ob_type->tp_as_mapping != NULL &&
1229 v->ob_type->tp_as_mapping->mp_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001230 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001231 else if (v->ob_type->tp_as_sequence != NULL &&
1232 v->ob_type->tp_as_sequence->sq_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001233 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1234 else
Neal Norwitz51290d32002-06-13 21:32:44 +00001235 return 1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001236 /* if it is negative, it should be either -1 or -2 */
1237 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001238}
1239
Tim Peters803526b2002-07-07 05:13:56 +00001240/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001241 Return -1 if an error occurred */
1242
1243int
Fred Drake100814d2000-07-09 15:48:49 +00001244PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001245{
1246 int res;
1247 res = PyObject_IsTrue(v);
1248 if (res < 0)
1249 return res;
1250 return res == 0;
1251}
1252
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001253/* Test whether an object can be called */
1254
1255int
Fred Drake100814d2000-07-09 15:48:49 +00001256PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001257{
1258 if (x == NULL)
1259 return 0;
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001260 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001261}
1262
Georg Brandle32b4222007-03-10 22:13:27 +00001263/* ------------------------- PyObject_Dir() helpers ------------------------- */
1264
Tim Peters7eea37e2001-09-04 22:08:56 +00001265/* Helper for PyObject_Dir.
1266 Merge the __dict__ of aclass into dict, and recursively also all
1267 the __dict__s of aclass's base classes. The order of merging isn't
1268 defined, as it's expected that only the final set of dict keys is
1269 interesting.
1270 Return 0 on success, -1 on error.
1271*/
1272
1273static int
1274merge_class_dict(PyObject* dict, PyObject* aclass)
1275{
1276 PyObject *classdict;
1277 PyObject *bases;
1278
1279 assert(PyDict_Check(dict));
1280 assert(aclass);
1281
1282 /* Merge in the type's dict (if any). */
1283 classdict = PyObject_GetAttrString(aclass, "__dict__");
1284 if (classdict == NULL)
1285 PyErr_Clear();
1286 else {
1287 int status = PyDict_Update(dict, classdict);
1288 Py_DECREF(classdict);
1289 if (status < 0)
1290 return -1;
1291 }
1292
1293 /* Recursively merge in the base types' (if any) dicts. */
1294 bases = PyObject_GetAttrString(aclass, "__bases__");
Tim Petersbc7e8632001-09-16 20:33:22 +00001295 if (bases == NULL)
1296 PyErr_Clear();
1297 else {
Guido van Rossum44022412002-05-13 18:29:46 +00001298 /* We have no guarantee that bases is a real tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001299 Py_ssize_t i, n;
Guido van Rossum44022412002-05-13 18:29:46 +00001300 n = PySequence_Size(bases); /* This better be right */
1301 if (n < 0)
1302 PyErr_Clear();
1303 else {
1304 for (i = 0; i < n; i++) {
Tim Peters18e70832003-02-05 19:35:19 +00001305 int status;
Guido van Rossum44022412002-05-13 18:29:46 +00001306 PyObject *base = PySequence_GetItem(bases, i);
1307 if (base == NULL) {
1308 Py_DECREF(bases);
1309 return -1;
1310 }
Tim Peters18e70832003-02-05 19:35:19 +00001311 status = merge_class_dict(dict, base);
1312 Py_DECREF(base);
1313 if (status < 0) {
Guido van Rossum44022412002-05-13 18:29:46 +00001314 Py_DECREF(bases);
1315 return -1;
1316 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001317 }
1318 }
1319 Py_DECREF(bases);
1320 }
1321 return 0;
1322}
1323
Georg Brandle32b4222007-03-10 22:13:27 +00001324/* Helper for PyObject_Dir without arguments: returns the local scope. */
1325static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001326_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001327{
Georg Brandled3b8382007-03-12 13:15:14 +00001328 PyObject *names;
Georg Brandle32b4222007-03-10 22:13:27 +00001329 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001330
Georg Brandle32b4222007-03-10 22:13:27 +00001331 if (locals == NULL) {
1332 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1333 return NULL;
Tim Peters305b5852001-09-17 02:38:46 +00001334 }
1335
Georg Brandled3b8382007-03-12 13:15:14 +00001336 names = PyMapping_Keys(locals);
1337 if (!names)
1338 return NULL;
1339 if (!PyList_Check(names)) {
1340 PyErr_Format(PyExc_TypeError,
1341 "dir(): expected keys() of locals to be a list, "
1342 "not '%.200s'", names->ob_type->tp_name);
1343 Py_DECREF(names);
1344 return NULL;
1345 }
Georg Brandle32b4222007-03-10 22:13:27 +00001346 /* the locals don't need to be DECREF'd */
Georg Brandled3b8382007-03-12 13:15:14 +00001347 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001348}
1349
1350/* Helper for PyObject_Dir of type objects: returns __dict__ and __bases__.
1351 We deliberately don't suck up its __class__, as methods belonging to the
1352 metaclass would probably be more confusing than helpful.
1353*/
1354static PyObject *
1355_specialized_dir_type(PyObject *obj)
1356{
1357 PyObject *result = NULL;
1358 PyObject *dict = PyDict_New();
1359
1360 if (dict != NULL && merge_class_dict(dict, obj) == 0)
1361 result = PyDict_Keys(dict);
1362
1363 Py_XDECREF(dict);
Tim Peters305b5852001-09-17 02:38:46 +00001364 return result;
1365}
1366
Georg Brandle32b4222007-03-10 22:13:27 +00001367/* Helper for PyObject_Dir of module objects: returns the module's __dict__. */
1368static PyObject *
1369_specialized_dir_module(PyObject *obj)
Tim Peters7eea37e2001-09-04 22:08:56 +00001370{
Georg Brandle32b4222007-03-10 22:13:27 +00001371 PyObject *result = NULL;
1372 PyObject *dict = PyObject_GetAttrString(obj, "__dict__");
Tim Peters7eea37e2001-09-04 22:08:56 +00001373
Georg Brandle32b4222007-03-10 22:13:27 +00001374 if (dict != NULL) {
1375 if (PyDict_Check(dict))
1376 result = PyDict_Keys(dict);
1377 else {
1378 PyErr_Format(PyExc_TypeError,
1379 "%.200s.__dict__ is not a dictionary",
1380 PyModule_GetName(obj));
Guido van Rossum8dbd3d82001-09-10 18:27:43 +00001381 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001382 }
1383
Georg Brandle32b4222007-03-10 22:13:27 +00001384 Py_XDECREF(dict);
1385 return result;
1386}
Tim Peters7eea37e2001-09-04 22:08:56 +00001387
Georg Brandle32b4222007-03-10 22:13:27 +00001388/* Helper for PyObject_Dir of generic objects: returns __dict__, __class__,
1389 and recursively up the __class__.__bases__ chain.
1390*/
1391static PyObject *
1392_generic_dir(PyObject *obj)
1393{
1394 PyObject *result = NULL;
1395 PyObject *dict = NULL;
1396 PyObject *itsclass = NULL;
1397
1398 /* Get __dict__ (which may or may not be a real dict...) */
1399 dict = PyObject_GetAttrString(obj, "__dict__");
1400 if (dict == NULL) {
1401 PyErr_Clear();
1402 dict = PyDict_New();
1403 }
1404 else if (!PyDict_Check(dict)) {
1405 Py_DECREF(dict);
1406 dict = PyDict_New();
1407 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001408 else {
Georg Brandle32b4222007-03-10 22:13:27 +00001409 /* Copy __dict__ to avoid mutating it. */
1410 PyObject *temp = PyDict_Copy(dict);
1411 Py_DECREF(dict);
1412 dict = temp;
Tim Peters7eea37e2001-09-04 22:08:56 +00001413 }
1414
Georg Brandle32b4222007-03-10 22:13:27 +00001415 if (dict == NULL)
Raymond Hettinger2a7dede2004-08-07 04:55:30 +00001416 goto error;
Tim Peters7eea37e2001-09-04 22:08:56 +00001417
Georg Brandle32b4222007-03-10 22:13:27 +00001418 /* Merge in attrs reachable from its class. */
1419 itsclass = PyObject_GetAttrString(obj, "__class__");
1420 if (itsclass == NULL)
1421 /* XXX(tomer): Perhaps fall back to obj->ob_type if no
1422 __class__ exists? */
1423 PyErr_Clear();
1424 else {
1425 if (merge_class_dict(dict, itsclass) != 0)
1426 goto error;
1427 }
1428
1429 result = PyDict_Keys(dict);
Tim Peters7eea37e2001-09-04 22:08:56 +00001430 /* fall through */
Georg Brandle32b4222007-03-10 22:13:27 +00001431error:
1432 Py_XDECREF(itsclass);
1433 Py_XDECREF(dict);
1434 return result;
1435}
1436
1437/* Helper for PyObject_Dir: object introspection.
1438 This calls one of the above specialized versions if no __dir__ method
1439 exists. */
1440static PyObject *
1441_dir_object(PyObject *obj)
1442{
1443 PyObject * result = NULL;
1444 PyObject * dirfunc = PyObject_GetAttrString((PyObject*)obj->ob_type,
1445 "__dir__");
1446
1447 assert(obj);
1448 if (dirfunc == NULL) {
1449 /* use default implementation */
1450 PyErr_Clear();
1451 if (PyModule_Check(obj))
1452 result = _specialized_dir_module(obj);
1453 else if (PyType_Check(obj))
1454 result = _specialized_dir_type(obj);
1455 else
1456 result = _generic_dir(obj);
1457 }
1458 else {
1459 /* use __dir__ */
1460 result = PyObject_CallFunctionObjArgs(dirfunc, obj, NULL);
1461 Py_DECREF(dirfunc);
1462 if (result == NULL)
1463 return NULL;
1464
1465 /* result must be a list */
1466 /* XXX(gbrandl): could also check if all items are strings */
1467 if (!PyList_Check(result)) {
1468 PyErr_Format(PyExc_TypeError,
1469 "__dir__() must return a list, not %.200s",
1470 result->ob_type->tp_name);
1471 Py_DECREF(result);
1472 result = NULL;
1473 }
1474 }
1475
1476 return result;
1477}
1478
1479/* Implementation of dir() -- if obj is NULL, returns the names in the current
1480 (local) scope. Otherwise, performs introspection of the object: returns a
1481 sorted list of attribute names (supposedly) accessible from the object
1482*/
1483PyObject *
1484PyObject_Dir(PyObject *obj)
1485{
1486 PyObject * result;
1487
1488 if (obj == NULL)
1489 /* no object -- introspect the locals */
1490 result = _dir_locals();
1491 else
1492 /* object -- introspect the object */
1493 result = _dir_object(obj);
1494
1495 assert(result == NULL || PyList_Check(result));
1496
1497 if (result != NULL && PyList_Sort(result) != 0) {
1498 /* sorting the list failed */
1499 Py_DECREF(result);
1500 result = NULL;
1501 }
1502
Tim Peters7eea37e2001-09-04 22:08:56 +00001503 return result;
1504}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001505
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001506/*
1507NoObject is usable as a non-NULL undefined value, used by the macro None.
1508There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001509so there is exactly one (which is indestructible, by the way).
Guido van Rossumba21a492001-08-16 08:17:26 +00001510(XXX This type and the type of NotImplemented below should be unified.)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001511*/
1512
Guido van Rossum0c182a11992-03-27 17:26:13 +00001513/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001514static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001515none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001516{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001517 return PyString_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001518}
1519
Barry Warsaw9bf16442001-01-23 16:24:35 +00001520/* ARGUSED */
1521static void
Tim Peters803526b2002-07-07 05:13:56 +00001522none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001523{
1524 /* This should never get called, but we also don't want to SEGV if
1525 * we accidently decref None out of existance.
1526 */
Martin v. Löwis3f19b102002-08-07 16:21:51 +00001527 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001528}
1529
1530
Guido van Rossumba21a492001-08-16 08:17:26 +00001531static PyTypeObject PyNone_Type = {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001532 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001533 0,
Guido van Rossumba21a492001-08-16 08:17:26 +00001534 "NoneType",
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001535 0,
1536 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001537 none_dealloc, /*tp_dealloc*/ /*never called*/
Guido van Rossum7066dd71992-09-17 17:54:56 +00001538 0, /*tp_print*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001539 0, /*tp_getattr*/
1540 0, /*tp_setattr*/
1541 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001542 none_repr, /*tp_repr*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001543 0, /*tp_as_number*/
1544 0, /*tp_as_sequence*/
1545 0, /*tp_as_mapping*/
Guido van Rossum9bfef441993-03-29 10:43:31 +00001546 0, /*tp_hash */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001547};
1548
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001549PyObject _Py_NoneStruct = {
Guido van Rossumba21a492001-08-16 08:17:26 +00001550 PyObject_HEAD_INIT(&PyNone_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001551};
1552
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001553/* NotImplemented is an object that can be used to signal that an
1554 operation is not implemented for the given type combination. */
1555
1556static PyObject *
1557NotImplemented_repr(PyObject *op)
1558{
1559 return PyString_FromString("NotImplemented");
1560}
1561
1562static PyTypeObject PyNotImplemented_Type = {
1563 PyObject_HEAD_INIT(&PyType_Type)
1564 0,
Guido van Rossumba21a492001-08-16 08:17:26 +00001565 "NotImplementedType",
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001566 0,
1567 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001568 none_dealloc, /*tp_dealloc*/ /*never called*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001569 0, /*tp_print*/
1570 0, /*tp_getattr*/
1571 0, /*tp_setattr*/
1572 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001573 NotImplemented_repr, /*tp_repr*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001574 0, /*tp_as_number*/
1575 0, /*tp_as_sequence*/
1576 0, /*tp_as_mapping*/
1577 0, /*tp_hash */
1578};
1579
1580PyObject _Py_NotImplementedStruct = {
1581 PyObject_HEAD_INIT(&PyNotImplemented_Type)
1582};
1583
Guido van Rossumba21a492001-08-16 08:17:26 +00001584void
1585_Py_ReadyTypes(void)
1586{
1587 if (PyType_Ready(&PyType_Type) < 0)
1588 Py_FatalError("Can't initialize 'type'");
1589
Fred Drake0a4dd392004-07-02 18:57:45 +00001590 if (PyType_Ready(&_PyWeakref_RefType) < 0)
1591 Py_FatalError("Can't initialize 'weakref'");
1592
Guido van Rossum77f6a652002-04-03 22:41:51 +00001593 if (PyType_Ready(&PyBool_Type) < 0)
1594 Py_FatalError("Can't initialize 'bool'");
1595
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001596 if (PyType_Ready(&PyBytes_Type) < 0)
1597 Py_FatalError("Can't initialize 'bytes'");
1598
Guido van Rossumcacfc072002-05-24 19:01:59 +00001599 if (PyType_Ready(&PyString_Type) < 0)
1600 Py_FatalError("Can't initialize 'str'");
1601
Guido van Rossumba21a492001-08-16 08:17:26 +00001602 if (PyType_Ready(&PyList_Type) < 0)
1603 Py_FatalError("Can't initialize 'list'");
1604
1605 if (PyType_Ready(&PyNone_Type) < 0)
1606 Py_FatalError("Can't initialize type(None)");
1607
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001608 if (PyType_Ready(Py_Ellipsis->ob_type) < 0)
1609 Py_FatalError("Can't initialize type(Ellipsis)");
1610
Guido van Rossumba21a492001-08-16 08:17:26 +00001611 if (PyType_Ready(&PyNotImplemented_Type) < 0)
1612 Py_FatalError("Can't initialize type(NotImplemented)");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001613
1614 if (PyType_Ready(&PyCode_Type) < 0)
1615 Py_FatalError("Can't initialize 'code'");
Guido van Rossumba21a492001-08-16 08:17:26 +00001616}
1617
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001618
Guido van Rossum84a90321996-05-22 16:34:47 +00001619#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001620
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001621void
Fred Drake100814d2000-07-09 15:48:49 +00001622_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001623{
Tim Peters34592512002-07-11 06:23:50 +00001624 _Py_INC_REFTOTAL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001625 op->ob_refcnt = 1;
Tim Peters7571a0f2003-03-23 17:52:28 +00001626 _Py_AddToAllObjects(op, 1);
Tim Peters34592512002-07-11 06:23:50 +00001627 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001628}
1629
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001630void
Fred Drake100814d2000-07-09 15:48:49 +00001631_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001632{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001633#ifdef SLOW_UNREF_CHECK
Guido van Rossum4c08d552000-03-10 22:55:18 +00001634 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001635#endif
Guido van Rossumd7047b31995-01-02 19:07:15 +00001636 if (op->ob_refcnt < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001637 Py_FatalError("UNREF negative refcnt");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001638 if (op == &refchain ||
Guido van Rossumd7047b31995-01-02 19:07:15 +00001639 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001640 Py_FatalError("UNREF invalid object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001641#ifdef SLOW_UNREF_CHECK
Guido van Rossum3f5da241990-12-20 15:06:42 +00001642 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1643 if (p == op)
1644 break;
1645 }
Guido van Rossumd7047b31995-01-02 19:07:15 +00001646 if (p == &refchain) /* Not found */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001647 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001648#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001649 op->_ob_next->_ob_prev = op->_ob_prev;
1650 op->_ob_prev->_ob_next = op->_ob_next;
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001651 op->_ob_next = op->_ob_prev = NULL;
Tim Peters34592512002-07-11 06:23:50 +00001652 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001653}
1654
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001655void
Fred Drake100814d2000-07-09 15:48:49 +00001656_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001657{
Guido van Rossum9776adf1994-09-07 14:36:45 +00001658 destructor dealloc = op->ob_type->tp_dealloc;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001659 _Py_ForgetReference(op);
Guido van Rossum9776adf1994-09-07 14:36:45 +00001660 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001661}
1662
Tim Peters269b2a62003-04-17 19:52:29 +00001663/* Print all live objects. Because PyObject_Print is called, the
1664 * interpreter must be in a healthy state.
1665 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001666void
Fred Drake100814d2000-07-09 15:48:49 +00001667_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001668{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001669 PyObject *op;
Guido van Rossume09fb551997-08-05 02:04:34 +00001670 fprintf(fp, "Remaining objects:\n");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001671 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001672 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001673 if (PyObject_Print(op, fp, 0) != 0)
1674 PyErr_Clear();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001675 putc('\n', fp);
1676 }
1677}
1678
Tim Peters269b2a62003-04-17 19:52:29 +00001679/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1680 * doesn't make any calls to the Python C API, so is always safe to call.
1681 */
1682void
1683_Py_PrintReferenceAddresses(FILE *fp)
1684{
1685 PyObject *op;
1686 fprintf(fp, "Remaining object addresses:\n");
1687 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001688 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
1689 op->ob_refcnt, op->ob_type->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001690}
1691
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001692PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001693_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001694{
1695 int i, n;
1696 PyObject *t = NULL;
1697 PyObject *res, *op;
1698
1699 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1700 return NULL;
1701 op = refchain._ob_next;
1702 res = PyList_New(0);
1703 if (res == NULL)
1704 return NULL;
1705 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1706 while (op == self || op == args || op == res || op == t ||
Guido van Rossum3c296022001-07-14 17:58:00 +00001707 (t != NULL && op->ob_type != (PyTypeObject *) t)) {
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001708 op = op->_ob_next;
1709 if (op == &refchain)
1710 return res;
1711 }
1712 if (PyList_Append(res, op) < 0) {
1713 Py_DECREF(res);
1714 return NULL;
1715 }
1716 op = op->_ob_next;
1717 }
1718 return res;
1719}
1720
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001721#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001722
1723
1724/* Hack to force loading of cobject.o */
Guido van Rossumda9c2711996-12-05 21:58:58 +00001725PyTypeObject *_Py_cobject_hack = &PyCObject_Type;
Guido van Rossum84a90321996-05-22 16:34:47 +00001726
1727
1728/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001729Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001730
1731
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001732/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001733
Thomas Wouters334fb892000-07-25 12:56:38 +00001734void *
Fred Drake100814d2000-07-09 15:48:49 +00001735PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001736{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001737 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001738}
1739
Thomas Wouters334fb892000-07-25 12:56:38 +00001740void *
1741PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001742{
Tim Petersaf3e8de2002-04-12 07:22:56 +00001743 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001744}
1745
1746void
Thomas Wouters334fb892000-07-25 12:56:38 +00001747PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001748{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001749 PyMem_FREE(p);
1750}
1751
1752
Guido van Rossum86610361998-04-10 22:32:46 +00001753/* These methods are used to control infinite recursion in repr, str, print,
1754 etc. Container objects that may recursively contain themselves,
1755 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1756 Py_ReprLeave() to avoid infinite recursion.
1757
1758 Py_ReprEnter() returns 0 the first time it is called for a particular
1759 object and 1 every time thereafter. It returns -1 if an exception
1760 occurred. Py_ReprLeave() has no return value.
1761
1762 See dictobject.c and listobject.c for examples of use.
1763*/
1764
1765#define KEY "Py_Repr"
1766
1767int
Fred Drake100814d2000-07-09 15:48:49 +00001768Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001769{
1770 PyObject *dict;
1771 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001772 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001773
1774 dict = PyThreadState_GetDict();
1775 if (dict == NULL)
Guido van Rossum0fc8f002003-04-15 15:12:39 +00001776 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001777 list = PyDict_GetItemString(dict, KEY);
1778 if (list == NULL) {
1779 list = PyList_New(0);
1780 if (list == NULL)
1781 return -1;
1782 if (PyDict_SetItemString(dict, KEY, list) < 0)
1783 return -1;
1784 Py_DECREF(list);
1785 }
1786 i = PyList_GET_SIZE(list);
1787 while (--i >= 0) {
1788 if (PyList_GET_ITEM(list, i) == obj)
1789 return 1;
1790 }
1791 PyList_Append(list, obj);
1792 return 0;
1793}
1794
1795void
Fred Drake100814d2000-07-09 15:48:49 +00001796Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001797{
1798 PyObject *dict;
1799 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001800 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001801
1802 dict = PyThreadState_GetDict();
Guido van Rossumeb909461998-04-11 15:17:34 +00001803 if (dict == NULL)
1804 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001805 list = PyDict_GetItemString(dict, KEY);
Guido van Rossumeb909461998-04-11 15:17:34 +00001806 if (list == NULL || !PyList_Check(list))
1807 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001808 i = PyList_GET_SIZE(list);
1809 /* Count backwards because we always expect obj to be list[-1] */
1810 while (--i >= 0) {
1811 if (PyList_GET_ITEM(list, i) == obj) {
1812 PyList_SetSlice(list, i, i + 1, NULL);
1813 break;
1814 }
1815 }
1816}
Guido van Rossumd724b232000-03-13 16:01:29 +00001817
Tim Peters803526b2002-07-07 05:13:56 +00001818/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001819
Tim Peters803526b2002-07-07 05:13:56 +00001820/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001821int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001822
Tim Peters803526b2002-07-07 05:13:56 +00001823/* List of objects that still need to be cleaned up, singly linked via their
1824 * gc headers' gc_prev pointers.
1825 */
1826PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001827
Tim Peters803526b2002-07-07 05:13:56 +00001828/* Add op to the _PyTrash_delete_later list. Called when the current
1829 * call-stack depth gets large. op must be a currently untracked gc'ed
1830 * object, with refcount 0. Py_DECREF must already have been called on it.
1831 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001832void
Fred Drake100814d2000-07-09 15:48:49 +00001833_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001834{
Tim Peters803526b2002-07-07 05:13:56 +00001835 assert(PyObject_IS_GC(op));
1836 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1837 assert(op->ob_refcnt == 0);
Neil Schemenauerf589c052002-03-29 03:05:54 +00001838 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
Guido van Rossume92e6102000-04-24 15:40:53 +00001839 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001840}
1841
Tim Peters803526b2002-07-07 05:13:56 +00001842/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1843 * the call-stack unwinds again.
1844 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001845void
Fred Drake100814d2000-07-09 15:48:49 +00001846_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001847{
1848 while (_PyTrash_delete_later) {
Tim Peters803526b2002-07-07 05:13:56 +00001849 PyObject *op = _PyTrash_delete_later;
1850 destructor dealloc = op->ob_type->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001851
Neil Schemenauerf589c052002-03-29 03:05:54 +00001852 _PyTrash_delete_later =
Tim Peters803526b2002-07-07 05:13:56 +00001853 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001854
Tim Peters803526b2002-07-07 05:13:56 +00001855 /* Call the deallocator directly. This used to try to
1856 * fool Py_DECREF into calling it indirectly, but
1857 * Py_DECREF was already called on this object, and in
1858 * assorted non-release builds calling Py_DECREF again ends
1859 * up distorting allocation statistics.
1860 */
1861 assert(op->ob_refcnt == 0);
Guido van Rossumd724b232000-03-13 16:01:29 +00001862 ++_PyTrash_delete_nesting;
Tim Peters803526b2002-07-07 05:13:56 +00001863 (*dealloc)(op);
Guido van Rossumd724b232000-03-13 16:01:29 +00001864 --_PyTrash_delete_nesting;
1865 }
1866}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001867
1868#ifdef __cplusplus
1869}
1870#endif