blob: ada1d1ec9e750ef28d8a55786d8c26359d34f9fb [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;
Fredrik Lundhefecc7d2000-07-01 14:31:09 +0000364 if (PyUnicode_Check(res)) {
365 PyObject* str;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000366 str = PyUnicode_AsEncodedString(res, NULL, NULL);
Marc-André Lemburg891bc652000-07-03 09:57:53 +0000367 Py_DECREF(res);
368 if (str)
Fredrik Lundhefecc7d2000-07-01 14:31:09 +0000369 res = str;
Marc-André Lemburg891bc652000-07-03 09:57:53 +0000370 else
371 return NULL;
Fredrik Lundhefecc7d2000-07-01 14:31:09 +0000372 }
Guido van Rossum4c08d552000-03-10 22:55:18 +0000373 if (!PyString_Check(res)) {
374 PyErr_Format(PyExc_TypeError,
Guido van Rossum5db862d2000-04-10 12:46:51 +0000375 "__repr__ returned non-string (type %.200s)",
Guido van Rossum4c08d552000-03-10 22:55:18 +0000376 res->ob_type->tp_name);
377 Py_DECREF(res);
378 return NULL;
379 }
380 return res;
381 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000382}
383
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000384PyObject *
Neil Schemenauercf52c072005-08-12 17:34:58 +0000385_PyObject_Str(PyObject *v)
Guido van Rossumc6004111993-11-05 10:22:19 +0000386{
Guido van Rossum4c08d552000-03-10 22:55:18 +0000387 PyObject *res;
Neil Schemenauercf52c072005-08-12 17:34:58 +0000388 int type_ok;
Guido van Rossumc6004111993-11-05 10:22:19 +0000389 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000390 return PyString_FromString("<NULL>");
Tim Peters5a49ade2001-09-11 01:41:59 +0000391 if (PyString_CheckExact(v)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000392 Py_INCREF(v);
Guido van Rossumc6004111993-11-05 10:22:19 +0000393 return v;
394 }
Neil Schemenauercf52c072005-08-12 17:34:58 +0000395 if (PyUnicode_CheckExact(v)) {
396 Py_INCREF(v);
397 return v;
398 }
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000399 if (v->ob_type->tp_str == NULL)
400 return PyObject_Repr(v);
401
402 res = (*v->ob_type->tp_str)(v);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000403 if (res == NULL)
404 return NULL;
Neil Schemenauercf52c072005-08-12 17:34:58 +0000405 type_ok = PyString_Check(res);
Neil Schemenauercf52c072005-08-12 17:34:58 +0000406 type_ok = type_ok || PyUnicode_Check(res);
Neil Schemenauercf52c072005-08-12 17:34:58 +0000407 if (!type_ok) {
408 PyErr_Format(PyExc_TypeError,
409 "__str__ returned non-string (type %.200s)",
410 res->ob_type->tp_name);
411 Py_DECREF(res);
412 return NULL;
413 }
414 return res;
415}
416
417PyObject *
418PyObject_Str(PyObject *v)
419{
420 PyObject *res = _PyObject_Str(v);
421 if (res == NULL)
422 return NULL;
Marc-André Lemburg891bc652000-07-03 09:57:53 +0000423 if (PyUnicode_Check(res)) {
424 PyObject* str;
425 str = PyUnicode_AsEncodedString(res, NULL, NULL);
426 Py_DECREF(res);
427 if (str)
428 res = str;
429 else
430 return NULL;
431 }
Neil Schemenauercf52c072005-08-12 17:34:58 +0000432 assert(PyString_Check(res));
Guido van Rossum4c08d552000-03-10 22:55:18 +0000433 return res;
Guido van Rossumc6004111993-11-05 10:22:19 +0000434}
435
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000436PyObject *
437PyObject_Unicode(PyObject *v)
438{
439 PyObject *res;
Brett Cannonc3647ac2005-04-26 03:45:26 +0000440 PyObject *func;
Neal Norwitz75801462006-03-14 06:02:16 +0000441 PyObject *str;
Brett Cannonc3647ac2005-04-26 03:45:26 +0000442 static PyObject *unicodestr;
Tim Peters803526b2002-07-07 05:13:56 +0000443
Georg Brandl3daf7582006-03-13 22:22:11 +0000444 if (v == NULL) {
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000445 res = PyString_FromString("<NULL>");
Neal Norwitz75801462006-03-14 06:02:16 +0000446 if (res == NULL)
447 return NULL;
448 str = PyUnicode_FromEncodedObject(res, NULL, "strict");
449 Py_DECREF(res);
450 return str;
Georg Brandl3daf7582006-03-13 22:22:11 +0000451 } else if (PyUnicode_CheckExact(v)) {
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000452 Py_INCREF(v);
453 return v;
454 }
Brett Cannonc3647ac2005-04-26 03:45:26 +0000455 /* XXX As soon as we have a tp_unicode slot, we should
456 check this before trying the __unicode__
457 method. */
458 if (unicodestr == NULL) {
459 unicodestr= PyString_InternFromString("__unicode__");
460 if (unicodestr == NULL)
461 return NULL;
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000462 }
Brett Cannonc3647ac2005-04-26 03:45:26 +0000463 func = PyObject_GetAttr(v, unicodestr);
464 if (func != NULL) {
465 res = PyEval_CallObject(func, (PyObject *)NULL);
466 Py_DECREF(func);
467 }
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000468 else {
Brett Cannonc3647ac2005-04-26 03:45:26 +0000469 PyErr_Clear();
470 if (PyUnicode_Check(v)) {
471 /* For a Unicode subtype that's didn't overwrite __unicode__,
472 return a true Unicode object with the same data. */
473 return PyUnicode_FromUnicode(PyUnicode_AS_UNICODE(v),
474 PyUnicode_GET_SIZE(v));
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000475 }
Brett Cannonc3647ac2005-04-26 03:45:26 +0000476 if (PyString_CheckExact(v)) {
477 Py_INCREF(v);
478 res = v;
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000479 }
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000480 else {
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000481 if (v->ob_type->tp_str != NULL)
482 res = (*v->ob_type->tp_str)(v);
483 else
484 res = PyObject_Repr(v);
485 }
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000486 }
487 if (res == NULL)
488 return NULL;
489 if (!PyUnicode_Check(res)) {
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000490 str = PyUnicode_FromEncodedObject(res, NULL, "strict");
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000491 Py_DECREF(res);
Neal Norwitz75801462006-03-14 06:02:16 +0000492 res = str;
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000493 }
494 return res;
495}
496
497
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000498/* The new comparison philosophy is: we completely separate three-way
499 comparison from rich comparison. That is, PyObject_Compare() and
500 PyObject_Cmp() *just* use the tp_compare slot. And PyObject_RichCompare()
501 and PyObject_RichCompareBool() *just* use the tp_richcompare slot.
502
503 See (*) below for practical amendments.
504
505 IOW, only cmp() uses tp_compare; the comparison operators (==, !=, <=, <,
506 >=, >) only use tp_richcompare. Note that list.sort() only uses <.
507
508 (And yes, eventually we'll rip out cmp() and tp_compare.)
509
510 The calling conventions are different: tp_compare only gets called with two
511 objects of the appropriate type; tp_richcompare gets called with a first
512 argument of the appropriate type and a second object of an arbitrary type.
513 We never do any kind of coercion.
514
515 The return conventions are also different.
516
517 The tp_compare slot should return a C int, as follows:
518
519 -1 if a < b or if an exception occurred
520 0 if a == b
521 +1 if a > b
522
523 No other return values are allowed. PyObject_Compare() has the same
524 calling convention.
525
526 The tp_richcompare slot should return an object, as follows:
527
528 NULL if an exception occurred
529 NotImplemented if the requested comparison is not implemented
530 any other false value if the requested comparison is false
531 any other true value if the requested comparison is true
532
533 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
534 NotImplemented.
535
536 (*) Practical amendments:
537
538 - If rich comparison returns NotImplemented, == and != are decided by
539 comparing the object pointer (i.e. falling back to the base object
540 implementation).
541
542 - If three-way comparison is not implemented, it falls back on rich
543 comparison (but not the other way around!).
544
Guido van Rossuma4073002002-05-31 20:03:54 +0000545*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000546
547/* Forward */
548static PyObject *do_richcompare(PyObject *v, PyObject *w, int op);
549
550/* Perform a three-way comparison, raising TypeError if three-way comparison
551 is not supported. */
Guido van Rossuma4073002002-05-31 20:03:54 +0000552static int
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000553do_compare(PyObject *v, PyObject *w)
Guido van Rossuma4073002002-05-31 20:03:54 +0000554{
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000555 cmpfunc f;
556 int ok;
557
558 if (v->ob_type == w->ob_type &&
559 (f = v->ob_type->tp_compare) != NULL) {
560 return (*f)(v, w);
Guido van Rossuma4073002002-05-31 20:03:54 +0000561 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000562
563 /* Now try three-way compare before giving up. This is intentionally
564 elaborate; if you have a it will raise TypeError if it detects two
565 objects that aren't ordered with respect to each other. */
566 ok = PyObject_RichCompareBool(v, w, Py_LT);
567 if (ok < 0)
568 return -1; /* Error */
569 if (ok)
570 return -1; /* Less than */
571 ok = PyObject_RichCompareBool(v, w, Py_GT);
572 if (ok < 0)
573 return -1; /* Error */
574 if (ok)
575 return 1; /* Greater than */
576 ok = PyObject_RichCompareBool(v, w, Py_EQ);
577 if (ok < 0)
578 return -1; /* Error */
579 if (ok)
580 return 0; /* Equal */
581
582 /* Give up */
583 PyErr_Format(PyExc_TypeError,
Neal Norwitz3bd844e2006-08-29 04:39:12 +0000584 "unorderable types: '%.100s' != '%.100s'",
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000585 v->ob_type->tp_name,
586 w->ob_type->tp_name);
587 return -1;
Guido van Rossuma4073002002-05-31 20:03:54 +0000588}
589
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000590/* Perform a three-way comparison. This wraps do_compare() with a check for
591 NULL arguments and a recursion check. */
592int
593PyObject_Compare(PyObject *v, PyObject *w)
594{
595 int res;
Guido van Rossuma4073002002-05-31 20:03:54 +0000596
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000597 if (v == NULL || w == NULL) {
598 if (!PyErr_Occurred())
599 PyErr_BadInternalCall();
600 return -1;
601 }
602 if (Py_EnterRecursiveCall(" in cmp"))
603 return -1;
604 res = do_compare(v, w);
605 Py_LeaveRecursiveCall();
606 return res < 0 ? -1 : res;
607}
Guido van Rossumd1f06b92001-01-24 22:14:43 +0000608
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000609/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000610int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000611
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000612static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000613
614/* Perform a rich comparison, raising TypeError when the requested comparison
615 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000616static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000617do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000618{
619 richcmpfunc f;
620 PyObject *res;
621
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000622 if (v->ob_type != w->ob_type &&
623 PyType_IsSubtype(w->ob_type, v->ob_type) &&
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000624 (f = w->ob_type->tp_richcompare) != NULL) {
Tim Petersf4aca752004-09-23 02:39:37 +0000625 res = (*f)(w, v, _Py_SwappedOp[op]);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000626 if (res != Py_NotImplemented)
627 return res;
628 Py_DECREF(res);
629 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000630 if ((f = v->ob_type->tp_richcompare) != NULL) {
Guido van Rossume797ec12001-01-17 15:24:28 +0000631 res = (*f)(v, w, op);
632 if (res != Py_NotImplemented)
633 return res;
634 Py_DECREF(res);
635 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000636 if ((f = w->ob_type->tp_richcompare) != NULL) {
637 res = (*f)(w, v, _Py_SwappedOp[op]);
638 if (res != Py_NotImplemented)
639 return res;
640 Py_DECREF(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000641 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000642 /* If neither object implements it, provide a sensible default
643 for == and !=, but raise an exception for ordering. */
644 switch (op) {
645 case Py_EQ:
646 res = (v == w) ? Py_True : Py_False;
647 break;
648 case Py_NE:
649 res = (v != w) ? Py_True : Py_False;
650 break;
651 default:
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000652 /* XXX Special-case None so it doesn't show as NoneType() */
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000653 PyErr_Format(PyExc_TypeError,
654 "unorderable types: %.100s() %s %.100s()",
655 v->ob_type->tp_name,
656 opstrings[op],
657 w->ob_type->tp_name);
658 return NULL;
659 }
Guido van Rossume797ec12001-01-17 15:24:28 +0000660 Py_INCREF(res);
661 return res;
662}
663
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000664/* Perform a rich comparison with object result. This wraps do_richcompare()
665 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000666
Guido van Rossume797ec12001-01-17 15:24:28 +0000667PyObject *
668PyObject_RichCompare(PyObject *v, PyObject *w, int op)
669{
670 PyObject *res;
671
672 assert(Py_LT <= op && op <= Py_GE);
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000673 if (v == NULL || w == NULL) {
674 if (!PyErr_Occurred())
675 PyErr_BadInternalCall();
676 return NULL;
677 }
Armin Rigo2b3eb402003-10-28 12:05:48 +0000678 if (Py_EnterRecursiveCall(" in cmp"))
679 return NULL;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000680 res = do_richcompare(v, w, op);
Armin Rigo2b3eb402003-10-28 12:05:48 +0000681 Py_LeaveRecursiveCall();
Guido van Rossume797ec12001-01-17 15:24:28 +0000682 return res;
683}
684
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000685/* Perform a rich comparison with integer result. This wraps
686 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000687int
688PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
689{
Raymond Hettinger93d44812004-03-21 17:01:44 +0000690 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000691 int ok;
692
Raymond Hettinger93d44812004-03-21 17:01:44 +0000693 res = PyObject_RichCompare(v, w, op);
Guido van Rossume797ec12001-01-17 15:24:28 +0000694 if (res == NULL)
695 return -1;
Guido van Rossum81912d42002-08-24 05:33:28 +0000696 if (PyBool_Check(res))
697 ok = (res == Py_True);
698 else
699 ok = PyObject_IsTrue(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000700 Py_DECREF(res);
701 return ok;
702}
Fred Drake13634cf2000-06-29 19:17:04 +0000703
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000704/* Turn the result of a three-way comparison into the result expected by a
705 rich comparison. */
706PyObject *
707Py_CmpToRich(int op, int cmp)
708{
709 PyObject *res;
710 int ok;
711
712 if (PyErr_Occurred())
713 return NULL;
714 switch (op) {
715 case Py_LT:
716 ok = cmp < 0;
717 break;
718 case Py_LE:
719 ok = cmp <= 0;
720 break;
721 case Py_EQ:
722 ok = cmp == 0;
723 break;
724 case Py_NE:
725 ok = cmp != 0;
726 break;
727 case Py_GT:
728 ok = cmp > 0;
729 break;
730 case Py_GE:
731 ok = cmp >= 0;
732 break;
733 default:
734 PyErr_BadArgument();
735 return NULL;
736 }
737 res = ok ? Py_True : Py_False;
738 Py_INCREF(res);
739 return res;
740}
741
Fred Drake13634cf2000-06-29 19:17:04 +0000742/* Set of hash utility functions to help maintaining the invariant that
Raymond Hettinger8183fa42004-03-21 17:35:06 +0000743 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000744
745 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
746*/
747
748long
Fred Drake100814d2000-07-09 15:48:49 +0000749_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000750{
Tim Peters39dce292000-08-15 03:34:48 +0000751 double intpart, fractpart;
752 int expo;
753 long hipart;
754 long x; /* the final hash value */
755 /* This is designed so that Python numbers of different types
756 * that compare equal hash to the same value; otherwise comparisons
757 * of mapping keys will turn out weird.
758 */
759
Tim Peters39dce292000-08-15 03:34:48 +0000760 fractpart = modf(v, &intpart);
Tim Peters39dce292000-08-15 03:34:48 +0000761 if (fractpart == 0.0) {
762 /* This must return the same hash as an equal int or long. */
763 if (intpart > LONG_MAX || -intpart > LONG_MAX) {
764 /* Convert to long and use its hash. */
765 PyObject *plong; /* converted to Python long */
766 if (Py_IS_INFINITY(intpart))
767 /* can't convert to long int -- arbitrary */
768 v = v < 0 ? -271828.0 : 314159.0;
769 plong = PyLong_FromDouble(v);
770 if (plong == NULL)
771 return -1;
772 x = PyObject_Hash(plong);
773 Py_DECREF(plong);
774 return x;
775 }
776 /* Fits in a C long == a Python int, so is its own hash. */
777 x = (long)intpart;
778 if (x == -1)
779 x = -2;
780 return x;
781 }
782 /* The fractional part is non-zero, so we don't have to worry about
783 * making this match the hash of some other type.
784 * Use frexp to get at the bits in the double.
Fred Drake13634cf2000-06-29 19:17:04 +0000785 * Since the VAX D double format has 56 mantissa bits, which is the
786 * most of any double format in use, each of these parts may have as
787 * many as (but no more than) 56 significant bits.
Tim Peters39dce292000-08-15 03:34:48 +0000788 * So, assuming sizeof(long) >= 4, each part can be broken into two
789 * longs; frexp and multiplication are used to do that.
790 * Also, since the Cray double format has 15 exponent bits, which is
791 * the most of any double format in use, shifting the exponent field
792 * left by 15 won't overflow a long (again assuming sizeof(long) >= 4).
Fred Drake13634cf2000-06-29 19:17:04 +0000793 */
Tim Peters39dce292000-08-15 03:34:48 +0000794 v = frexp(v, &expo);
795 v *= 2147483648.0; /* 2**31 */
796 hipart = (long)v; /* take the top 32 bits */
797 v = (v - (double)hipart) * 2147483648.0; /* get the next 32 bits */
798 x = hipart + (long)v + (expo << 15);
799 if (x == -1)
800 x = -2;
801 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000802}
803
804long
Fred Drake100814d2000-07-09 15:48:49 +0000805_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000806{
807#if SIZEOF_LONG >= SIZEOF_VOID_P
808 return (long)p;
809#else
810 /* convert to a Python long and hash that */
811 PyObject* longobj;
812 long x;
Tim Peters803526b2002-07-07 05:13:56 +0000813
Fred Drake13634cf2000-06-29 19:17:04 +0000814 if ((longobj = PyLong_FromVoidPtr(p)) == NULL) {
815 x = -1;
816 goto finally;
817 }
818 x = PyObject_Hash(longobj);
Tim Peters803526b2002-07-07 05:13:56 +0000819
Fred Drake13634cf2000-06-29 19:17:04 +0000820finally:
821 Py_XDECREF(longobj);
822 return x;
823#endif
824}
825
826
Guido van Rossum9bfef441993-03-29 10:43:31 +0000827long
Fred Drake100814d2000-07-09 15:48:49 +0000828PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000829{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000830 PyTypeObject *tp = v->ob_type;
Guido van Rossum9bfef441993-03-29 10:43:31 +0000831 if (tp->tp_hash != NULL)
832 return (*tp->tp_hash)(v);
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000833 /* Otherwise, the object can't be hashed */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000834 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
835 v->ob_type->tp_name);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000836 return -1;
837}
838
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000839PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000840PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000841{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000842 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000843
Tim Peters6d6c1a32001-08-02 04:15:00 +0000844 if (v->ob_type->tp_getattr != NULL)
Martin v. Löwis15e62742006-02-27 16:46:16 +0000845 return (*v->ob_type->tp_getattr)(v, (char*)name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000846 w = PyString_InternFromString(name);
847 if (w == NULL)
848 return NULL;
849 res = PyObject_GetAttr(v, w);
850 Py_XDECREF(w);
851 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000852}
853
854int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000855PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000856{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000857 PyObject *res = PyObject_GetAttrString(v, name);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000858 if (res != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000859 Py_DECREF(res);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000860 return 1;
861 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000862 PyErr_Clear();
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000863 return 0;
864}
865
866int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000867PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000868{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000869 PyObject *s;
870 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000871
Tim Peters6d6c1a32001-08-02 04:15:00 +0000872 if (v->ob_type->tp_setattr != NULL)
Martin v. Löwis15e62742006-02-27 16:46:16 +0000873 return (*v->ob_type->tp_setattr)(v, (char*)name, w);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000874 s = PyString_InternFromString(name);
875 if (s == NULL)
876 return -1;
877 res = PyObject_SetAttr(v, s, w);
878 Py_XDECREF(s);
879 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000880}
881
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000882PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000883PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000884{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000885 PyTypeObject *tp = v->ob_type;
886
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000887 if (!PyString_Check(name)) {
Martin v. Löwis0c160a02002-03-15 13:40:30 +0000888 /* The Unicode to string conversion is done here because the
889 existing tp_getattro slots expect a string object as name
890 and we wouldn't want to break those. */
891 if (PyUnicode_Check(name)) {
892 name = _PyUnicode_AsDefaultEncodedString(name, NULL);
893 if (name == NULL)
894 return NULL;
895 }
896 else
Martin v. Löwis0c160a02002-03-15 13:40:30 +0000897 {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000898 PyErr_Format(PyExc_TypeError,
899 "attribute name must be string, not '%.200s'",
900 name->ob_type->tp_name);
Martin v. Löwis0c160a02002-03-15 13:40:30 +0000901 return NULL;
902 }
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000903 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000904 if (tp->tp_getattro != NULL)
905 return (*tp->tp_getattro)(v, name);
906 if (tp->tp_getattr != NULL)
907 return (*tp->tp_getattr)(v, PyString_AS_STRING(name));
908 PyErr_Format(PyExc_AttributeError,
909 "'%.50s' object has no attribute '%.400s'",
910 tp->tp_name, PyString_AS_STRING(name));
911 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000912}
913
914int
Fred Drake100814d2000-07-09 15:48:49 +0000915PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000916{
917 PyObject *res = PyObject_GetAttr(v, name);
918 if (res != NULL) {
919 Py_DECREF(res);
920 return 1;
921 }
922 PyErr_Clear();
923 return 0;
924}
925
926int
Fred Drake100814d2000-07-09 15:48:49 +0000927PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000928{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000929 PyTypeObject *tp = v->ob_type;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000930 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000931
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000932 if (!PyString_Check(name)){
Martin v. Löwis0c160a02002-03-15 13:40:30 +0000933 /* The Unicode to string conversion is done here because the
934 existing tp_setattro slots expect a string object as name
935 and we wouldn't want to break those. */
936 if (PyUnicode_Check(name)) {
937 name = PyUnicode_AsEncodedString(name, NULL, NULL);
938 if (name == NULL)
939 return -1;
940 }
Tim Peters803526b2002-07-07 05:13:56 +0000941 else
Martin v. Löwis0c160a02002-03-15 13:40:30 +0000942 {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000943 PyErr_Format(PyExc_TypeError,
944 "attribute name must be string, not '%.200s'",
945 name->ob_type->tp_name);
Martin v. Löwis0c160a02002-03-15 13:40:30 +0000946 return -1;
947 }
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000948 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000949 else
950 Py_INCREF(name);
951
952 PyString_InternInPlace(&name);
953 if (tp->tp_setattro != NULL) {
954 err = (*tp->tp_setattro)(v, name, value);
955 Py_DECREF(name);
956 return err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000957 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000958 if (tp->tp_setattr != NULL) {
959 err = (*tp->tp_setattr)(v, PyString_AS_STRING(name), value);
960 Py_DECREF(name);
961 return err;
962 }
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000963 Py_DECREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000964 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
965 PyErr_Format(PyExc_TypeError,
966 "'%.100s' object has no attributes "
967 "(%s .%.100s)",
968 tp->tp_name,
969 value==NULL ? "del" : "assign to",
970 PyString_AS_STRING(name));
971 else
972 PyErr_Format(PyExc_TypeError,
973 "'%.100s' object has only read-only attributes "
974 "(%s .%.100s)",
975 tp->tp_name,
976 value==NULL ? "del" : "assign to",
977 PyString_AS_STRING(name));
978 return -1;
979}
980
981/* Helper to get a pointer to an object's __dict__ slot, if any */
982
983PyObject **
984_PyObject_GetDictPtr(PyObject *obj)
985{
Martin v. Löwis725507b2006-03-07 12:08:51 +0000986 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000987 PyTypeObject *tp = obj->ob_type;
988
Tim Peters6d6c1a32001-08-02 04:15:00 +0000989 dictoffset = tp->tp_dictoffset;
990 if (dictoffset == 0)
991 return NULL;
992 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000993 Py_ssize_t tsize;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000994 size_t size;
995
996 tsize = ((PyVarObject *)obj)->ob_size;
997 if (tsize < 0)
998 tsize = -tsize;
999 size = _PyObject_VAR_SIZE(tp, tsize);
1000
Tim Peters6d483d32001-10-06 21:27:34 +00001001 dictoffset += (long)size;
1002 assert(dictoffset > 0);
1003 assert(dictoffset % SIZEOF_VOID_P == 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001004 }
1005 return (PyObject **) ((char *)obj + dictoffset);
1006}
1007
Tim Peters6d6c1a32001-08-02 04:15:00 +00001008PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +00001009PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +00001010{
1011 Py_INCREF(obj);
1012 return obj;
1013}
1014
Michael W. Hudson1593f502004-09-14 17:09:47 +00001015/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
1016
Raymond Hettinger01538262003-03-17 08:24:35 +00001017PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001018PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
1019{
1020 PyTypeObject *tp = obj->ob_type;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001021 PyObject *descr = NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001022 PyObject *res = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001023 descrgetfunc f;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001024 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001025 PyObject **dictptr;
1026
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001027 if (!PyString_Check(name)){
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001028 /* The Unicode to string conversion is done here because the
1029 existing tp_setattro slots expect a string object as name
1030 and we wouldn't want to break those. */
1031 if (PyUnicode_Check(name)) {
1032 name = PyUnicode_AsEncodedString(name, NULL, NULL);
1033 if (name == NULL)
1034 return NULL;
1035 }
Tim Peters803526b2002-07-07 05:13:56 +00001036 else
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001037 {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001038 PyErr_Format(PyExc_TypeError,
1039 "attribute name must be string, not '%.200s'",
1040 name->ob_type->tp_name);
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001041 return NULL;
1042 }
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001043 }
1044 else
1045 Py_INCREF(name);
1046
Tim Peters6d6c1a32001-08-02 04:15:00 +00001047 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001048 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001049 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001050 }
1051
Guido van Rossum056fbf42002-08-19 19:22:50 +00001052 /* Inline _PyType_Lookup */
1053 {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001054 Py_ssize_t i, n;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001055 PyObject *mro, *base, *dict;
1056
1057 /* Look in tp_dict of types in MRO */
1058 mro = tp->tp_mro;
1059 assert(mro != NULL);
1060 assert(PyTuple_Check(mro));
1061 n = PyTuple_GET_SIZE(mro);
1062 for (i = 0; i < n; i++) {
1063 base = PyTuple_GET_ITEM(mro, i);
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001064 assert(PyType_Check(base));
1065 dict = ((PyTypeObject *)base)->tp_dict;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001066 assert(dict && PyDict_Check(dict));
1067 descr = PyDict_GetItem(dict, name);
1068 if (descr != NULL)
1069 break;
1070 }
1071 }
1072
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001073 Py_XINCREF(descr);
1074
Tim Peters6d6c1a32001-08-02 04:15:00 +00001075 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001076 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001077 f = descr->ob_type->tp_descr_get;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001078 if (f != NULL && PyDescr_IsData(descr)) {
1079 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001080 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001081 goto done;
1082 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001083 }
1084
Guido van Rossumc66ff442002-08-19 16:50:48 +00001085 /* Inline _PyObject_GetDictPtr */
1086 dictoffset = tp->tp_dictoffset;
1087 if (dictoffset != 0) {
1088 PyObject *dict;
1089 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001090 Py_ssize_t tsize;
Guido van Rossumc66ff442002-08-19 16:50:48 +00001091 size_t size;
1092
1093 tsize = ((PyVarObject *)obj)->ob_size;
1094 if (tsize < 0)
1095 tsize = -tsize;
1096 size = _PyObject_VAR_SIZE(tp, tsize);
1097
1098 dictoffset += (long)size;
1099 assert(dictoffset > 0);
1100 assert(dictoffset % SIZEOF_VOID_P == 0);
1101 }
1102 dictptr = (PyObject **) ((char *)obj + dictoffset);
1103 dict = *dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001104 if (dict != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001105 res = PyDict_GetItem(dict, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001106 if (res != NULL) {
1107 Py_INCREF(res);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001108 Py_XDECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001109 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001110 }
1111 }
1112 }
1113
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001114 if (f != NULL) {
1115 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001116 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001117 goto done;
1118 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001119
1120 if (descr != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001121 res = descr;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001122 /* descr was already increfed above */
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001123 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001124 }
1125
1126 PyErr_Format(PyExc_AttributeError,
1127 "'%.50s' object has no attribute '%.400s'",
1128 tp->tp_name, PyString_AS_STRING(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001129 done:
1130 Py_DECREF(name);
1131 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001132}
1133
1134int
1135PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1136{
1137 PyTypeObject *tp = obj->ob_type;
1138 PyObject *descr;
1139 descrsetfunc f;
1140 PyObject **dictptr;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001141 int res = -1;
1142
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001143 if (!PyString_Check(name)){
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001144 /* The Unicode to string conversion is done here because the
1145 existing tp_setattro slots expect a string object as name
1146 and we wouldn't want to break those. */
1147 if (PyUnicode_Check(name)) {
1148 name = PyUnicode_AsEncodedString(name, NULL, NULL);
1149 if (name == NULL)
1150 return -1;
1151 }
Tim Peters803526b2002-07-07 05:13:56 +00001152 else
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001153 {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001154 PyErr_Format(PyExc_TypeError,
1155 "attribute name must be string, not '%.200s'",
1156 name->ob_type->tp_name);
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001157 return -1;
1158 }
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001159 }
1160 else
1161 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001162
1163 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001164 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001165 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001166 }
1167
1168 descr = _PyType_Lookup(tp, name);
1169 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001170 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001171 f = descr->ob_type->tp_descr_set;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001172 if (f != NULL && PyDescr_IsData(descr)) {
1173 res = f(descr, obj, value);
1174 goto done;
1175 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001176 }
1177
1178 dictptr = _PyObject_GetDictPtr(obj);
1179 if (dictptr != NULL) {
1180 PyObject *dict = *dictptr;
1181 if (dict == NULL && value != NULL) {
1182 dict = PyDict_New();
1183 if (dict == NULL)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001184 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001185 *dictptr = dict;
1186 }
1187 if (dict != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001188 if (value == NULL)
1189 res = PyDict_DelItem(dict, name);
1190 else
1191 res = PyDict_SetItem(dict, name, value);
1192 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1193 PyErr_SetObject(PyExc_AttributeError, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001194 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001195 }
1196 }
1197
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001198 if (f != NULL) {
1199 res = f(descr, obj, value);
1200 goto done;
1201 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001202
1203 if (descr == NULL) {
1204 PyErr_Format(PyExc_AttributeError,
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001205 "'%.100s' object has no attribute '%.200s'",
Tim Peters6d6c1a32001-08-02 04:15:00 +00001206 tp->tp_name, PyString_AS_STRING(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001207 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001208 }
1209
1210 PyErr_Format(PyExc_AttributeError,
1211 "'%.50s' object attribute '%.400s' is read-only",
1212 tp->tp_name, PyString_AS_STRING(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001213 done:
1214 Py_DECREF(name);
1215 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001216}
1217
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001218/* Test a value used as condition, e.g., in a for or if statement.
1219 Return -1 if an error occurred */
1220
1221int
Fred Drake100814d2000-07-09 15:48:49 +00001222PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001223{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001224 Py_ssize_t res;
Guido van Rossum6248f442002-08-24 06:31:34 +00001225 if (v == Py_True)
1226 return 1;
1227 if (v == Py_False)
1228 return 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001229 if (v == Py_None)
Neal Norwitz51290d32002-06-13 21:32:44 +00001230 return 0;
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001231 else if (v->ob_type->tp_as_number != NULL &&
Jack Diederich4dafcc42006-11-28 19:15:13 +00001232 v->ob_type->tp_as_number->nb_bool != NULL)
1233 res = (*v->ob_type->tp_as_number->nb_bool)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001234 else if (v->ob_type->tp_as_mapping != NULL &&
1235 v->ob_type->tp_as_mapping->mp_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001236 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001237 else if (v->ob_type->tp_as_sequence != NULL &&
1238 v->ob_type->tp_as_sequence->sq_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001239 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1240 else
Neal Norwitz51290d32002-06-13 21:32:44 +00001241 return 1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001242 /* if it is negative, it should be either -1 or -2 */
1243 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001244}
1245
Tim Peters803526b2002-07-07 05:13:56 +00001246/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001247 Return -1 if an error occurred */
1248
1249int
Fred Drake100814d2000-07-09 15:48:49 +00001250PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001251{
1252 int res;
1253 res = PyObject_IsTrue(v);
1254 if (res < 0)
1255 return res;
1256 return res == 0;
1257}
1258
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001259/* Test whether an object can be called */
1260
1261int
Fred Drake100814d2000-07-09 15:48:49 +00001262PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001263{
1264 if (x == NULL)
1265 return 0;
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001266 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001267}
1268
Georg Brandle32b4222007-03-10 22:13:27 +00001269/* ------------------------- PyObject_Dir() helpers ------------------------- */
1270
Tim Peters7eea37e2001-09-04 22:08:56 +00001271/* Helper for PyObject_Dir.
1272 Merge the __dict__ of aclass into dict, and recursively also all
1273 the __dict__s of aclass's base classes. The order of merging isn't
1274 defined, as it's expected that only the final set of dict keys is
1275 interesting.
1276 Return 0 on success, -1 on error.
1277*/
1278
1279static int
1280merge_class_dict(PyObject* dict, PyObject* aclass)
1281{
1282 PyObject *classdict;
1283 PyObject *bases;
1284
1285 assert(PyDict_Check(dict));
1286 assert(aclass);
1287
1288 /* Merge in the type's dict (if any). */
1289 classdict = PyObject_GetAttrString(aclass, "__dict__");
1290 if (classdict == NULL)
1291 PyErr_Clear();
1292 else {
1293 int status = PyDict_Update(dict, classdict);
1294 Py_DECREF(classdict);
1295 if (status < 0)
1296 return -1;
1297 }
1298
1299 /* Recursively merge in the base types' (if any) dicts. */
1300 bases = PyObject_GetAttrString(aclass, "__bases__");
Tim Petersbc7e8632001-09-16 20:33:22 +00001301 if (bases == NULL)
1302 PyErr_Clear();
1303 else {
Guido van Rossum44022412002-05-13 18:29:46 +00001304 /* We have no guarantee that bases is a real tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001305 Py_ssize_t i, n;
Guido van Rossum44022412002-05-13 18:29:46 +00001306 n = PySequence_Size(bases); /* This better be right */
1307 if (n < 0)
1308 PyErr_Clear();
1309 else {
1310 for (i = 0; i < n; i++) {
Tim Peters18e70832003-02-05 19:35:19 +00001311 int status;
Guido van Rossum44022412002-05-13 18:29:46 +00001312 PyObject *base = PySequence_GetItem(bases, i);
1313 if (base == NULL) {
1314 Py_DECREF(bases);
1315 return -1;
1316 }
Tim Peters18e70832003-02-05 19:35:19 +00001317 status = merge_class_dict(dict, base);
1318 Py_DECREF(base);
1319 if (status < 0) {
Guido van Rossum44022412002-05-13 18:29:46 +00001320 Py_DECREF(bases);
1321 return -1;
1322 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001323 }
1324 }
1325 Py_DECREF(bases);
1326 }
1327 return 0;
1328}
1329
Georg Brandle32b4222007-03-10 22:13:27 +00001330/* Helper for PyObject_Dir without arguments: returns the local scope. */
1331static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001332_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001333{
Georg Brandled3b8382007-03-12 13:15:14 +00001334 PyObject *names;
Georg Brandle32b4222007-03-10 22:13:27 +00001335 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001336
Georg Brandle32b4222007-03-10 22:13:27 +00001337 if (locals == NULL) {
1338 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1339 return NULL;
Tim Peters305b5852001-09-17 02:38:46 +00001340 }
1341
Georg Brandled3b8382007-03-12 13:15:14 +00001342 names = PyMapping_Keys(locals);
1343 if (!names)
1344 return NULL;
1345 if (!PyList_Check(names)) {
1346 PyErr_Format(PyExc_TypeError,
1347 "dir(): expected keys() of locals to be a list, "
1348 "not '%.200s'", names->ob_type->tp_name);
1349 Py_DECREF(names);
1350 return NULL;
1351 }
Georg Brandle32b4222007-03-10 22:13:27 +00001352 /* the locals don't need to be DECREF'd */
Georg Brandled3b8382007-03-12 13:15:14 +00001353 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001354}
1355
1356/* Helper for PyObject_Dir of type objects: returns __dict__ and __bases__.
1357 We deliberately don't suck up its __class__, as methods belonging to the
1358 metaclass would probably be more confusing than helpful.
1359*/
1360static PyObject *
1361_specialized_dir_type(PyObject *obj)
1362{
1363 PyObject *result = NULL;
1364 PyObject *dict = PyDict_New();
1365
1366 if (dict != NULL && merge_class_dict(dict, obj) == 0)
1367 result = PyDict_Keys(dict);
1368
1369 Py_XDECREF(dict);
Tim Peters305b5852001-09-17 02:38:46 +00001370 return result;
1371}
1372
Georg Brandle32b4222007-03-10 22:13:27 +00001373/* Helper for PyObject_Dir of module objects: returns the module's __dict__. */
1374static PyObject *
1375_specialized_dir_module(PyObject *obj)
Tim Peters7eea37e2001-09-04 22:08:56 +00001376{
Georg Brandle32b4222007-03-10 22:13:27 +00001377 PyObject *result = NULL;
1378 PyObject *dict = PyObject_GetAttrString(obj, "__dict__");
Tim Peters7eea37e2001-09-04 22:08:56 +00001379
Georg Brandle32b4222007-03-10 22:13:27 +00001380 if (dict != NULL) {
1381 if (PyDict_Check(dict))
1382 result = PyDict_Keys(dict);
1383 else {
1384 PyErr_Format(PyExc_TypeError,
1385 "%.200s.__dict__ is not a dictionary",
1386 PyModule_GetName(obj));
Guido van Rossum8dbd3d82001-09-10 18:27:43 +00001387 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001388 }
1389
Georg Brandle32b4222007-03-10 22:13:27 +00001390 Py_XDECREF(dict);
1391 return result;
1392}
Tim Peters7eea37e2001-09-04 22:08:56 +00001393
Georg Brandle32b4222007-03-10 22:13:27 +00001394/* Helper for PyObject_Dir of generic objects: returns __dict__, __class__,
1395 and recursively up the __class__.__bases__ chain.
1396*/
1397static PyObject *
1398_generic_dir(PyObject *obj)
1399{
1400 PyObject *result = NULL;
1401 PyObject *dict = NULL;
1402 PyObject *itsclass = NULL;
1403
1404 /* Get __dict__ (which may or may not be a real dict...) */
1405 dict = PyObject_GetAttrString(obj, "__dict__");
1406 if (dict == NULL) {
1407 PyErr_Clear();
1408 dict = PyDict_New();
1409 }
1410 else if (!PyDict_Check(dict)) {
1411 Py_DECREF(dict);
1412 dict = PyDict_New();
1413 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001414 else {
Georg Brandle32b4222007-03-10 22:13:27 +00001415 /* Copy __dict__ to avoid mutating it. */
1416 PyObject *temp = PyDict_Copy(dict);
1417 Py_DECREF(dict);
1418 dict = temp;
Tim Peters7eea37e2001-09-04 22:08:56 +00001419 }
1420
Georg Brandle32b4222007-03-10 22:13:27 +00001421 if (dict == NULL)
Raymond Hettinger2a7dede2004-08-07 04:55:30 +00001422 goto error;
Tim Peters7eea37e2001-09-04 22:08:56 +00001423
Georg Brandle32b4222007-03-10 22:13:27 +00001424 /* Merge in attrs reachable from its class. */
1425 itsclass = PyObject_GetAttrString(obj, "__class__");
1426 if (itsclass == NULL)
1427 /* XXX(tomer): Perhaps fall back to obj->ob_type if no
1428 __class__ exists? */
1429 PyErr_Clear();
1430 else {
1431 if (merge_class_dict(dict, itsclass) != 0)
1432 goto error;
1433 }
1434
1435 result = PyDict_Keys(dict);
Tim Peters7eea37e2001-09-04 22:08:56 +00001436 /* fall through */
Georg Brandle32b4222007-03-10 22:13:27 +00001437error:
1438 Py_XDECREF(itsclass);
1439 Py_XDECREF(dict);
1440 return result;
1441}
1442
1443/* Helper for PyObject_Dir: object introspection.
1444 This calls one of the above specialized versions if no __dir__ method
1445 exists. */
1446static PyObject *
1447_dir_object(PyObject *obj)
1448{
1449 PyObject * result = NULL;
1450 PyObject * dirfunc = PyObject_GetAttrString((PyObject*)obj->ob_type,
1451 "__dir__");
1452
1453 assert(obj);
1454 if (dirfunc == NULL) {
1455 /* use default implementation */
1456 PyErr_Clear();
1457 if (PyModule_Check(obj))
1458 result = _specialized_dir_module(obj);
1459 else if (PyType_Check(obj))
1460 result = _specialized_dir_type(obj);
1461 else
1462 result = _generic_dir(obj);
1463 }
1464 else {
1465 /* use __dir__ */
1466 result = PyObject_CallFunctionObjArgs(dirfunc, obj, NULL);
1467 Py_DECREF(dirfunc);
1468 if (result == NULL)
1469 return NULL;
1470
1471 /* result must be a list */
1472 /* XXX(gbrandl): could also check if all items are strings */
1473 if (!PyList_Check(result)) {
1474 PyErr_Format(PyExc_TypeError,
1475 "__dir__() must return a list, not %.200s",
1476 result->ob_type->tp_name);
1477 Py_DECREF(result);
1478 result = NULL;
1479 }
1480 }
1481
1482 return result;
1483}
1484
1485/* Implementation of dir() -- if obj is NULL, returns the names in the current
1486 (local) scope. Otherwise, performs introspection of the object: returns a
1487 sorted list of attribute names (supposedly) accessible from the object
1488*/
1489PyObject *
1490PyObject_Dir(PyObject *obj)
1491{
1492 PyObject * result;
1493
1494 if (obj == NULL)
1495 /* no object -- introspect the locals */
1496 result = _dir_locals();
1497 else
1498 /* object -- introspect the object */
1499 result = _dir_object(obj);
1500
1501 assert(result == NULL || PyList_Check(result));
1502
1503 if (result != NULL && PyList_Sort(result) != 0) {
1504 /* sorting the list failed */
1505 Py_DECREF(result);
1506 result = NULL;
1507 }
1508
Tim Peters7eea37e2001-09-04 22:08:56 +00001509 return result;
1510}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001511
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001512/*
1513NoObject is usable as a non-NULL undefined value, used by the macro None.
1514There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001515so there is exactly one (which is indestructible, by the way).
Guido van Rossumba21a492001-08-16 08:17:26 +00001516(XXX This type and the type of NotImplemented below should be unified.)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001517*/
1518
Guido van Rossum0c182a11992-03-27 17:26:13 +00001519/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001520static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001521none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001522{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001523 return PyString_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001524}
1525
Barry Warsaw9bf16442001-01-23 16:24:35 +00001526/* ARGUSED */
1527static void
Tim Peters803526b2002-07-07 05:13:56 +00001528none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001529{
1530 /* This should never get called, but we also don't want to SEGV if
1531 * we accidently decref None out of existance.
1532 */
Martin v. Löwis3f19b102002-08-07 16:21:51 +00001533 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001534}
1535
1536
Guido van Rossumba21a492001-08-16 08:17:26 +00001537static PyTypeObject PyNone_Type = {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001538 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001539 0,
Guido van Rossumba21a492001-08-16 08:17:26 +00001540 "NoneType",
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001541 0,
1542 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001543 none_dealloc, /*tp_dealloc*/ /*never called*/
Guido van Rossum7066dd71992-09-17 17:54:56 +00001544 0, /*tp_print*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001545 0, /*tp_getattr*/
1546 0, /*tp_setattr*/
1547 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001548 none_repr, /*tp_repr*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001549 0, /*tp_as_number*/
1550 0, /*tp_as_sequence*/
1551 0, /*tp_as_mapping*/
Guido van Rossum9bfef441993-03-29 10:43:31 +00001552 0, /*tp_hash */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001553};
1554
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001555PyObject _Py_NoneStruct = {
Guido van Rossumba21a492001-08-16 08:17:26 +00001556 PyObject_HEAD_INIT(&PyNone_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001557};
1558
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001559/* NotImplemented is an object that can be used to signal that an
1560 operation is not implemented for the given type combination. */
1561
1562static PyObject *
1563NotImplemented_repr(PyObject *op)
1564{
1565 return PyString_FromString("NotImplemented");
1566}
1567
1568static PyTypeObject PyNotImplemented_Type = {
1569 PyObject_HEAD_INIT(&PyType_Type)
1570 0,
Guido van Rossumba21a492001-08-16 08:17:26 +00001571 "NotImplementedType",
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001572 0,
1573 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001574 none_dealloc, /*tp_dealloc*/ /*never called*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001575 0, /*tp_print*/
1576 0, /*tp_getattr*/
1577 0, /*tp_setattr*/
1578 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001579 NotImplemented_repr, /*tp_repr*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001580 0, /*tp_as_number*/
1581 0, /*tp_as_sequence*/
1582 0, /*tp_as_mapping*/
1583 0, /*tp_hash */
1584};
1585
1586PyObject _Py_NotImplementedStruct = {
1587 PyObject_HEAD_INIT(&PyNotImplemented_Type)
1588};
1589
Guido van Rossumba21a492001-08-16 08:17:26 +00001590void
1591_Py_ReadyTypes(void)
1592{
1593 if (PyType_Ready(&PyType_Type) < 0)
1594 Py_FatalError("Can't initialize 'type'");
1595
Fred Drake0a4dd392004-07-02 18:57:45 +00001596 if (PyType_Ready(&_PyWeakref_RefType) < 0)
1597 Py_FatalError("Can't initialize 'weakref'");
1598
Guido van Rossum77f6a652002-04-03 22:41:51 +00001599 if (PyType_Ready(&PyBool_Type) < 0)
1600 Py_FatalError("Can't initialize 'bool'");
1601
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001602 if (PyType_Ready(&PyBytes_Type) < 0)
1603 Py_FatalError("Can't initialize 'bytes'");
1604
Guido van Rossumcacfc072002-05-24 19:01:59 +00001605 if (PyType_Ready(&PyString_Type) < 0)
1606 Py_FatalError("Can't initialize 'str'");
1607
Guido van Rossumba21a492001-08-16 08:17:26 +00001608 if (PyType_Ready(&PyList_Type) < 0)
1609 Py_FatalError("Can't initialize 'list'");
1610
1611 if (PyType_Ready(&PyNone_Type) < 0)
1612 Py_FatalError("Can't initialize type(None)");
1613
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001614 if (PyType_Ready(Py_Ellipsis->ob_type) < 0)
1615 Py_FatalError("Can't initialize type(Ellipsis)");
1616
Guido van Rossumba21a492001-08-16 08:17:26 +00001617 if (PyType_Ready(&PyNotImplemented_Type) < 0)
1618 Py_FatalError("Can't initialize type(NotImplemented)");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001619
1620 if (PyType_Ready(&PyCode_Type) < 0)
1621 Py_FatalError("Can't initialize 'code'");
Guido van Rossumba21a492001-08-16 08:17:26 +00001622}
1623
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001624
Guido van Rossum84a90321996-05-22 16:34:47 +00001625#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001626
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001627void
Fred Drake100814d2000-07-09 15:48:49 +00001628_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001629{
Tim Peters34592512002-07-11 06:23:50 +00001630 _Py_INC_REFTOTAL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001631 op->ob_refcnt = 1;
Tim Peters7571a0f2003-03-23 17:52:28 +00001632 _Py_AddToAllObjects(op, 1);
Tim Peters34592512002-07-11 06:23:50 +00001633 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001634}
1635
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001636void
Fred Drake100814d2000-07-09 15:48:49 +00001637_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001638{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001639#ifdef SLOW_UNREF_CHECK
Guido van Rossum4c08d552000-03-10 22:55:18 +00001640 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001641#endif
Guido van Rossumd7047b31995-01-02 19:07:15 +00001642 if (op->ob_refcnt < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001643 Py_FatalError("UNREF negative refcnt");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001644 if (op == &refchain ||
Guido van Rossumd7047b31995-01-02 19:07:15 +00001645 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001646 Py_FatalError("UNREF invalid object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001647#ifdef SLOW_UNREF_CHECK
Guido van Rossum3f5da241990-12-20 15:06:42 +00001648 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1649 if (p == op)
1650 break;
1651 }
Guido van Rossumd7047b31995-01-02 19:07:15 +00001652 if (p == &refchain) /* Not found */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001653 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001654#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001655 op->_ob_next->_ob_prev = op->_ob_prev;
1656 op->_ob_prev->_ob_next = op->_ob_next;
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001657 op->_ob_next = op->_ob_prev = NULL;
Tim Peters34592512002-07-11 06:23:50 +00001658 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001659}
1660
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001661void
Fred Drake100814d2000-07-09 15:48:49 +00001662_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001663{
Guido van Rossum9776adf1994-09-07 14:36:45 +00001664 destructor dealloc = op->ob_type->tp_dealloc;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001665 _Py_ForgetReference(op);
Guido van Rossum9776adf1994-09-07 14:36:45 +00001666 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001667}
1668
Tim Peters269b2a62003-04-17 19:52:29 +00001669/* Print all live objects. Because PyObject_Print is called, the
1670 * interpreter must be in a healthy state.
1671 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001672void
Fred Drake100814d2000-07-09 15:48:49 +00001673_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001674{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001675 PyObject *op;
Guido van Rossume09fb551997-08-05 02:04:34 +00001676 fprintf(fp, "Remaining objects:\n");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001677 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001678 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001679 if (PyObject_Print(op, fp, 0) != 0)
1680 PyErr_Clear();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001681 putc('\n', fp);
1682 }
1683}
1684
Tim Peters269b2a62003-04-17 19:52:29 +00001685/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1686 * doesn't make any calls to the Python C API, so is always safe to call.
1687 */
1688void
1689_Py_PrintReferenceAddresses(FILE *fp)
1690{
1691 PyObject *op;
1692 fprintf(fp, "Remaining object addresses:\n");
1693 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001694 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
1695 op->ob_refcnt, op->ob_type->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001696}
1697
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001698PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001699_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001700{
1701 int i, n;
1702 PyObject *t = NULL;
1703 PyObject *res, *op;
1704
1705 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1706 return NULL;
1707 op = refchain._ob_next;
1708 res = PyList_New(0);
1709 if (res == NULL)
1710 return NULL;
1711 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1712 while (op == self || op == args || op == res || op == t ||
Guido van Rossum3c296022001-07-14 17:58:00 +00001713 (t != NULL && op->ob_type != (PyTypeObject *) t)) {
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001714 op = op->_ob_next;
1715 if (op == &refchain)
1716 return res;
1717 }
1718 if (PyList_Append(res, op) < 0) {
1719 Py_DECREF(res);
1720 return NULL;
1721 }
1722 op = op->_ob_next;
1723 }
1724 return res;
1725}
1726
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001727#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001728
1729
1730/* Hack to force loading of cobject.o */
Guido van Rossumda9c2711996-12-05 21:58:58 +00001731PyTypeObject *_Py_cobject_hack = &PyCObject_Type;
Guido van Rossum84a90321996-05-22 16:34:47 +00001732
1733
1734/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001735Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001736
1737
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001738/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001739
Thomas Wouters334fb892000-07-25 12:56:38 +00001740void *
Fred Drake100814d2000-07-09 15:48:49 +00001741PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001742{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001743 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001744}
1745
Thomas Wouters334fb892000-07-25 12:56:38 +00001746void *
1747PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001748{
Tim Petersaf3e8de2002-04-12 07:22:56 +00001749 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001750}
1751
1752void
Thomas Wouters334fb892000-07-25 12:56:38 +00001753PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001754{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001755 PyMem_FREE(p);
1756}
1757
1758
Guido van Rossum86610361998-04-10 22:32:46 +00001759/* These methods are used to control infinite recursion in repr, str, print,
1760 etc. Container objects that may recursively contain themselves,
1761 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1762 Py_ReprLeave() to avoid infinite recursion.
1763
1764 Py_ReprEnter() returns 0 the first time it is called for a particular
1765 object and 1 every time thereafter. It returns -1 if an exception
1766 occurred. Py_ReprLeave() has no return value.
1767
1768 See dictobject.c and listobject.c for examples of use.
1769*/
1770
1771#define KEY "Py_Repr"
1772
1773int
Fred Drake100814d2000-07-09 15:48:49 +00001774Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001775{
1776 PyObject *dict;
1777 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001778 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001779
1780 dict = PyThreadState_GetDict();
1781 if (dict == NULL)
Guido van Rossum0fc8f002003-04-15 15:12:39 +00001782 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001783 list = PyDict_GetItemString(dict, KEY);
1784 if (list == NULL) {
1785 list = PyList_New(0);
1786 if (list == NULL)
1787 return -1;
1788 if (PyDict_SetItemString(dict, KEY, list) < 0)
1789 return -1;
1790 Py_DECREF(list);
1791 }
1792 i = PyList_GET_SIZE(list);
1793 while (--i >= 0) {
1794 if (PyList_GET_ITEM(list, i) == obj)
1795 return 1;
1796 }
1797 PyList_Append(list, obj);
1798 return 0;
1799}
1800
1801void
Fred Drake100814d2000-07-09 15:48:49 +00001802Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001803{
1804 PyObject *dict;
1805 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001806 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001807
1808 dict = PyThreadState_GetDict();
Guido van Rossumeb909461998-04-11 15:17:34 +00001809 if (dict == NULL)
1810 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001811 list = PyDict_GetItemString(dict, KEY);
Guido van Rossumeb909461998-04-11 15:17:34 +00001812 if (list == NULL || !PyList_Check(list))
1813 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001814 i = PyList_GET_SIZE(list);
1815 /* Count backwards because we always expect obj to be list[-1] */
1816 while (--i >= 0) {
1817 if (PyList_GET_ITEM(list, i) == obj) {
1818 PyList_SetSlice(list, i, i + 1, NULL);
1819 break;
1820 }
1821 }
1822}
Guido van Rossumd724b232000-03-13 16:01:29 +00001823
Tim Peters803526b2002-07-07 05:13:56 +00001824/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001825
Tim Peters803526b2002-07-07 05:13:56 +00001826/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001827int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001828
Tim Peters803526b2002-07-07 05:13:56 +00001829/* List of objects that still need to be cleaned up, singly linked via their
1830 * gc headers' gc_prev pointers.
1831 */
1832PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001833
Tim Peters803526b2002-07-07 05:13:56 +00001834/* Add op to the _PyTrash_delete_later list. Called when the current
1835 * call-stack depth gets large. op must be a currently untracked gc'ed
1836 * object, with refcount 0. Py_DECREF must already have been called on it.
1837 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001838void
Fred Drake100814d2000-07-09 15:48:49 +00001839_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001840{
Tim Peters803526b2002-07-07 05:13:56 +00001841 assert(PyObject_IS_GC(op));
1842 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1843 assert(op->ob_refcnt == 0);
Neil Schemenauerf589c052002-03-29 03:05:54 +00001844 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
Guido van Rossume92e6102000-04-24 15:40:53 +00001845 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001846}
1847
Tim Peters803526b2002-07-07 05:13:56 +00001848/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1849 * the call-stack unwinds again.
1850 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001851void
Fred Drake100814d2000-07-09 15:48:49 +00001852_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001853{
1854 while (_PyTrash_delete_later) {
Tim Peters803526b2002-07-07 05:13:56 +00001855 PyObject *op = _PyTrash_delete_later;
1856 destructor dealloc = op->ob_type->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001857
Neil Schemenauerf589c052002-03-29 03:05:54 +00001858 _PyTrash_delete_later =
Tim Peters803526b2002-07-07 05:13:56 +00001859 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001860
Tim Peters803526b2002-07-07 05:13:56 +00001861 /* Call the deallocator directly. This used to try to
1862 * fool Py_DECREF into calling it indirectly, but
1863 * Py_DECREF was already called on this object, and in
1864 * assorted non-release builds calling Py_DECREF again ends
1865 * up distorting allocation statistics.
1866 */
1867 assert(op->ob_refcnt == 0);
Guido van Rossumd724b232000-03-13 16:01:29 +00001868 ++_PyTrash_delete_nesting;
Tim Peters803526b2002-07-07 05:13:56 +00001869 (*dealloc)(op);
Guido van Rossumd724b232000-03-13 16:01:29 +00001870 --_PyTrash_delete_nesting;
1871 }
1872}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001873
1874#ifdef __cplusplus
1875}
1876#endif