blob: c701af007a0441f35181b7e8aa4191116144744e [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
Walter Dörwald1ab83302007-05-18 17:15:44 +0000287 s = PyObject_ReprStr8(op);
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000288 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{
Walter Dörwald1ab83302007-05-18 17:15:44 +0000346 PyObject *ress, *resu;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000347 if (PyErr_CheckSignals())
Guido van Rossum90933611991-06-07 16:10:43 +0000348 return NULL;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000349#ifdef USE_STACKCHECK
350 if (PyOS_CheckStack()) {
Fred Drake661ea262000-10-24 19:57:45 +0000351 PyErr_SetString(PyExc_MemoryError, "stack overflow");
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000352 return NULL;
353 }
354#endif
Guido van Rossum90933611991-06-07 16:10:43 +0000355 if (v == NULL)
Walter Dörwald1ab83302007-05-18 17:15:44 +0000356 return PyUnicode_FromString("<NULL>");
Barry Warsaw7ce36942001-08-24 18:34:26 +0000357 else if (v->ob_type->tp_repr == NULL)
Walter Dörwald1ab83302007-05-18 17:15:44 +0000358 return PyUnicode_FromFormat("<%s object at %p>", v->ob_type->tp_name, v);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000359 else {
Walter Dörwald1ab83302007-05-18 17:15:44 +0000360 ress = (*v->ob_type->tp_repr)(v);
361 if (!ress)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000362 return NULL;
Walter Dörwald1ab83302007-05-18 17:15:44 +0000363 if (PyUnicode_Check(ress))
364 return ress;
365 if (!PyString_Check(ress)) {
Guido van Rossum4c08d552000-03-10 22:55:18 +0000366 PyErr_Format(PyExc_TypeError,
Guido van Rossum5db862d2000-04-10 12:46:51 +0000367 "__repr__ returned non-string (type %.200s)",
Walter Dörwald1ab83302007-05-18 17:15:44 +0000368 ress->ob_type->tp_name);
369 Py_DECREF(ress);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000370 return NULL;
371 }
Walter Dörwald1ab83302007-05-18 17:15:44 +0000372 resu = PyUnicode_FromObject(ress);
373 Py_DECREF(ress);
374 return resu;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000375 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000376}
377
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000378PyObject *
Walter Dörwald1ab83302007-05-18 17:15:44 +0000379PyObject_ReprStr8(PyObject *v)
380{
381 PyObject *resu = PyObject_Repr(v);
382 if (resu) {
383 PyObject *resb = PyUnicode_AsEncodedString(resu, NULL, NULL);
384 Py_DECREF(resu);
385 if (resb) {
386 PyObject *ress = PyString_FromStringAndSize(
387 PyBytes_AS_STRING(resb),
388 PyBytes_GET_SIZE(resb)
389 );
390 Py_DECREF(resb);
391 return ress;
392 }
393 }
394 return NULL;
395}
396
397PyObject *
Neil Schemenauercf52c072005-08-12 17:34:58 +0000398_PyObject_Str(PyObject *v)
Guido van Rossumc6004111993-11-05 10:22:19 +0000399{
Guido van Rossum4c08d552000-03-10 22:55:18 +0000400 PyObject *res;
Neil Schemenauercf52c072005-08-12 17:34:58 +0000401 int type_ok;
Guido van Rossumc6004111993-11-05 10:22:19 +0000402 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000403 return PyString_FromString("<NULL>");
Tim Peters5a49ade2001-09-11 01:41:59 +0000404 if (PyString_CheckExact(v)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000405 Py_INCREF(v);
Guido van Rossumc6004111993-11-05 10:22:19 +0000406 return v;
407 }
Neil Schemenauercf52c072005-08-12 17:34:58 +0000408 if (PyUnicode_CheckExact(v)) {
409 Py_INCREF(v);
410 return v;
411 }
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000412 if (v->ob_type->tp_str == NULL)
413 return PyObject_Repr(v);
414
415 res = (*v->ob_type->tp_str)(v);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000416 if (res == NULL)
417 return NULL;
Neil Schemenauercf52c072005-08-12 17:34:58 +0000418 type_ok = PyString_Check(res);
Neil Schemenauercf52c072005-08-12 17:34:58 +0000419 type_ok = type_ok || PyUnicode_Check(res);
Neil Schemenauercf52c072005-08-12 17:34:58 +0000420 if (!type_ok) {
421 PyErr_Format(PyExc_TypeError,
422 "__str__ returned non-string (type %.200s)",
423 res->ob_type->tp_name);
424 Py_DECREF(res);
425 return NULL;
426 }
427 return res;
428}
429
430PyObject *
431PyObject_Str(PyObject *v)
432{
433 PyObject *res = _PyObject_Str(v);
434 if (res == NULL)
435 return NULL;
Marc-André Lemburg891bc652000-07-03 09:57:53 +0000436 if (PyUnicode_Check(res)) {
437 PyObject* str;
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000438 str = _PyUnicode_AsDefaultEncodedString(res, NULL);
439 Py_XINCREF(str);
Marc-André Lemburg891bc652000-07-03 09:57:53 +0000440 Py_DECREF(res);
441 if (str)
442 res = str;
443 else
444 return NULL;
445 }
Neil Schemenauercf52c072005-08-12 17:34:58 +0000446 assert(PyString_Check(res));
Guido van Rossum4c08d552000-03-10 22:55:18 +0000447 return res;
Guido van Rossumc6004111993-11-05 10:22:19 +0000448}
449
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000450PyObject *
451PyObject_Unicode(PyObject *v)
452{
453 PyObject *res;
Brett Cannonc3647ac2005-04-26 03:45:26 +0000454 PyObject *func;
Neal Norwitz75801462006-03-14 06:02:16 +0000455 PyObject *str;
Brett Cannonc3647ac2005-04-26 03:45:26 +0000456 static PyObject *unicodestr;
Tim Peters803526b2002-07-07 05:13:56 +0000457
Walter Dörwaldb03ccc02007-05-11 17:25:52 +0000458 if (v == NULL)
459 return PyUnicode_FromString("<NULL>");
460 else if (PyUnicode_CheckExact(v)) {
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000461 Py_INCREF(v);
462 return v;
463 }
Brett Cannonc3647ac2005-04-26 03:45:26 +0000464 /* XXX As soon as we have a tp_unicode slot, we should
465 check this before trying the __unicode__
466 method. */
467 if (unicodestr == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +0000468 unicodestr= PyUnicode_InternFromString("__unicode__");
Brett Cannonc3647ac2005-04-26 03:45:26 +0000469 if (unicodestr == NULL)
470 return NULL;
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000471 }
Brett Cannonc3647ac2005-04-26 03:45:26 +0000472 func = PyObject_GetAttr(v, unicodestr);
473 if (func != NULL) {
474 res = PyEval_CallObject(func, (PyObject *)NULL);
475 Py_DECREF(func);
476 }
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000477 else {
Brett Cannonc3647ac2005-04-26 03:45:26 +0000478 PyErr_Clear();
479 if (PyUnicode_Check(v)) {
480 /* For a Unicode subtype that's didn't overwrite __unicode__,
481 return a true Unicode object with the same data. */
482 return PyUnicode_FromUnicode(PyUnicode_AS_UNICODE(v),
483 PyUnicode_GET_SIZE(v));
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000484 }
Brett Cannonc3647ac2005-04-26 03:45:26 +0000485 if (PyString_CheckExact(v)) {
486 Py_INCREF(v);
487 res = v;
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000488 }
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000489 else {
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000490 if (v->ob_type->tp_str != NULL)
491 res = (*v->ob_type->tp_str)(v);
492 else
493 res = PyObject_Repr(v);
494 }
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000495 }
496 if (res == NULL)
497 return NULL;
498 if (!PyUnicode_Check(res)) {
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000499 str = PyUnicode_FromEncodedObject(res, NULL, "strict");
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000500 Py_DECREF(res);
Neal Norwitz75801462006-03-14 06:02:16 +0000501 res = str;
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000502 }
503 return res;
504}
505
506
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000507/* The new comparison philosophy is: we completely separate three-way
508 comparison from rich comparison. That is, PyObject_Compare() and
509 PyObject_Cmp() *just* use the tp_compare slot. And PyObject_RichCompare()
510 and PyObject_RichCompareBool() *just* use the tp_richcompare slot.
511
512 See (*) below for practical amendments.
513
514 IOW, only cmp() uses tp_compare; the comparison operators (==, !=, <=, <,
515 >=, >) only use tp_richcompare. Note that list.sort() only uses <.
516
517 (And yes, eventually we'll rip out cmp() and tp_compare.)
518
519 The calling conventions are different: tp_compare only gets called with two
520 objects of the appropriate type; tp_richcompare gets called with a first
521 argument of the appropriate type and a second object of an arbitrary type.
522 We never do any kind of coercion.
523
524 The return conventions are also different.
525
526 The tp_compare slot should return a C int, as follows:
527
528 -1 if a < b or if an exception occurred
529 0 if a == b
530 +1 if a > b
531
532 No other return values are allowed. PyObject_Compare() has the same
533 calling convention.
534
535 The tp_richcompare slot should return an object, as follows:
536
537 NULL if an exception occurred
538 NotImplemented if the requested comparison is not implemented
539 any other false value if the requested comparison is false
540 any other true value if the requested comparison is true
541
542 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
543 NotImplemented.
544
545 (*) Practical amendments:
546
547 - If rich comparison returns NotImplemented, == and != are decided by
548 comparing the object pointer (i.e. falling back to the base object
549 implementation).
550
551 - If three-way comparison is not implemented, it falls back on rich
552 comparison (but not the other way around!).
553
Guido van Rossuma4073002002-05-31 20:03:54 +0000554*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000555
556/* Forward */
557static PyObject *do_richcompare(PyObject *v, PyObject *w, int op);
558
559/* Perform a three-way comparison, raising TypeError if three-way comparison
560 is not supported. */
Guido van Rossuma4073002002-05-31 20:03:54 +0000561static int
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000562do_compare(PyObject *v, PyObject *w)
Guido van Rossuma4073002002-05-31 20:03:54 +0000563{
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000564 cmpfunc f;
565 int ok;
566
567 if (v->ob_type == w->ob_type &&
568 (f = v->ob_type->tp_compare) != NULL) {
569 return (*f)(v, w);
Guido van Rossuma4073002002-05-31 20:03:54 +0000570 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000571
572 /* Now try three-way compare before giving up. This is intentionally
573 elaborate; if you have a it will raise TypeError if it detects two
574 objects that aren't ordered with respect to each other. */
575 ok = PyObject_RichCompareBool(v, w, Py_LT);
576 if (ok < 0)
577 return -1; /* Error */
578 if (ok)
579 return -1; /* Less than */
580 ok = PyObject_RichCompareBool(v, w, Py_GT);
581 if (ok < 0)
582 return -1; /* Error */
583 if (ok)
584 return 1; /* Greater than */
585 ok = PyObject_RichCompareBool(v, w, Py_EQ);
586 if (ok < 0)
587 return -1; /* Error */
588 if (ok)
589 return 0; /* Equal */
590
591 /* Give up */
592 PyErr_Format(PyExc_TypeError,
Neal Norwitz3bd844e2006-08-29 04:39:12 +0000593 "unorderable types: '%.100s' != '%.100s'",
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000594 v->ob_type->tp_name,
595 w->ob_type->tp_name);
596 return -1;
Guido van Rossuma4073002002-05-31 20:03:54 +0000597}
598
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000599/* Perform a three-way comparison. This wraps do_compare() with a check for
600 NULL arguments and a recursion check. */
601int
602PyObject_Compare(PyObject *v, PyObject *w)
603{
604 int res;
Guido van Rossuma4073002002-05-31 20:03:54 +0000605
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000606 if (v == NULL || w == NULL) {
607 if (!PyErr_Occurred())
608 PyErr_BadInternalCall();
609 return -1;
610 }
611 if (Py_EnterRecursiveCall(" in cmp"))
612 return -1;
613 res = do_compare(v, w);
614 Py_LeaveRecursiveCall();
615 return res < 0 ? -1 : res;
616}
Guido van Rossumd1f06b92001-01-24 22:14:43 +0000617
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000618/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000619int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000620
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000621static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000622
623/* Perform a rich comparison, raising TypeError when the requested comparison
624 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000625static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000626do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000627{
628 richcmpfunc f;
629 PyObject *res;
630
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000631 if (v->ob_type != w->ob_type &&
632 PyType_IsSubtype(w->ob_type, v->ob_type) &&
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000633 (f = w->ob_type->tp_richcompare) != NULL) {
Tim Petersf4aca752004-09-23 02:39:37 +0000634 res = (*f)(w, v, _Py_SwappedOp[op]);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000635 if (res != Py_NotImplemented)
636 return res;
637 Py_DECREF(res);
638 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000639 if ((f = v->ob_type->tp_richcompare) != NULL) {
Guido van Rossume797ec12001-01-17 15:24:28 +0000640 res = (*f)(v, w, op);
641 if (res != Py_NotImplemented)
642 return res;
643 Py_DECREF(res);
644 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000645 if ((f = w->ob_type->tp_richcompare) != NULL) {
646 res = (*f)(w, v, _Py_SwappedOp[op]);
647 if (res != Py_NotImplemented)
648 return res;
649 Py_DECREF(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000650 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000651 /* If neither object implements it, provide a sensible default
652 for == and !=, but raise an exception for ordering. */
653 switch (op) {
654 case Py_EQ:
655 res = (v == w) ? Py_True : Py_False;
656 break;
657 case Py_NE:
658 res = (v != w) ? Py_True : Py_False;
659 break;
660 default:
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000661 /* XXX Special-case None so it doesn't show as NoneType() */
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000662 PyErr_Format(PyExc_TypeError,
663 "unorderable types: %.100s() %s %.100s()",
664 v->ob_type->tp_name,
665 opstrings[op],
666 w->ob_type->tp_name);
667 return NULL;
668 }
Guido van Rossume797ec12001-01-17 15:24:28 +0000669 Py_INCREF(res);
670 return res;
671}
672
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000673/* Perform a rich comparison with object result. This wraps do_richcompare()
674 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000675
Guido van Rossume797ec12001-01-17 15:24:28 +0000676PyObject *
677PyObject_RichCompare(PyObject *v, PyObject *w, int op)
678{
679 PyObject *res;
680
681 assert(Py_LT <= op && op <= Py_GE);
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000682 if (v == NULL || w == NULL) {
683 if (!PyErr_Occurred())
684 PyErr_BadInternalCall();
685 return NULL;
686 }
Armin Rigo2b3eb402003-10-28 12:05:48 +0000687 if (Py_EnterRecursiveCall(" in cmp"))
688 return NULL;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000689 res = do_richcompare(v, w, op);
Armin Rigo2b3eb402003-10-28 12:05:48 +0000690 Py_LeaveRecursiveCall();
Guido van Rossume797ec12001-01-17 15:24:28 +0000691 return res;
692}
693
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000694/* Perform a rich comparison with integer result. This wraps
695 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000696int
697PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
698{
Raymond Hettinger93d44812004-03-21 17:01:44 +0000699 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000700 int ok;
701
Raymond Hettinger93d44812004-03-21 17:01:44 +0000702 res = PyObject_RichCompare(v, w, op);
Guido van Rossume797ec12001-01-17 15:24:28 +0000703 if (res == NULL)
704 return -1;
Guido van Rossum81912d42002-08-24 05:33:28 +0000705 if (PyBool_Check(res))
706 ok = (res == Py_True);
707 else
708 ok = PyObject_IsTrue(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000709 Py_DECREF(res);
710 return ok;
711}
Fred Drake13634cf2000-06-29 19:17:04 +0000712
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000713/* Turn the result of a three-way comparison into the result expected by a
714 rich comparison. */
715PyObject *
716Py_CmpToRich(int op, int cmp)
717{
718 PyObject *res;
719 int ok;
720
721 if (PyErr_Occurred())
722 return NULL;
723 switch (op) {
724 case Py_LT:
725 ok = cmp < 0;
726 break;
727 case Py_LE:
728 ok = cmp <= 0;
729 break;
730 case Py_EQ:
731 ok = cmp == 0;
732 break;
733 case Py_NE:
734 ok = cmp != 0;
735 break;
736 case Py_GT:
737 ok = cmp > 0;
738 break;
739 case Py_GE:
740 ok = cmp >= 0;
741 break;
742 default:
743 PyErr_BadArgument();
744 return NULL;
745 }
746 res = ok ? Py_True : Py_False;
747 Py_INCREF(res);
748 return res;
749}
750
Fred Drake13634cf2000-06-29 19:17:04 +0000751/* Set of hash utility functions to help maintaining the invariant that
Raymond Hettinger8183fa42004-03-21 17:35:06 +0000752 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000753
754 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
755*/
756
757long
Fred Drake100814d2000-07-09 15:48:49 +0000758_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000759{
Tim Peters39dce292000-08-15 03:34:48 +0000760 double intpart, fractpart;
761 int expo;
762 long hipart;
763 long x; /* the final hash value */
764 /* This is designed so that Python numbers of different types
765 * that compare equal hash to the same value; otherwise comparisons
766 * of mapping keys will turn out weird.
767 */
768
Tim Peters39dce292000-08-15 03:34:48 +0000769 fractpart = modf(v, &intpart);
Tim Peters39dce292000-08-15 03:34:48 +0000770 if (fractpart == 0.0) {
771 /* This must return the same hash as an equal int or long. */
772 if (intpart > LONG_MAX || -intpart > LONG_MAX) {
773 /* Convert to long and use its hash. */
774 PyObject *plong; /* converted to Python long */
775 if (Py_IS_INFINITY(intpart))
776 /* can't convert to long int -- arbitrary */
777 v = v < 0 ? -271828.0 : 314159.0;
778 plong = PyLong_FromDouble(v);
779 if (plong == NULL)
780 return -1;
781 x = PyObject_Hash(plong);
782 Py_DECREF(plong);
783 return x;
784 }
785 /* Fits in a C long == a Python int, so is its own hash. */
786 x = (long)intpart;
787 if (x == -1)
788 x = -2;
789 return x;
790 }
791 /* The fractional part is non-zero, so we don't have to worry about
792 * making this match the hash of some other type.
793 * Use frexp to get at the bits in the double.
Fred Drake13634cf2000-06-29 19:17:04 +0000794 * Since the VAX D double format has 56 mantissa bits, which is the
795 * most of any double format in use, each of these parts may have as
796 * many as (but no more than) 56 significant bits.
Tim Peters39dce292000-08-15 03:34:48 +0000797 * So, assuming sizeof(long) >= 4, each part can be broken into two
798 * longs; frexp and multiplication are used to do that.
799 * Also, since the Cray double format has 15 exponent bits, which is
800 * the most of any double format in use, shifting the exponent field
801 * left by 15 won't overflow a long (again assuming sizeof(long) >= 4).
Fred Drake13634cf2000-06-29 19:17:04 +0000802 */
Tim Peters39dce292000-08-15 03:34:48 +0000803 v = frexp(v, &expo);
804 v *= 2147483648.0; /* 2**31 */
805 hipart = (long)v; /* take the top 32 bits */
806 v = (v - (double)hipart) * 2147483648.0; /* get the next 32 bits */
807 x = hipart + (long)v + (expo << 15);
808 if (x == -1)
809 x = -2;
810 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000811}
812
813long
Fred Drake100814d2000-07-09 15:48:49 +0000814_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000815{
816#if SIZEOF_LONG >= SIZEOF_VOID_P
817 return (long)p;
818#else
819 /* convert to a Python long and hash that */
820 PyObject* longobj;
821 long x;
Tim Peters803526b2002-07-07 05:13:56 +0000822
Fred Drake13634cf2000-06-29 19:17:04 +0000823 if ((longobj = PyLong_FromVoidPtr(p)) == NULL) {
824 x = -1;
825 goto finally;
826 }
827 x = PyObject_Hash(longobj);
Tim Peters803526b2002-07-07 05:13:56 +0000828
Fred Drake13634cf2000-06-29 19:17:04 +0000829finally:
830 Py_XDECREF(longobj);
831 return x;
832#endif
833}
834
835
Guido van Rossum9bfef441993-03-29 10:43:31 +0000836long
Fred Drake100814d2000-07-09 15:48:49 +0000837PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000838{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000839 PyTypeObject *tp = v->ob_type;
Guido van Rossum9bfef441993-03-29 10:43:31 +0000840 if (tp->tp_hash != NULL)
841 return (*tp->tp_hash)(v);
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000842 /* Otherwise, the object can't be hashed */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000843 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
844 v->ob_type->tp_name);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000845 return -1;
846}
847
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000848PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000849PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000850{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000851 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000852
Tim Peters6d6c1a32001-08-02 04:15:00 +0000853 if (v->ob_type->tp_getattr != NULL)
Martin v. Löwis15e62742006-02-27 16:46:16 +0000854 return (*v->ob_type->tp_getattr)(v, (char*)name);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000855 w = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000856 if (w == NULL)
857 return NULL;
858 res = PyObject_GetAttr(v, w);
859 Py_XDECREF(w);
860 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000861}
862
863int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000864PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000865{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000866 PyObject *res = PyObject_GetAttrString(v, name);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000867 if (res != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000868 Py_DECREF(res);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000869 return 1;
870 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000871 PyErr_Clear();
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000872 return 0;
873}
874
875int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000876PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000877{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000878 PyObject *s;
879 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000880
Tim Peters6d6c1a32001-08-02 04:15:00 +0000881 if (v->ob_type->tp_setattr != NULL)
Martin v. Löwis15e62742006-02-27 16:46:16 +0000882 return (*v->ob_type->tp_setattr)(v, (char*)name, w);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000883 s = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000884 if (s == NULL)
885 return -1;
886 res = PyObject_SetAttr(v, s, w);
887 Py_XDECREF(s);
888 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000889}
890
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000891PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000892PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000893{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000894 PyTypeObject *tp = v->ob_type;
895
Martin v. Löwis5b222132007-06-10 09:51:05 +0000896 if (!PyUnicode_Check(name)) {
897 PyErr_Format(PyExc_TypeError,
898 "attribute name must be string, not '%.200s'",
899 name->ob_type->tp_name);
900 return NULL;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000901 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000902 if (tp->tp_getattro != NULL)
903 return (*tp->tp_getattro)(v, name);
904 if (tp->tp_getattr != NULL)
Martin v. Löwis5b222132007-06-10 09:51:05 +0000905 return (*tp->tp_getattr)(v, PyUnicode_AsString(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +0000906 PyErr_Format(PyExc_AttributeError,
907 "'%.50s' object has no attribute '%.400s'",
Martin v. Löwis5b222132007-06-10 09:51:05 +0000908 tp->tp_name, PyUnicode_AsString(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +0000909 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000910}
911
912int
Fred Drake100814d2000-07-09 15:48:49 +0000913PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000914{
915 PyObject *res = PyObject_GetAttr(v, name);
916 if (res != NULL) {
917 Py_DECREF(res);
918 return 1;
919 }
920 PyErr_Clear();
921 return 0;
922}
923
924int
Fred Drake100814d2000-07-09 15:48:49 +0000925PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000926{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000927 PyTypeObject *tp = v->ob_type;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000928 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000929
Martin v. Löwis5b222132007-06-10 09:51:05 +0000930 if (!PyUnicode_Check(name)) {
931 PyErr_Format(PyExc_TypeError,
932 "attribute name must be string, not '%.200s'",
933 name->ob_type->tp_name);
934 return -1;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000935 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000936 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000937
Martin v. Löwis5b222132007-06-10 09:51:05 +0000938 PyUnicode_InternInPlace(&name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000939 if (tp->tp_setattro != NULL) {
940 err = (*tp->tp_setattro)(v, name, value);
941 Py_DECREF(name);
942 return err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000943 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000944 if (tp->tp_setattr != NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +0000945 err = (*tp->tp_setattr)(v, PyUnicode_AsString(name), value);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000946 Py_DECREF(name);
947 return err;
948 }
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000949 Py_DECREF(name);
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000950 assert(name->ob_refcnt >= 1);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000951 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
952 PyErr_Format(PyExc_TypeError,
953 "'%.100s' object has no attributes "
954 "(%s .%.100s)",
955 tp->tp_name,
956 value==NULL ? "del" : "assign to",
Martin v. Löwis5b222132007-06-10 09:51:05 +0000957 PyUnicode_AsString(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +0000958 else
959 PyErr_Format(PyExc_TypeError,
960 "'%.100s' object has only read-only attributes "
961 "(%s .%.100s)",
962 tp->tp_name,
963 value==NULL ? "del" : "assign to",
Martin v. Löwis5b222132007-06-10 09:51:05 +0000964 PyUnicode_AsString(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +0000965 return -1;
966}
967
968/* Helper to get a pointer to an object's __dict__ slot, if any */
969
970PyObject **
971_PyObject_GetDictPtr(PyObject *obj)
972{
Martin v. Löwis725507b2006-03-07 12:08:51 +0000973 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000974 PyTypeObject *tp = obj->ob_type;
975
Tim Peters6d6c1a32001-08-02 04:15:00 +0000976 dictoffset = tp->tp_dictoffset;
977 if (dictoffset == 0)
978 return NULL;
979 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000980 Py_ssize_t tsize;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000981 size_t size;
982
983 tsize = ((PyVarObject *)obj)->ob_size;
984 if (tsize < 0)
985 tsize = -tsize;
986 size = _PyObject_VAR_SIZE(tp, tsize);
987
Tim Peters6d483d32001-10-06 21:27:34 +0000988 dictoffset += (long)size;
989 assert(dictoffset > 0);
990 assert(dictoffset % SIZEOF_VOID_P == 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000991 }
992 return (PyObject **) ((char *)obj + dictoffset);
993}
994
Tim Peters6d6c1a32001-08-02 04:15:00 +0000995PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000996PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +0000997{
998 Py_INCREF(obj);
999 return obj;
1000}
1001
Michael W. Hudson1593f502004-09-14 17:09:47 +00001002/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
1003
Raymond Hettinger01538262003-03-17 08:24:35 +00001004PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001005PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
1006{
1007 PyTypeObject *tp = obj->ob_type;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001008 PyObject *descr = NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001009 PyObject *res = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001010 descrgetfunc f;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001011 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001012 PyObject **dictptr;
1013
Martin v. Löwis5b222132007-06-10 09:51:05 +00001014 if (!PyUnicode_Check(name)){
1015 PyErr_Format(PyExc_TypeError,
1016 "attribute name must be string, not '%.200s'",
1017 name->ob_type->tp_name);
1018 return NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001019 }
1020 else
1021 Py_INCREF(name);
1022
Tim Peters6d6c1a32001-08-02 04:15:00 +00001023 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001024 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001025 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001026 }
1027
Guido van Rossum056fbf42002-08-19 19:22:50 +00001028 /* Inline _PyType_Lookup */
1029 {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001030 Py_ssize_t i, n;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001031 PyObject *mro, *base, *dict;
1032
1033 /* Look in tp_dict of types in MRO */
1034 mro = tp->tp_mro;
1035 assert(mro != NULL);
1036 assert(PyTuple_Check(mro));
1037 n = PyTuple_GET_SIZE(mro);
1038 for (i = 0; i < n; i++) {
1039 base = PyTuple_GET_ITEM(mro, i);
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001040 assert(PyType_Check(base));
1041 dict = ((PyTypeObject *)base)->tp_dict;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001042 assert(dict && PyDict_Check(dict));
1043 descr = PyDict_GetItem(dict, name);
1044 if (descr != NULL)
1045 break;
1046 }
1047 }
1048
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001049 Py_XINCREF(descr);
1050
Tim Peters6d6c1a32001-08-02 04:15:00 +00001051 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001052 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001053 f = descr->ob_type->tp_descr_get;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001054 if (f != NULL && PyDescr_IsData(descr)) {
1055 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001056 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001057 goto done;
1058 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001059 }
1060
Guido van Rossumc66ff442002-08-19 16:50:48 +00001061 /* Inline _PyObject_GetDictPtr */
1062 dictoffset = tp->tp_dictoffset;
1063 if (dictoffset != 0) {
1064 PyObject *dict;
1065 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001066 Py_ssize_t tsize;
Guido van Rossumc66ff442002-08-19 16:50:48 +00001067 size_t size;
1068
1069 tsize = ((PyVarObject *)obj)->ob_size;
1070 if (tsize < 0)
1071 tsize = -tsize;
1072 size = _PyObject_VAR_SIZE(tp, tsize);
1073
1074 dictoffset += (long)size;
1075 assert(dictoffset > 0);
1076 assert(dictoffset % SIZEOF_VOID_P == 0);
1077 }
1078 dictptr = (PyObject **) ((char *)obj + dictoffset);
1079 dict = *dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001080 if (dict != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001081 res = PyDict_GetItem(dict, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001082 if (res != NULL) {
1083 Py_INCREF(res);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001084 Py_XDECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001085 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001086 }
1087 }
1088 }
1089
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001090 if (f != NULL) {
1091 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001092 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001093 goto done;
1094 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001095
1096 if (descr != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001097 res = descr;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001098 /* descr was already increfed above */
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001099 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001100 }
1101
1102 PyErr_Format(PyExc_AttributeError,
1103 "'%.50s' object has no attribute '%.400s'",
Martin v. Löwis5b222132007-06-10 09:51:05 +00001104 tp->tp_name, PyUnicode_AsString(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001105 done:
1106 Py_DECREF(name);
1107 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001108}
1109
1110int
1111PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1112{
1113 PyTypeObject *tp = obj->ob_type;
1114 PyObject *descr;
1115 descrsetfunc f;
1116 PyObject **dictptr;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001117 int res = -1;
1118
Martin v. Löwis5b222132007-06-10 09:51:05 +00001119 if (!PyUnicode_Check(name)){
1120 PyErr_Format(PyExc_TypeError,
1121 "attribute name must be string, not '%.200s'",
1122 name->ob_type->tp_name);
1123 return -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001124 }
1125 else
1126 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001127
1128 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001129 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001130 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001131 }
1132
1133 descr = _PyType_Lookup(tp, name);
1134 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001135 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001136 f = descr->ob_type->tp_descr_set;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001137 if (f != NULL && PyDescr_IsData(descr)) {
1138 res = f(descr, obj, value);
1139 goto done;
1140 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001141 }
1142
1143 dictptr = _PyObject_GetDictPtr(obj);
1144 if (dictptr != NULL) {
1145 PyObject *dict = *dictptr;
1146 if (dict == NULL && value != NULL) {
1147 dict = PyDict_New();
1148 if (dict == NULL)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001149 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001150 *dictptr = dict;
1151 }
1152 if (dict != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001153 if (value == NULL)
1154 res = PyDict_DelItem(dict, name);
1155 else
1156 res = PyDict_SetItem(dict, name, value);
1157 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1158 PyErr_SetObject(PyExc_AttributeError, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001159 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001160 }
1161 }
1162
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001163 if (f != NULL) {
1164 res = f(descr, obj, value);
1165 goto done;
1166 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001167
1168 if (descr == NULL) {
1169 PyErr_Format(PyExc_AttributeError,
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001170 "'%.100s' object has no attribute '%.200s'",
Martin v. Löwis5b222132007-06-10 09:51:05 +00001171 tp->tp_name, PyUnicode_AsString(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001172 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001173 }
1174
1175 PyErr_Format(PyExc_AttributeError,
1176 "'%.50s' object attribute '%.400s' is read-only",
Martin v. Löwis5b222132007-06-10 09:51:05 +00001177 tp->tp_name, PyUnicode_AsString(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001178 done:
1179 Py_DECREF(name);
1180 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001181}
1182
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001183/* Test a value used as condition, e.g., in a for or if statement.
1184 Return -1 if an error occurred */
1185
1186int
Fred Drake100814d2000-07-09 15:48:49 +00001187PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001188{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001189 Py_ssize_t res;
Guido van Rossum6248f442002-08-24 06:31:34 +00001190 if (v == Py_True)
1191 return 1;
1192 if (v == Py_False)
1193 return 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001194 if (v == Py_None)
Neal Norwitz51290d32002-06-13 21:32:44 +00001195 return 0;
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001196 else if (v->ob_type->tp_as_number != NULL &&
Jack Diederich4dafcc42006-11-28 19:15:13 +00001197 v->ob_type->tp_as_number->nb_bool != NULL)
1198 res = (*v->ob_type->tp_as_number->nb_bool)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001199 else if (v->ob_type->tp_as_mapping != NULL &&
1200 v->ob_type->tp_as_mapping->mp_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001201 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001202 else if (v->ob_type->tp_as_sequence != NULL &&
1203 v->ob_type->tp_as_sequence->sq_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001204 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1205 else
Neal Norwitz51290d32002-06-13 21:32:44 +00001206 return 1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001207 /* if it is negative, it should be either -1 or -2 */
1208 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001209}
1210
Tim Peters803526b2002-07-07 05:13:56 +00001211/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001212 Return -1 if an error occurred */
1213
1214int
Fred Drake100814d2000-07-09 15:48:49 +00001215PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001216{
1217 int res;
1218 res = PyObject_IsTrue(v);
1219 if (res < 0)
1220 return res;
1221 return res == 0;
1222}
1223
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001224/* Test whether an object can be called */
1225
1226int
Fred Drake100814d2000-07-09 15:48:49 +00001227PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001228{
1229 if (x == NULL)
1230 return 0;
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001231 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001232}
1233
Georg Brandle32b4222007-03-10 22:13:27 +00001234/* ------------------------- PyObject_Dir() helpers ------------------------- */
1235
Tim Peters7eea37e2001-09-04 22:08:56 +00001236/* Helper for PyObject_Dir.
1237 Merge the __dict__ of aclass into dict, and recursively also all
1238 the __dict__s of aclass's base classes. The order of merging isn't
1239 defined, as it's expected that only the final set of dict keys is
1240 interesting.
1241 Return 0 on success, -1 on error.
1242*/
1243
1244static int
1245merge_class_dict(PyObject* dict, PyObject* aclass)
1246{
1247 PyObject *classdict;
1248 PyObject *bases;
1249
1250 assert(PyDict_Check(dict));
1251 assert(aclass);
1252
1253 /* Merge in the type's dict (if any). */
1254 classdict = PyObject_GetAttrString(aclass, "__dict__");
1255 if (classdict == NULL)
1256 PyErr_Clear();
1257 else {
1258 int status = PyDict_Update(dict, classdict);
1259 Py_DECREF(classdict);
1260 if (status < 0)
1261 return -1;
1262 }
1263
1264 /* Recursively merge in the base types' (if any) dicts. */
1265 bases = PyObject_GetAttrString(aclass, "__bases__");
Tim Petersbc7e8632001-09-16 20:33:22 +00001266 if (bases == NULL)
1267 PyErr_Clear();
1268 else {
Guido van Rossum44022412002-05-13 18:29:46 +00001269 /* We have no guarantee that bases is a real tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001270 Py_ssize_t i, n;
Guido van Rossum44022412002-05-13 18:29:46 +00001271 n = PySequence_Size(bases); /* This better be right */
1272 if (n < 0)
1273 PyErr_Clear();
1274 else {
1275 for (i = 0; i < n; i++) {
Tim Peters18e70832003-02-05 19:35:19 +00001276 int status;
Guido van Rossum44022412002-05-13 18:29:46 +00001277 PyObject *base = PySequence_GetItem(bases, i);
1278 if (base == NULL) {
1279 Py_DECREF(bases);
1280 return -1;
1281 }
Tim Peters18e70832003-02-05 19:35:19 +00001282 status = merge_class_dict(dict, base);
1283 Py_DECREF(base);
1284 if (status < 0) {
Guido van Rossum44022412002-05-13 18:29:46 +00001285 Py_DECREF(bases);
1286 return -1;
1287 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001288 }
1289 }
1290 Py_DECREF(bases);
1291 }
1292 return 0;
1293}
1294
Georg Brandle32b4222007-03-10 22:13:27 +00001295/* Helper for PyObject_Dir without arguments: returns the local scope. */
1296static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001297_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001298{
Georg Brandled3b8382007-03-12 13:15:14 +00001299 PyObject *names;
Georg Brandle32b4222007-03-10 22:13:27 +00001300 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001301
Georg Brandle32b4222007-03-10 22:13:27 +00001302 if (locals == NULL) {
1303 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1304 return NULL;
Tim Peters305b5852001-09-17 02:38:46 +00001305 }
1306
Georg Brandled3b8382007-03-12 13:15:14 +00001307 names = PyMapping_Keys(locals);
1308 if (!names)
1309 return NULL;
1310 if (!PyList_Check(names)) {
1311 PyErr_Format(PyExc_TypeError,
1312 "dir(): expected keys() of locals to be a list, "
1313 "not '%.200s'", names->ob_type->tp_name);
1314 Py_DECREF(names);
1315 return NULL;
1316 }
Georg Brandle32b4222007-03-10 22:13:27 +00001317 /* the locals don't need to be DECREF'd */
Georg Brandled3b8382007-03-12 13:15:14 +00001318 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001319}
1320
1321/* Helper for PyObject_Dir of type objects: returns __dict__ and __bases__.
1322 We deliberately don't suck up its __class__, as methods belonging to the
1323 metaclass would probably be more confusing than helpful.
1324*/
1325static PyObject *
1326_specialized_dir_type(PyObject *obj)
1327{
1328 PyObject *result = NULL;
1329 PyObject *dict = PyDict_New();
1330
1331 if (dict != NULL && merge_class_dict(dict, obj) == 0)
1332 result = PyDict_Keys(dict);
1333
1334 Py_XDECREF(dict);
Tim Peters305b5852001-09-17 02:38:46 +00001335 return result;
1336}
1337
Georg Brandle32b4222007-03-10 22:13:27 +00001338/* Helper for PyObject_Dir of module objects: returns the module's __dict__. */
1339static PyObject *
1340_specialized_dir_module(PyObject *obj)
Tim Peters7eea37e2001-09-04 22:08:56 +00001341{
Georg Brandle32b4222007-03-10 22:13:27 +00001342 PyObject *result = NULL;
1343 PyObject *dict = PyObject_GetAttrString(obj, "__dict__");
Tim Peters7eea37e2001-09-04 22:08:56 +00001344
Georg Brandle32b4222007-03-10 22:13:27 +00001345 if (dict != NULL) {
1346 if (PyDict_Check(dict))
1347 result = PyDict_Keys(dict);
1348 else {
1349 PyErr_Format(PyExc_TypeError,
1350 "%.200s.__dict__ is not a dictionary",
1351 PyModule_GetName(obj));
Guido van Rossum8dbd3d82001-09-10 18:27:43 +00001352 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001353 }
1354
Georg Brandle32b4222007-03-10 22:13:27 +00001355 Py_XDECREF(dict);
1356 return result;
1357}
Tim Peters7eea37e2001-09-04 22:08:56 +00001358
Georg Brandle32b4222007-03-10 22:13:27 +00001359/* Helper for PyObject_Dir of generic objects: returns __dict__, __class__,
1360 and recursively up the __class__.__bases__ chain.
1361*/
1362static PyObject *
1363_generic_dir(PyObject *obj)
1364{
1365 PyObject *result = NULL;
1366 PyObject *dict = NULL;
1367 PyObject *itsclass = NULL;
1368
1369 /* Get __dict__ (which may or may not be a real dict...) */
1370 dict = PyObject_GetAttrString(obj, "__dict__");
1371 if (dict == NULL) {
1372 PyErr_Clear();
1373 dict = PyDict_New();
1374 }
1375 else if (!PyDict_Check(dict)) {
1376 Py_DECREF(dict);
1377 dict = PyDict_New();
1378 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001379 else {
Georg Brandle32b4222007-03-10 22:13:27 +00001380 /* Copy __dict__ to avoid mutating it. */
1381 PyObject *temp = PyDict_Copy(dict);
1382 Py_DECREF(dict);
1383 dict = temp;
Tim Peters7eea37e2001-09-04 22:08:56 +00001384 }
1385
Georg Brandle32b4222007-03-10 22:13:27 +00001386 if (dict == NULL)
Raymond Hettinger2a7dede2004-08-07 04:55:30 +00001387 goto error;
Tim Peters7eea37e2001-09-04 22:08:56 +00001388
Georg Brandle32b4222007-03-10 22:13:27 +00001389 /* Merge in attrs reachable from its class. */
1390 itsclass = PyObject_GetAttrString(obj, "__class__");
1391 if (itsclass == NULL)
1392 /* XXX(tomer): Perhaps fall back to obj->ob_type if no
1393 __class__ exists? */
1394 PyErr_Clear();
1395 else {
1396 if (merge_class_dict(dict, itsclass) != 0)
1397 goto error;
1398 }
1399
1400 result = PyDict_Keys(dict);
Tim Peters7eea37e2001-09-04 22:08:56 +00001401 /* fall through */
Georg Brandle32b4222007-03-10 22:13:27 +00001402error:
1403 Py_XDECREF(itsclass);
1404 Py_XDECREF(dict);
1405 return result;
1406}
1407
1408/* Helper for PyObject_Dir: object introspection.
1409 This calls one of the above specialized versions if no __dir__ method
1410 exists. */
1411static PyObject *
1412_dir_object(PyObject *obj)
1413{
1414 PyObject * result = NULL;
1415 PyObject * dirfunc = PyObject_GetAttrString((PyObject*)obj->ob_type,
1416 "__dir__");
1417
1418 assert(obj);
1419 if (dirfunc == NULL) {
1420 /* use default implementation */
1421 PyErr_Clear();
1422 if (PyModule_Check(obj))
1423 result = _specialized_dir_module(obj);
1424 else if (PyType_Check(obj))
1425 result = _specialized_dir_type(obj);
1426 else
1427 result = _generic_dir(obj);
1428 }
1429 else {
1430 /* use __dir__ */
1431 result = PyObject_CallFunctionObjArgs(dirfunc, obj, NULL);
1432 Py_DECREF(dirfunc);
1433 if (result == NULL)
1434 return NULL;
1435
1436 /* result must be a list */
1437 /* XXX(gbrandl): could also check if all items are strings */
1438 if (!PyList_Check(result)) {
1439 PyErr_Format(PyExc_TypeError,
1440 "__dir__() must return a list, not %.200s",
1441 result->ob_type->tp_name);
1442 Py_DECREF(result);
1443 result = NULL;
1444 }
1445 }
1446
1447 return result;
1448}
1449
1450/* Implementation of dir() -- if obj is NULL, returns the names in the current
1451 (local) scope. Otherwise, performs introspection of the object: returns a
1452 sorted list of attribute names (supposedly) accessible from the object
1453*/
1454PyObject *
1455PyObject_Dir(PyObject *obj)
1456{
1457 PyObject * result;
1458
1459 if (obj == NULL)
1460 /* no object -- introspect the locals */
1461 result = _dir_locals();
1462 else
1463 /* object -- introspect the object */
1464 result = _dir_object(obj);
1465
1466 assert(result == NULL || PyList_Check(result));
1467
1468 if (result != NULL && PyList_Sort(result) != 0) {
1469 /* sorting the list failed */
1470 Py_DECREF(result);
1471 result = NULL;
1472 }
1473
Tim Peters7eea37e2001-09-04 22:08:56 +00001474 return result;
1475}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001476
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001477/*
1478NoObject is usable as a non-NULL undefined value, used by the macro None.
1479There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001480so there is exactly one (which is indestructible, by the way).
Guido van Rossumba21a492001-08-16 08:17:26 +00001481(XXX This type and the type of NotImplemented below should be unified.)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001482*/
1483
Guido van Rossum0c182a11992-03-27 17:26:13 +00001484/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001485static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001486none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001487{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001488 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001489}
1490
Barry Warsaw9bf16442001-01-23 16:24:35 +00001491/* ARGUSED */
1492static void
Tim Peters803526b2002-07-07 05:13:56 +00001493none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001494{
1495 /* This should never get called, but we also don't want to SEGV if
1496 * we accidently decref None out of existance.
1497 */
Martin v. Löwis3f19b102002-08-07 16:21:51 +00001498 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001499}
1500
1501
Guido van Rossumba21a492001-08-16 08:17:26 +00001502static PyTypeObject PyNone_Type = {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001503 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001504 0,
Guido van Rossumba21a492001-08-16 08:17:26 +00001505 "NoneType",
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001506 0,
1507 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001508 none_dealloc, /*tp_dealloc*/ /*never called*/
Guido van Rossum7066dd71992-09-17 17:54:56 +00001509 0, /*tp_print*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001510 0, /*tp_getattr*/
1511 0, /*tp_setattr*/
1512 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001513 none_repr, /*tp_repr*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001514 0, /*tp_as_number*/
1515 0, /*tp_as_sequence*/
1516 0, /*tp_as_mapping*/
Guido van Rossum9bfef441993-03-29 10:43:31 +00001517 0, /*tp_hash */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001518};
1519
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001520PyObject _Py_NoneStruct = {
Guido van Rossumba21a492001-08-16 08:17:26 +00001521 PyObject_HEAD_INIT(&PyNone_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001522};
1523
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001524/* NotImplemented is an object that can be used to signal that an
1525 operation is not implemented for the given type combination. */
1526
1527static PyObject *
1528NotImplemented_repr(PyObject *op)
1529{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001530 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001531}
1532
1533static PyTypeObject PyNotImplemented_Type = {
1534 PyObject_HEAD_INIT(&PyType_Type)
1535 0,
Guido van Rossumba21a492001-08-16 08:17:26 +00001536 "NotImplementedType",
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001537 0,
1538 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001539 none_dealloc, /*tp_dealloc*/ /*never called*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001540 0, /*tp_print*/
1541 0, /*tp_getattr*/
1542 0, /*tp_setattr*/
1543 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001544 NotImplemented_repr, /*tp_repr*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001545 0, /*tp_as_number*/
1546 0, /*tp_as_sequence*/
1547 0, /*tp_as_mapping*/
1548 0, /*tp_hash */
1549};
1550
1551PyObject _Py_NotImplementedStruct = {
1552 PyObject_HEAD_INIT(&PyNotImplemented_Type)
1553};
1554
Guido van Rossumba21a492001-08-16 08:17:26 +00001555void
1556_Py_ReadyTypes(void)
1557{
1558 if (PyType_Ready(&PyType_Type) < 0)
1559 Py_FatalError("Can't initialize 'type'");
1560
Fred Drake0a4dd392004-07-02 18:57:45 +00001561 if (PyType_Ready(&_PyWeakref_RefType) < 0)
1562 Py_FatalError("Can't initialize 'weakref'");
1563
Guido van Rossum77f6a652002-04-03 22:41:51 +00001564 if (PyType_Ready(&PyBool_Type) < 0)
1565 Py_FatalError("Can't initialize 'bool'");
1566
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001567 if (PyType_Ready(&PyBytes_Type) < 0)
1568 Py_FatalError("Can't initialize 'bytes'");
1569
Guido van Rossumcacfc072002-05-24 19:01:59 +00001570 if (PyType_Ready(&PyString_Type) < 0)
1571 Py_FatalError("Can't initialize 'str'");
1572
Guido van Rossumba21a492001-08-16 08:17:26 +00001573 if (PyType_Ready(&PyList_Type) < 0)
1574 Py_FatalError("Can't initialize 'list'");
1575
1576 if (PyType_Ready(&PyNone_Type) < 0)
1577 Py_FatalError("Can't initialize type(None)");
1578
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001579 if (PyType_Ready(Py_Ellipsis->ob_type) < 0)
1580 Py_FatalError("Can't initialize type(Ellipsis)");
1581
Guido van Rossumba21a492001-08-16 08:17:26 +00001582 if (PyType_Ready(&PyNotImplemented_Type) < 0)
1583 Py_FatalError("Can't initialize type(NotImplemented)");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001584
1585 if (PyType_Ready(&PyCode_Type) < 0)
1586 Py_FatalError("Can't initialize 'code'");
Guido van Rossumba21a492001-08-16 08:17:26 +00001587}
1588
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001589
Guido van Rossum84a90321996-05-22 16:34:47 +00001590#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001591
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001592void
Fred Drake100814d2000-07-09 15:48:49 +00001593_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001594{
Tim Peters34592512002-07-11 06:23:50 +00001595 _Py_INC_REFTOTAL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001596 op->ob_refcnt = 1;
Tim Peters7571a0f2003-03-23 17:52:28 +00001597 _Py_AddToAllObjects(op, 1);
Tim Peters34592512002-07-11 06:23:50 +00001598 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001599}
1600
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001601void
Fred Drake100814d2000-07-09 15:48:49 +00001602_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001603{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001604#ifdef SLOW_UNREF_CHECK
Guido van Rossum4c08d552000-03-10 22:55:18 +00001605 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001606#endif
Guido van Rossumd7047b31995-01-02 19:07:15 +00001607 if (op->ob_refcnt < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001608 Py_FatalError("UNREF negative refcnt");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001609 if (op == &refchain ||
Guido van Rossumd7047b31995-01-02 19:07:15 +00001610 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001611 Py_FatalError("UNREF invalid object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001612#ifdef SLOW_UNREF_CHECK
Guido van Rossum3f5da241990-12-20 15:06:42 +00001613 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1614 if (p == op)
1615 break;
1616 }
Guido van Rossumd7047b31995-01-02 19:07:15 +00001617 if (p == &refchain) /* Not found */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001618 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001619#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001620 op->_ob_next->_ob_prev = op->_ob_prev;
1621 op->_ob_prev->_ob_next = op->_ob_next;
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001622 op->_ob_next = op->_ob_prev = NULL;
Tim Peters34592512002-07-11 06:23:50 +00001623 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001624}
1625
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001626void
Fred Drake100814d2000-07-09 15:48:49 +00001627_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001628{
Guido van Rossum9776adf1994-09-07 14:36:45 +00001629 destructor dealloc = op->ob_type->tp_dealloc;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001630 _Py_ForgetReference(op);
Guido van Rossum9776adf1994-09-07 14:36:45 +00001631 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001632}
1633
Tim Peters269b2a62003-04-17 19:52:29 +00001634/* Print all live objects. Because PyObject_Print is called, the
1635 * interpreter must be in a healthy state.
1636 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001637void
Fred Drake100814d2000-07-09 15:48:49 +00001638_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001639{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001640 PyObject *op;
Guido van Rossume09fb551997-08-05 02:04:34 +00001641 fprintf(fp, "Remaining objects:\n");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001642 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001643 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001644 if (PyObject_Print(op, fp, 0) != 0)
1645 PyErr_Clear();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001646 putc('\n', fp);
1647 }
1648}
1649
Tim Peters269b2a62003-04-17 19:52:29 +00001650/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1651 * doesn't make any calls to the Python C API, so is always safe to call.
1652 */
1653void
1654_Py_PrintReferenceAddresses(FILE *fp)
1655{
1656 PyObject *op;
1657 fprintf(fp, "Remaining object addresses:\n");
1658 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001659 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
1660 op->ob_refcnt, op->ob_type->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001661}
1662
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001663PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001664_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001665{
1666 int i, n;
1667 PyObject *t = NULL;
1668 PyObject *res, *op;
1669
1670 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1671 return NULL;
1672 op = refchain._ob_next;
1673 res = PyList_New(0);
1674 if (res == NULL)
1675 return NULL;
1676 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1677 while (op == self || op == args || op == res || op == t ||
Guido van Rossum3c296022001-07-14 17:58:00 +00001678 (t != NULL && op->ob_type != (PyTypeObject *) t)) {
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001679 op = op->_ob_next;
1680 if (op == &refchain)
1681 return res;
1682 }
1683 if (PyList_Append(res, op) < 0) {
1684 Py_DECREF(res);
1685 return NULL;
1686 }
1687 op = op->_ob_next;
1688 }
1689 return res;
1690}
1691
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001692#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001693
1694
1695/* Hack to force loading of cobject.o */
Guido van Rossumda9c2711996-12-05 21:58:58 +00001696PyTypeObject *_Py_cobject_hack = &PyCObject_Type;
Guido van Rossum84a90321996-05-22 16:34:47 +00001697
1698
1699/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001700Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001701
1702
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001703/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001704
Thomas Wouters334fb892000-07-25 12:56:38 +00001705void *
Fred Drake100814d2000-07-09 15:48:49 +00001706PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001707{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001708 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001709}
1710
Thomas Wouters334fb892000-07-25 12:56:38 +00001711void *
1712PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001713{
Tim Petersaf3e8de2002-04-12 07:22:56 +00001714 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001715}
1716
1717void
Thomas Wouters334fb892000-07-25 12:56:38 +00001718PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001719{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001720 PyMem_FREE(p);
1721}
1722
1723
Guido van Rossum86610361998-04-10 22:32:46 +00001724/* These methods are used to control infinite recursion in repr, str, print,
1725 etc. Container objects that may recursively contain themselves,
1726 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1727 Py_ReprLeave() to avoid infinite recursion.
1728
1729 Py_ReprEnter() returns 0 the first time it is called for a particular
1730 object and 1 every time thereafter. It returns -1 if an exception
1731 occurred. Py_ReprLeave() has no return value.
1732
1733 See dictobject.c and listobject.c for examples of use.
1734*/
1735
1736#define KEY "Py_Repr"
1737
1738int
Fred Drake100814d2000-07-09 15:48:49 +00001739Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001740{
1741 PyObject *dict;
1742 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001743 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001744
1745 dict = PyThreadState_GetDict();
1746 if (dict == NULL)
Guido van Rossum0fc8f002003-04-15 15:12:39 +00001747 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001748 list = PyDict_GetItemString(dict, KEY);
1749 if (list == NULL) {
1750 list = PyList_New(0);
1751 if (list == NULL)
1752 return -1;
1753 if (PyDict_SetItemString(dict, KEY, list) < 0)
1754 return -1;
1755 Py_DECREF(list);
1756 }
1757 i = PyList_GET_SIZE(list);
1758 while (--i >= 0) {
1759 if (PyList_GET_ITEM(list, i) == obj)
1760 return 1;
1761 }
1762 PyList_Append(list, obj);
1763 return 0;
1764}
1765
1766void
Fred Drake100814d2000-07-09 15:48:49 +00001767Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001768{
1769 PyObject *dict;
1770 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001771 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001772
1773 dict = PyThreadState_GetDict();
Guido van Rossumeb909461998-04-11 15:17:34 +00001774 if (dict == NULL)
1775 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001776 list = PyDict_GetItemString(dict, KEY);
Guido van Rossumeb909461998-04-11 15:17:34 +00001777 if (list == NULL || !PyList_Check(list))
1778 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001779 i = PyList_GET_SIZE(list);
1780 /* Count backwards because we always expect obj to be list[-1] */
1781 while (--i >= 0) {
1782 if (PyList_GET_ITEM(list, i) == obj) {
1783 PyList_SetSlice(list, i, i + 1, NULL);
1784 break;
1785 }
1786 }
1787}
Guido van Rossumd724b232000-03-13 16:01:29 +00001788
Tim Peters803526b2002-07-07 05:13:56 +00001789/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001790
Tim Peters803526b2002-07-07 05:13:56 +00001791/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001792int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001793
Tim Peters803526b2002-07-07 05:13:56 +00001794/* List of objects that still need to be cleaned up, singly linked via their
1795 * gc headers' gc_prev pointers.
1796 */
1797PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001798
Tim Peters803526b2002-07-07 05:13:56 +00001799/* Add op to the _PyTrash_delete_later list. Called when the current
1800 * call-stack depth gets large. op must be a currently untracked gc'ed
1801 * object, with refcount 0. Py_DECREF must already have been called on it.
1802 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001803void
Fred Drake100814d2000-07-09 15:48:49 +00001804_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001805{
Tim Peters803526b2002-07-07 05:13:56 +00001806 assert(PyObject_IS_GC(op));
1807 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1808 assert(op->ob_refcnt == 0);
Neil Schemenauerf589c052002-03-29 03:05:54 +00001809 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
Guido van Rossume92e6102000-04-24 15:40:53 +00001810 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001811}
1812
Tim Peters803526b2002-07-07 05:13:56 +00001813/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1814 * the call-stack unwinds again.
1815 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001816void
Fred Drake100814d2000-07-09 15:48:49 +00001817_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001818{
1819 while (_PyTrash_delete_later) {
Tim Peters803526b2002-07-07 05:13:56 +00001820 PyObject *op = _PyTrash_delete_later;
1821 destructor dealloc = op->ob_type->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001822
Neil Schemenauerf589c052002-03-29 03:05:54 +00001823 _PyTrash_delete_later =
Tim Peters803526b2002-07-07 05:13:56 +00001824 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001825
Tim Peters803526b2002-07-07 05:13:56 +00001826 /* Call the deallocator directly. This used to try to
1827 * fool Py_DECREF into calling it indirectly, but
1828 * Py_DECREF was already called on this object, and in
1829 * assorted non-release builds calling Py_DECREF again ends
1830 * up distorting allocation statistics.
1831 */
1832 assert(op->ob_refcnt == 0);
Guido van Rossumd724b232000-03-13 16:01:29 +00001833 ++_PyTrash_delete_nesting;
Tim Peters803526b2002-07-07 05:13:56 +00001834 (*dealloc)(op);
Guido van Rossumd724b232000-03-13 16:01:29 +00001835 --_PyTrash_delete_nesting;
1836 }
1837}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001838
1839#ifdef __cplusplus
1840}
1841#endif