blob: 81f5669453538d22e1103e521d9b22e147c268b0 [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;
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000425 str = _PyUnicode_AsDefaultEncodedString(res, NULL);
426 Py_XINCREF(str);
Marc-André Lemburg891bc652000-07-03 09:57:53 +0000427 Py_DECREF(res);
428 if (str)
429 res = str;
430 else
431 return NULL;
432 }
Neil Schemenauercf52c072005-08-12 17:34:58 +0000433 assert(PyString_Check(res));
Guido van Rossum4c08d552000-03-10 22:55:18 +0000434 return res;
Guido van Rossumc6004111993-11-05 10:22:19 +0000435}
436
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000437PyObject *
438PyObject_Unicode(PyObject *v)
439{
440 PyObject *res;
Brett Cannonc3647ac2005-04-26 03:45:26 +0000441 PyObject *func;
Neal Norwitz75801462006-03-14 06:02:16 +0000442 PyObject *str;
Brett Cannonc3647ac2005-04-26 03:45:26 +0000443 static PyObject *unicodestr;
Tim Peters803526b2002-07-07 05:13:56 +0000444
Georg Brandl3daf7582006-03-13 22:22:11 +0000445 if (v == NULL) {
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000446 res = PyString_FromString("<NULL>");
Neal Norwitz75801462006-03-14 06:02:16 +0000447 if (res == NULL)
448 return NULL;
449 str = PyUnicode_FromEncodedObject(res, NULL, "strict");
450 Py_DECREF(res);
451 return str;
Georg Brandl3daf7582006-03-13 22:22:11 +0000452 } else if (PyUnicode_CheckExact(v)) {
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000453 Py_INCREF(v);
454 return v;
455 }
Brett Cannonc3647ac2005-04-26 03:45:26 +0000456 /* XXX As soon as we have a tp_unicode slot, we should
457 check this before trying the __unicode__
458 method. */
459 if (unicodestr == NULL) {
460 unicodestr= PyString_InternFromString("__unicode__");
461 if (unicodestr == NULL)
462 return NULL;
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000463 }
Brett Cannonc3647ac2005-04-26 03:45:26 +0000464 func = PyObject_GetAttr(v, unicodestr);
465 if (func != NULL) {
466 res = PyEval_CallObject(func, (PyObject *)NULL);
467 Py_DECREF(func);
468 }
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000469 else {
Brett Cannonc3647ac2005-04-26 03:45:26 +0000470 PyErr_Clear();
471 if (PyUnicode_Check(v)) {
472 /* For a Unicode subtype that's didn't overwrite __unicode__,
473 return a true Unicode object with the same data. */
474 return PyUnicode_FromUnicode(PyUnicode_AS_UNICODE(v),
475 PyUnicode_GET_SIZE(v));
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000476 }
Brett Cannonc3647ac2005-04-26 03:45:26 +0000477 if (PyString_CheckExact(v)) {
478 Py_INCREF(v);
479 res = v;
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000480 }
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000481 else {
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000482 if (v->ob_type->tp_str != NULL)
483 res = (*v->ob_type->tp_str)(v);
484 else
485 res = PyObject_Repr(v);
486 }
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000487 }
488 if (res == NULL)
489 return NULL;
490 if (!PyUnicode_Check(res)) {
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000491 str = PyUnicode_FromEncodedObject(res, NULL, "strict");
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000492 Py_DECREF(res);
Neal Norwitz75801462006-03-14 06:02:16 +0000493 res = str;
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000494 }
495 return res;
496}
497
498
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000499/* The new comparison philosophy is: we completely separate three-way
500 comparison from rich comparison. That is, PyObject_Compare() and
501 PyObject_Cmp() *just* use the tp_compare slot. And PyObject_RichCompare()
502 and PyObject_RichCompareBool() *just* use the tp_richcompare slot.
503
504 See (*) below for practical amendments.
505
506 IOW, only cmp() uses tp_compare; the comparison operators (==, !=, <=, <,
507 >=, >) only use tp_richcompare. Note that list.sort() only uses <.
508
509 (And yes, eventually we'll rip out cmp() and tp_compare.)
510
511 The calling conventions are different: tp_compare only gets called with two
512 objects of the appropriate type; tp_richcompare gets called with a first
513 argument of the appropriate type and a second object of an arbitrary type.
514 We never do any kind of coercion.
515
516 The return conventions are also different.
517
518 The tp_compare slot should return a C int, as follows:
519
520 -1 if a < b or if an exception occurred
521 0 if a == b
522 +1 if a > b
523
524 No other return values are allowed. PyObject_Compare() has the same
525 calling convention.
526
527 The tp_richcompare slot should return an object, as follows:
528
529 NULL if an exception occurred
530 NotImplemented if the requested comparison is not implemented
531 any other false value if the requested comparison is false
532 any other true value if the requested comparison is true
533
534 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
535 NotImplemented.
536
537 (*) Practical amendments:
538
539 - If rich comparison returns NotImplemented, == and != are decided by
540 comparing the object pointer (i.e. falling back to the base object
541 implementation).
542
543 - If three-way comparison is not implemented, it falls back on rich
544 comparison (but not the other way around!).
545
Guido van Rossuma4073002002-05-31 20:03:54 +0000546*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000547
548/* Forward */
549static PyObject *do_richcompare(PyObject *v, PyObject *w, int op);
550
551/* Perform a three-way comparison, raising TypeError if three-way comparison
552 is not supported. */
Guido van Rossuma4073002002-05-31 20:03:54 +0000553static int
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000554do_compare(PyObject *v, PyObject *w)
Guido van Rossuma4073002002-05-31 20:03:54 +0000555{
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000556 cmpfunc f;
557 int ok;
558
559 if (v->ob_type == w->ob_type &&
560 (f = v->ob_type->tp_compare) != NULL) {
561 return (*f)(v, w);
Guido van Rossuma4073002002-05-31 20:03:54 +0000562 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000563
564 /* Now try three-way compare before giving up. This is intentionally
565 elaborate; if you have a it will raise TypeError if it detects two
566 objects that aren't ordered with respect to each other. */
567 ok = PyObject_RichCompareBool(v, w, Py_LT);
568 if (ok < 0)
569 return -1; /* Error */
570 if (ok)
571 return -1; /* Less than */
572 ok = PyObject_RichCompareBool(v, w, Py_GT);
573 if (ok < 0)
574 return -1; /* Error */
575 if (ok)
576 return 1; /* Greater than */
577 ok = PyObject_RichCompareBool(v, w, Py_EQ);
578 if (ok < 0)
579 return -1; /* Error */
580 if (ok)
581 return 0; /* Equal */
582
583 /* Give up */
584 PyErr_Format(PyExc_TypeError,
Neal Norwitz3bd844e2006-08-29 04:39:12 +0000585 "unorderable types: '%.100s' != '%.100s'",
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000586 v->ob_type->tp_name,
587 w->ob_type->tp_name);
588 return -1;
Guido van Rossuma4073002002-05-31 20:03:54 +0000589}
590
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000591/* Perform a three-way comparison. This wraps do_compare() with a check for
592 NULL arguments and a recursion check. */
593int
594PyObject_Compare(PyObject *v, PyObject *w)
595{
596 int res;
Guido van Rossuma4073002002-05-31 20:03:54 +0000597
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000598 if (v == NULL || w == NULL) {
599 if (!PyErr_Occurred())
600 PyErr_BadInternalCall();
601 return -1;
602 }
603 if (Py_EnterRecursiveCall(" in cmp"))
604 return -1;
605 res = do_compare(v, w);
606 Py_LeaveRecursiveCall();
607 return res < 0 ? -1 : res;
608}
Guido van Rossumd1f06b92001-01-24 22:14:43 +0000609
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000610/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000611int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000612
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000613static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000614
615/* Perform a rich comparison, raising TypeError when the requested comparison
616 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000617static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000618do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000619{
620 richcmpfunc f;
621 PyObject *res;
622
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000623 if (v->ob_type != w->ob_type &&
624 PyType_IsSubtype(w->ob_type, v->ob_type) &&
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000625 (f = w->ob_type->tp_richcompare) != NULL) {
Tim Petersf4aca752004-09-23 02:39:37 +0000626 res = (*f)(w, v, _Py_SwappedOp[op]);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000627 if (res != Py_NotImplemented)
628 return res;
629 Py_DECREF(res);
630 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000631 if ((f = v->ob_type->tp_richcompare) != NULL) {
Guido van Rossume797ec12001-01-17 15:24:28 +0000632 res = (*f)(v, w, op);
633 if (res != Py_NotImplemented)
634 return res;
635 Py_DECREF(res);
636 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000637 if ((f = w->ob_type->tp_richcompare) != NULL) {
638 res = (*f)(w, v, _Py_SwappedOp[op]);
639 if (res != Py_NotImplemented)
640 return res;
641 Py_DECREF(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000642 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000643 /* If neither object implements it, provide a sensible default
644 for == and !=, but raise an exception for ordering. */
645 switch (op) {
646 case Py_EQ:
647 res = (v == w) ? Py_True : Py_False;
648 break;
649 case Py_NE:
650 res = (v != w) ? Py_True : Py_False;
651 break;
652 default:
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000653 /* XXX Special-case None so it doesn't show as NoneType() */
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000654 PyErr_Format(PyExc_TypeError,
655 "unorderable types: %.100s() %s %.100s()",
656 v->ob_type->tp_name,
657 opstrings[op],
658 w->ob_type->tp_name);
659 return NULL;
660 }
Guido van Rossume797ec12001-01-17 15:24:28 +0000661 Py_INCREF(res);
662 return res;
663}
664
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000665/* Perform a rich comparison with object result. This wraps do_richcompare()
666 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000667
Guido van Rossume797ec12001-01-17 15:24:28 +0000668PyObject *
669PyObject_RichCompare(PyObject *v, PyObject *w, int op)
670{
671 PyObject *res;
672
673 assert(Py_LT <= op && op <= Py_GE);
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000674 if (v == NULL || w == NULL) {
675 if (!PyErr_Occurred())
676 PyErr_BadInternalCall();
677 return NULL;
678 }
Armin Rigo2b3eb402003-10-28 12:05:48 +0000679 if (Py_EnterRecursiveCall(" in cmp"))
680 return NULL;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000681 res = do_richcompare(v, w, op);
Armin Rigo2b3eb402003-10-28 12:05:48 +0000682 Py_LeaveRecursiveCall();
Guido van Rossume797ec12001-01-17 15:24:28 +0000683 return res;
684}
685
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000686/* Perform a rich comparison with integer result. This wraps
687 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000688int
689PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
690{
Raymond Hettinger93d44812004-03-21 17:01:44 +0000691 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000692 int ok;
693
Raymond Hettinger93d44812004-03-21 17:01:44 +0000694 res = PyObject_RichCompare(v, w, op);
Guido van Rossume797ec12001-01-17 15:24:28 +0000695 if (res == NULL)
696 return -1;
Guido van Rossum81912d42002-08-24 05:33:28 +0000697 if (PyBool_Check(res))
698 ok = (res == Py_True);
699 else
700 ok = PyObject_IsTrue(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000701 Py_DECREF(res);
702 return ok;
703}
Fred Drake13634cf2000-06-29 19:17:04 +0000704
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000705/* Turn the result of a three-way comparison into the result expected by a
706 rich comparison. */
707PyObject *
708Py_CmpToRich(int op, int cmp)
709{
710 PyObject *res;
711 int ok;
712
713 if (PyErr_Occurred())
714 return NULL;
715 switch (op) {
716 case Py_LT:
717 ok = cmp < 0;
718 break;
719 case Py_LE:
720 ok = cmp <= 0;
721 break;
722 case Py_EQ:
723 ok = cmp == 0;
724 break;
725 case Py_NE:
726 ok = cmp != 0;
727 break;
728 case Py_GT:
729 ok = cmp > 0;
730 break;
731 case Py_GE:
732 ok = cmp >= 0;
733 break;
734 default:
735 PyErr_BadArgument();
736 return NULL;
737 }
738 res = ok ? Py_True : Py_False;
739 Py_INCREF(res);
740 return res;
741}
742
Fred Drake13634cf2000-06-29 19:17:04 +0000743/* Set of hash utility functions to help maintaining the invariant that
Raymond Hettinger8183fa42004-03-21 17:35:06 +0000744 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000745
746 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
747*/
748
749long
Fred Drake100814d2000-07-09 15:48:49 +0000750_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000751{
Tim Peters39dce292000-08-15 03:34:48 +0000752 double intpart, fractpart;
753 int expo;
754 long hipart;
755 long x; /* the final hash value */
756 /* This is designed so that Python numbers of different types
757 * that compare equal hash to the same value; otherwise comparisons
758 * of mapping keys will turn out weird.
759 */
760
Tim Peters39dce292000-08-15 03:34:48 +0000761 fractpart = modf(v, &intpart);
Tim Peters39dce292000-08-15 03:34:48 +0000762 if (fractpart == 0.0) {
763 /* This must return the same hash as an equal int or long. */
764 if (intpart > LONG_MAX || -intpart > LONG_MAX) {
765 /* Convert to long and use its hash. */
766 PyObject *plong; /* converted to Python long */
767 if (Py_IS_INFINITY(intpart))
768 /* can't convert to long int -- arbitrary */
769 v = v < 0 ? -271828.0 : 314159.0;
770 plong = PyLong_FromDouble(v);
771 if (plong == NULL)
772 return -1;
773 x = PyObject_Hash(plong);
774 Py_DECREF(plong);
775 return x;
776 }
777 /* Fits in a C long == a Python int, so is its own hash. */
778 x = (long)intpart;
779 if (x == -1)
780 x = -2;
781 return x;
782 }
783 /* The fractional part is non-zero, so we don't have to worry about
784 * making this match the hash of some other type.
785 * Use frexp to get at the bits in the double.
Fred Drake13634cf2000-06-29 19:17:04 +0000786 * Since the VAX D double format has 56 mantissa bits, which is the
787 * most of any double format in use, each of these parts may have as
788 * many as (but no more than) 56 significant bits.
Tim Peters39dce292000-08-15 03:34:48 +0000789 * So, assuming sizeof(long) >= 4, each part can be broken into two
790 * longs; frexp and multiplication are used to do that.
791 * Also, since the Cray double format has 15 exponent bits, which is
792 * the most of any double format in use, shifting the exponent field
793 * left by 15 won't overflow a long (again assuming sizeof(long) >= 4).
Fred Drake13634cf2000-06-29 19:17:04 +0000794 */
Tim Peters39dce292000-08-15 03:34:48 +0000795 v = frexp(v, &expo);
796 v *= 2147483648.0; /* 2**31 */
797 hipart = (long)v; /* take the top 32 bits */
798 v = (v - (double)hipart) * 2147483648.0; /* get the next 32 bits */
799 x = hipart + (long)v + (expo << 15);
800 if (x == -1)
801 x = -2;
802 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000803}
804
805long
Fred Drake100814d2000-07-09 15:48:49 +0000806_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000807{
808#if SIZEOF_LONG >= SIZEOF_VOID_P
809 return (long)p;
810#else
811 /* convert to a Python long and hash that */
812 PyObject* longobj;
813 long x;
Tim Peters803526b2002-07-07 05:13:56 +0000814
Fred Drake13634cf2000-06-29 19:17:04 +0000815 if ((longobj = PyLong_FromVoidPtr(p)) == NULL) {
816 x = -1;
817 goto finally;
818 }
819 x = PyObject_Hash(longobj);
Tim Peters803526b2002-07-07 05:13:56 +0000820
Fred Drake13634cf2000-06-29 19:17:04 +0000821finally:
822 Py_XDECREF(longobj);
823 return x;
824#endif
825}
826
827
Guido van Rossum9bfef441993-03-29 10:43:31 +0000828long
Fred Drake100814d2000-07-09 15:48:49 +0000829PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000830{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000831 PyTypeObject *tp = v->ob_type;
Guido van Rossum9bfef441993-03-29 10:43:31 +0000832 if (tp->tp_hash != NULL)
833 return (*tp->tp_hash)(v);
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000834 /* Otherwise, the object can't be hashed */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000835 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
836 v->ob_type->tp_name);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000837 return -1;
838}
839
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000840PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000841PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000842{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000843 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000844
Tim Peters6d6c1a32001-08-02 04:15:00 +0000845 if (v->ob_type->tp_getattr != NULL)
Martin v. Löwis15e62742006-02-27 16:46:16 +0000846 return (*v->ob_type->tp_getattr)(v, (char*)name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000847 w = PyString_InternFromString(name);
848 if (w == NULL)
849 return NULL;
850 res = PyObject_GetAttr(v, w);
851 Py_XDECREF(w);
852 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000853}
854
855int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000856PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000857{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000858 PyObject *res = PyObject_GetAttrString(v, name);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000859 if (res != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000860 Py_DECREF(res);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000861 return 1;
862 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000863 PyErr_Clear();
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000864 return 0;
865}
866
867int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000868PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000869{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000870 PyObject *s;
871 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000872
Tim Peters6d6c1a32001-08-02 04:15:00 +0000873 if (v->ob_type->tp_setattr != NULL)
Martin v. Löwis15e62742006-02-27 16:46:16 +0000874 return (*v->ob_type->tp_setattr)(v, (char*)name, w);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000875 s = PyString_InternFromString(name);
876 if (s == NULL)
877 return -1;
878 res = PyObject_SetAttr(v, s, w);
879 Py_XDECREF(s);
880 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000881}
882
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000883PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000884PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000885{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000886 PyTypeObject *tp = v->ob_type;
887
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000888 if (!PyString_Check(name)) {
Martin v. Löwis0c160a02002-03-15 13:40:30 +0000889 /* The Unicode to string conversion is done here because the
890 existing tp_getattro slots expect a string object as name
891 and we wouldn't want to break those. */
892 if (PyUnicode_Check(name)) {
893 name = _PyUnicode_AsDefaultEncodedString(name, NULL);
894 if (name == NULL)
895 return NULL;
896 }
897 else
Martin v. Löwis0c160a02002-03-15 13:40:30 +0000898 {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000899 PyErr_Format(PyExc_TypeError,
900 "attribute name must be string, not '%.200s'",
901 name->ob_type->tp_name);
Martin v. Löwis0c160a02002-03-15 13:40:30 +0000902 return NULL;
903 }
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000904 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000905 if (tp->tp_getattro != NULL)
906 return (*tp->tp_getattro)(v, name);
907 if (tp->tp_getattr != NULL)
908 return (*tp->tp_getattr)(v, PyString_AS_STRING(name));
909 PyErr_Format(PyExc_AttributeError,
910 "'%.50s' object has no attribute '%.400s'",
911 tp->tp_name, PyString_AS_STRING(name));
912 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000913}
914
915int
Fred Drake100814d2000-07-09 15:48:49 +0000916PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000917{
918 PyObject *res = PyObject_GetAttr(v, name);
919 if (res != NULL) {
920 Py_DECREF(res);
921 return 1;
922 }
923 PyErr_Clear();
924 return 0;
925}
926
927int
Fred Drake100814d2000-07-09 15:48:49 +0000928PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000929{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000930 PyTypeObject *tp = v->ob_type;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000931 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000932
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000933 if (!PyString_Check(name)) {
Martin v. Löwis0c160a02002-03-15 13:40:30 +0000934 /* The Unicode to string conversion is done here because the
935 existing tp_setattro slots expect a string object as name
936 and we wouldn't want to break those. */
937 if (PyUnicode_Check(name)) {
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000938 name = _PyUnicode_AsDefaultEncodedString(name, NULL);
Martin v. Löwis0c160a02002-03-15 13:40:30 +0000939 if (name == NULL)
940 return -1;
941 }
Tim Peters803526b2002-07-07 05:13:56 +0000942 else
Martin v. Löwis0c160a02002-03-15 13:40:30 +0000943 {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000944 PyErr_Format(PyExc_TypeError,
945 "attribute name must be string, not '%.200s'",
946 name->ob_type->tp_name);
Martin v. Löwis0c160a02002-03-15 13:40:30 +0000947 return -1;
948 }
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000949 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000950 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000951
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);
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000964 assert(name->ob_refcnt >= 1);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000965 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
966 PyErr_Format(PyExc_TypeError,
967 "'%.100s' object has no attributes "
968 "(%s .%.100s)",
969 tp->tp_name,
970 value==NULL ? "del" : "assign to",
971 PyString_AS_STRING(name));
972 else
973 PyErr_Format(PyExc_TypeError,
974 "'%.100s' object has only read-only attributes "
975 "(%s .%.100s)",
976 tp->tp_name,
977 value==NULL ? "del" : "assign to",
978 PyString_AS_STRING(name));
979 return -1;
980}
981
982/* Helper to get a pointer to an object's __dict__ slot, if any */
983
984PyObject **
985_PyObject_GetDictPtr(PyObject *obj)
986{
Martin v. Löwis725507b2006-03-07 12:08:51 +0000987 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000988 PyTypeObject *tp = obj->ob_type;
989
Tim Peters6d6c1a32001-08-02 04:15:00 +0000990 dictoffset = tp->tp_dictoffset;
991 if (dictoffset == 0)
992 return NULL;
993 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000994 Py_ssize_t tsize;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000995 size_t size;
996
997 tsize = ((PyVarObject *)obj)->ob_size;
998 if (tsize < 0)
999 tsize = -tsize;
1000 size = _PyObject_VAR_SIZE(tp, tsize);
1001
Tim Peters6d483d32001-10-06 21:27:34 +00001002 dictoffset += (long)size;
1003 assert(dictoffset > 0);
1004 assert(dictoffset % SIZEOF_VOID_P == 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001005 }
1006 return (PyObject **) ((char *)obj + dictoffset);
1007}
1008
Tim Peters6d6c1a32001-08-02 04:15:00 +00001009PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +00001010PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +00001011{
1012 Py_INCREF(obj);
1013 return obj;
1014}
1015
Michael W. Hudson1593f502004-09-14 17:09:47 +00001016/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
1017
Raymond Hettinger01538262003-03-17 08:24:35 +00001018PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001019PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
1020{
1021 PyTypeObject *tp = obj->ob_type;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001022 PyObject *descr = NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001023 PyObject *res = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001024 descrgetfunc f;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001025 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001026 PyObject **dictptr;
1027
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001028 if (!PyString_Check(name)){
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001029 /* The Unicode to string conversion is done here because the
1030 existing tp_setattro slots expect a string object as name
1031 and we wouldn't want to break those. */
1032 if (PyUnicode_Check(name)) {
1033 name = PyUnicode_AsEncodedString(name, NULL, NULL);
1034 if (name == NULL)
1035 return NULL;
1036 }
Tim Peters803526b2002-07-07 05:13:56 +00001037 else
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001038 {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001039 PyErr_Format(PyExc_TypeError,
1040 "attribute name must be string, not '%.200s'",
1041 name->ob_type->tp_name);
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001042 return NULL;
1043 }
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001044 }
1045 else
1046 Py_INCREF(name);
1047
Tim Peters6d6c1a32001-08-02 04:15:00 +00001048 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001049 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001050 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001051 }
1052
Guido van Rossum056fbf42002-08-19 19:22:50 +00001053 /* Inline _PyType_Lookup */
1054 {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001055 Py_ssize_t i, n;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001056 PyObject *mro, *base, *dict;
1057
1058 /* Look in tp_dict of types in MRO */
1059 mro = tp->tp_mro;
1060 assert(mro != NULL);
1061 assert(PyTuple_Check(mro));
1062 n = PyTuple_GET_SIZE(mro);
1063 for (i = 0; i < n; i++) {
1064 base = PyTuple_GET_ITEM(mro, i);
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001065 assert(PyType_Check(base));
1066 dict = ((PyTypeObject *)base)->tp_dict;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001067 assert(dict && PyDict_Check(dict));
1068 descr = PyDict_GetItem(dict, name);
1069 if (descr != NULL)
1070 break;
1071 }
1072 }
1073
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001074 Py_XINCREF(descr);
1075
Tim Peters6d6c1a32001-08-02 04:15:00 +00001076 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001077 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001078 f = descr->ob_type->tp_descr_get;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001079 if (f != NULL && PyDescr_IsData(descr)) {
1080 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001081 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001082 goto done;
1083 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001084 }
1085
Guido van Rossumc66ff442002-08-19 16:50:48 +00001086 /* Inline _PyObject_GetDictPtr */
1087 dictoffset = tp->tp_dictoffset;
1088 if (dictoffset != 0) {
1089 PyObject *dict;
1090 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001091 Py_ssize_t tsize;
Guido van Rossumc66ff442002-08-19 16:50:48 +00001092 size_t size;
1093
1094 tsize = ((PyVarObject *)obj)->ob_size;
1095 if (tsize < 0)
1096 tsize = -tsize;
1097 size = _PyObject_VAR_SIZE(tp, tsize);
1098
1099 dictoffset += (long)size;
1100 assert(dictoffset > 0);
1101 assert(dictoffset % SIZEOF_VOID_P == 0);
1102 }
1103 dictptr = (PyObject **) ((char *)obj + dictoffset);
1104 dict = *dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001105 if (dict != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001106 res = PyDict_GetItem(dict, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001107 if (res != NULL) {
1108 Py_INCREF(res);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001109 Py_XDECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001110 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001111 }
1112 }
1113 }
1114
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001115 if (f != NULL) {
1116 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001117 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001118 goto done;
1119 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001120
1121 if (descr != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001122 res = descr;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001123 /* descr was already increfed above */
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001124 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001125 }
1126
1127 PyErr_Format(PyExc_AttributeError,
1128 "'%.50s' object has no attribute '%.400s'",
1129 tp->tp_name, PyString_AS_STRING(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001130 done:
1131 Py_DECREF(name);
1132 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001133}
1134
1135int
1136PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1137{
1138 PyTypeObject *tp = obj->ob_type;
1139 PyObject *descr;
1140 descrsetfunc f;
1141 PyObject **dictptr;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001142 int res = -1;
1143
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001144 if (!PyString_Check(name)){
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001145 /* The Unicode to string conversion is done here because the
1146 existing tp_setattro slots expect a string object as name
1147 and we wouldn't want to break those. */
1148 if (PyUnicode_Check(name)) {
1149 name = PyUnicode_AsEncodedString(name, NULL, NULL);
1150 if (name == NULL)
1151 return -1;
1152 }
Tim Peters803526b2002-07-07 05:13:56 +00001153 else
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001154 {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001155 PyErr_Format(PyExc_TypeError,
1156 "attribute name must be string, not '%.200s'",
1157 name->ob_type->tp_name);
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001158 return -1;
1159 }
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001160 }
1161 else
1162 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001163
1164 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001165 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001166 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001167 }
1168
1169 descr = _PyType_Lookup(tp, name);
1170 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001171 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001172 f = descr->ob_type->tp_descr_set;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001173 if (f != NULL && PyDescr_IsData(descr)) {
1174 res = f(descr, obj, value);
1175 goto done;
1176 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001177 }
1178
1179 dictptr = _PyObject_GetDictPtr(obj);
1180 if (dictptr != NULL) {
1181 PyObject *dict = *dictptr;
1182 if (dict == NULL && value != NULL) {
1183 dict = PyDict_New();
1184 if (dict == NULL)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001185 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001186 *dictptr = dict;
1187 }
1188 if (dict != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001189 if (value == NULL)
1190 res = PyDict_DelItem(dict, name);
1191 else
1192 res = PyDict_SetItem(dict, name, value);
1193 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1194 PyErr_SetObject(PyExc_AttributeError, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001195 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001196 }
1197 }
1198
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001199 if (f != NULL) {
1200 res = f(descr, obj, value);
1201 goto done;
1202 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001203
1204 if (descr == NULL) {
1205 PyErr_Format(PyExc_AttributeError,
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001206 "'%.100s' object has no attribute '%.200s'",
Tim Peters6d6c1a32001-08-02 04:15:00 +00001207 tp->tp_name, PyString_AS_STRING(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001208 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001209 }
1210
1211 PyErr_Format(PyExc_AttributeError,
1212 "'%.50s' object attribute '%.400s' is read-only",
1213 tp->tp_name, PyString_AS_STRING(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001214 done:
1215 Py_DECREF(name);
1216 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001217}
1218
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001219/* Test a value used as condition, e.g., in a for or if statement.
1220 Return -1 if an error occurred */
1221
1222int
Fred Drake100814d2000-07-09 15:48:49 +00001223PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001224{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001225 Py_ssize_t res;
Guido van Rossum6248f442002-08-24 06:31:34 +00001226 if (v == Py_True)
1227 return 1;
1228 if (v == Py_False)
1229 return 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001230 if (v == Py_None)
Neal Norwitz51290d32002-06-13 21:32:44 +00001231 return 0;
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001232 else if (v->ob_type->tp_as_number != NULL &&
Jack Diederich4dafcc42006-11-28 19:15:13 +00001233 v->ob_type->tp_as_number->nb_bool != NULL)
1234 res = (*v->ob_type->tp_as_number->nb_bool)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001235 else if (v->ob_type->tp_as_mapping != NULL &&
1236 v->ob_type->tp_as_mapping->mp_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001237 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001238 else if (v->ob_type->tp_as_sequence != NULL &&
1239 v->ob_type->tp_as_sequence->sq_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001240 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1241 else
Neal Norwitz51290d32002-06-13 21:32:44 +00001242 return 1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001243 /* if it is negative, it should be either -1 or -2 */
1244 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001245}
1246
Tim Peters803526b2002-07-07 05:13:56 +00001247/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001248 Return -1 if an error occurred */
1249
1250int
Fred Drake100814d2000-07-09 15:48:49 +00001251PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001252{
1253 int res;
1254 res = PyObject_IsTrue(v);
1255 if (res < 0)
1256 return res;
1257 return res == 0;
1258}
1259
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001260/* Test whether an object can be called */
1261
1262int
Fred Drake100814d2000-07-09 15:48:49 +00001263PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001264{
1265 if (x == NULL)
1266 return 0;
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001267 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001268}
1269
Georg Brandle32b4222007-03-10 22:13:27 +00001270/* ------------------------- PyObject_Dir() helpers ------------------------- */
1271
Tim Peters7eea37e2001-09-04 22:08:56 +00001272/* Helper for PyObject_Dir.
1273 Merge the __dict__ of aclass into dict, and recursively also all
1274 the __dict__s of aclass's base classes. The order of merging isn't
1275 defined, as it's expected that only the final set of dict keys is
1276 interesting.
1277 Return 0 on success, -1 on error.
1278*/
1279
1280static int
1281merge_class_dict(PyObject* dict, PyObject* aclass)
1282{
1283 PyObject *classdict;
1284 PyObject *bases;
1285
1286 assert(PyDict_Check(dict));
1287 assert(aclass);
1288
1289 /* Merge in the type's dict (if any). */
1290 classdict = PyObject_GetAttrString(aclass, "__dict__");
1291 if (classdict == NULL)
1292 PyErr_Clear();
1293 else {
1294 int status = PyDict_Update(dict, classdict);
1295 Py_DECREF(classdict);
1296 if (status < 0)
1297 return -1;
1298 }
1299
1300 /* Recursively merge in the base types' (if any) dicts. */
1301 bases = PyObject_GetAttrString(aclass, "__bases__");
Tim Petersbc7e8632001-09-16 20:33:22 +00001302 if (bases == NULL)
1303 PyErr_Clear();
1304 else {
Guido van Rossum44022412002-05-13 18:29:46 +00001305 /* We have no guarantee that bases is a real tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001306 Py_ssize_t i, n;
Guido van Rossum44022412002-05-13 18:29:46 +00001307 n = PySequence_Size(bases); /* This better be right */
1308 if (n < 0)
1309 PyErr_Clear();
1310 else {
1311 for (i = 0; i < n; i++) {
Tim Peters18e70832003-02-05 19:35:19 +00001312 int status;
Guido van Rossum44022412002-05-13 18:29:46 +00001313 PyObject *base = PySequence_GetItem(bases, i);
1314 if (base == NULL) {
1315 Py_DECREF(bases);
1316 return -1;
1317 }
Tim Peters18e70832003-02-05 19:35:19 +00001318 status = merge_class_dict(dict, base);
1319 Py_DECREF(base);
1320 if (status < 0) {
Guido van Rossum44022412002-05-13 18:29:46 +00001321 Py_DECREF(bases);
1322 return -1;
1323 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001324 }
1325 }
1326 Py_DECREF(bases);
1327 }
1328 return 0;
1329}
1330
Georg Brandle32b4222007-03-10 22:13:27 +00001331/* Helper for PyObject_Dir without arguments: returns the local scope. */
1332static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001333_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001334{
Georg Brandled3b8382007-03-12 13:15:14 +00001335 PyObject *names;
Georg Brandle32b4222007-03-10 22:13:27 +00001336 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001337
Georg Brandle32b4222007-03-10 22:13:27 +00001338 if (locals == NULL) {
1339 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1340 return NULL;
Tim Peters305b5852001-09-17 02:38:46 +00001341 }
1342
Georg Brandled3b8382007-03-12 13:15:14 +00001343 names = PyMapping_Keys(locals);
1344 if (!names)
1345 return NULL;
1346 if (!PyList_Check(names)) {
1347 PyErr_Format(PyExc_TypeError,
1348 "dir(): expected keys() of locals to be a list, "
1349 "not '%.200s'", names->ob_type->tp_name);
1350 Py_DECREF(names);
1351 return NULL;
1352 }
Georg Brandle32b4222007-03-10 22:13:27 +00001353 /* the locals don't need to be DECREF'd */
Georg Brandled3b8382007-03-12 13:15:14 +00001354 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001355}
1356
1357/* Helper for PyObject_Dir of type objects: returns __dict__ and __bases__.
1358 We deliberately don't suck up its __class__, as methods belonging to the
1359 metaclass would probably be more confusing than helpful.
1360*/
1361static PyObject *
1362_specialized_dir_type(PyObject *obj)
1363{
1364 PyObject *result = NULL;
1365 PyObject *dict = PyDict_New();
1366
1367 if (dict != NULL && merge_class_dict(dict, obj) == 0)
1368 result = PyDict_Keys(dict);
1369
1370 Py_XDECREF(dict);
Tim Peters305b5852001-09-17 02:38:46 +00001371 return result;
1372}
1373
Georg Brandle32b4222007-03-10 22:13:27 +00001374/* Helper for PyObject_Dir of module objects: returns the module's __dict__. */
1375static PyObject *
1376_specialized_dir_module(PyObject *obj)
Tim Peters7eea37e2001-09-04 22:08:56 +00001377{
Georg Brandle32b4222007-03-10 22:13:27 +00001378 PyObject *result = NULL;
1379 PyObject *dict = PyObject_GetAttrString(obj, "__dict__");
Tim Peters7eea37e2001-09-04 22:08:56 +00001380
Georg Brandle32b4222007-03-10 22:13:27 +00001381 if (dict != NULL) {
1382 if (PyDict_Check(dict))
1383 result = PyDict_Keys(dict);
1384 else {
1385 PyErr_Format(PyExc_TypeError,
1386 "%.200s.__dict__ is not a dictionary",
1387 PyModule_GetName(obj));
Guido van Rossum8dbd3d82001-09-10 18:27:43 +00001388 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001389 }
1390
Georg Brandle32b4222007-03-10 22:13:27 +00001391 Py_XDECREF(dict);
1392 return result;
1393}
Tim Peters7eea37e2001-09-04 22:08:56 +00001394
Georg Brandle32b4222007-03-10 22:13:27 +00001395/* Helper for PyObject_Dir of generic objects: returns __dict__, __class__,
1396 and recursively up the __class__.__bases__ chain.
1397*/
1398static PyObject *
1399_generic_dir(PyObject *obj)
1400{
1401 PyObject *result = NULL;
1402 PyObject *dict = NULL;
1403 PyObject *itsclass = NULL;
1404
1405 /* Get __dict__ (which may or may not be a real dict...) */
1406 dict = PyObject_GetAttrString(obj, "__dict__");
1407 if (dict == NULL) {
1408 PyErr_Clear();
1409 dict = PyDict_New();
1410 }
1411 else if (!PyDict_Check(dict)) {
1412 Py_DECREF(dict);
1413 dict = PyDict_New();
1414 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001415 else {
Georg Brandle32b4222007-03-10 22:13:27 +00001416 /* Copy __dict__ to avoid mutating it. */
1417 PyObject *temp = PyDict_Copy(dict);
1418 Py_DECREF(dict);
1419 dict = temp;
Tim Peters7eea37e2001-09-04 22:08:56 +00001420 }
1421
Georg Brandle32b4222007-03-10 22:13:27 +00001422 if (dict == NULL)
Raymond Hettinger2a7dede2004-08-07 04:55:30 +00001423 goto error;
Tim Peters7eea37e2001-09-04 22:08:56 +00001424
Georg Brandle32b4222007-03-10 22:13:27 +00001425 /* Merge in attrs reachable from its class. */
1426 itsclass = PyObject_GetAttrString(obj, "__class__");
1427 if (itsclass == NULL)
1428 /* XXX(tomer): Perhaps fall back to obj->ob_type if no
1429 __class__ exists? */
1430 PyErr_Clear();
1431 else {
1432 if (merge_class_dict(dict, itsclass) != 0)
1433 goto error;
1434 }
1435
1436 result = PyDict_Keys(dict);
Tim Peters7eea37e2001-09-04 22:08:56 +00001437 /* fall through */
Georg Brandle32b4222007-03-10 22:13:27 +00001438error:
1439 Py_XDECREF(itsclass);
1440 Py_XDECREF(dict);
1441 return result;
1442}
1443
1444/* Helper for PyObject_Dir: object introspection.
1445 This calls one of the above specialized versions if no __dir__ method
1446 exists. */
1447static PyObject *
1448_dir_object(PyObject *obj)
1449{
1450 PyObject * result = NULL;
1451 PyObject * dirfunc = PyObject_GetAttrString((PyObject*)obj->ob_type,
1452 "__dir__");
1453
1454 assert(obj);
1455 if (dirfunc == NULL) {
1456 /* use default implementation */
1457 PyErr_Clear();
1458 if (PyModule_Check(obj))
1459 result = _specialized_dir_module(obj);
1460 else if (PyType_Check(obj))
1461 result = _specialized_dir_type(obj);
1462 else
1463 result = _generic_dir(obj);
1464 }
1465 else {
1466 /* use __dir__ */
1467 result = PyObject_CallFunctionObjArgs(dirfunc, obj, NULL);
1468 Py_DECREF(dirfunc);
1469 if (result == NULL)
1470 return NULL;
1471
1472 /* result must be a list */
1473 /* XXX(gbrandl): could also check if all items are strings */
1474 if (!PyList_Check(result)) {
1475 PyErr_Format(PyExc_TypeError,
1476 "__dir__() must return a list, not %.200s",
1477 result->ob_type->tp_name);
1478 Py_DECREF(result);
1479 result = NULL;
1480 }
1481 }
1482
1483 return result;
1484}
1485
1486/* Implementation of dir() -- if obj is NULL, returns the names in the current
1487 (local) scope. Otherwise, performs introspection of the object: returns a
1488 sorted list of attribute names (supposedly) accessible from the object
1489*/
1490PyObject *
1491PyObject_Dir(PyObject *obj)
1492{
1493 PyObject * result;
1494
1495 if (obj == NULL)
1496 /* no object -- introspect the locals */
1497 result = _dir_locals();
1498 else
1499 /* object -- introspect the object */
1500 result = _dir_object(obj);
1501
1502 assert(result == NULL || PyList_Check(result));
1503
1504 if (result != NULL && PyList_Sort(result) != 0) {
1505 /* sorting the list failed */
1506 Py_DECREF(result);
1507 result = NULL;
1508 }
1509
Tim Peters7eea37e2001-09-04 22:08:56 +00001510 return result;
1511}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001512
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001513/*
1514NoObject is usable as a non-NULL undefined value, used by the macro None.
1515There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001516so there is exactly one (which is indestructible, by the way).
Guido van Rossumba21a492001-08-16 08:17:26 +00001517(XXX This type and the type of NotImplemented below should be unified.)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001518*/
1519
Guido van Rossum0c182a11992-03-27 17:26:13 +00001520/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001521static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001522none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001523{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001524 return PyString_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001525}
1526
Barry Warsaw9bf16442001-01-23 16:24:35 +00001527/* ARGUSED */
1528static void
Tim Peters803526b2002-07-07 05:13:56 +00001529none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001530{
1531 /* This should never get called, but we also don't want to SEGV if
1532 * we accidently decref None out of existance.
1533 */
Martin v. Löwis3f19b102002-08-07 16:21:51 +00001534 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001535}
1536
1537
Guido van Rossumba21a492001-08-16 08:17:26 +00001538static PyTypeObject PyNone_Type = {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001539 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001540 0,
Guido van Rossumba21a492001-08-16 08:17:26 +00001541 "NoneType",
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001542 0,
1543 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001544 none_dealloc, /*tp_dealloc*/ /*never called*/
Guido van Rossum7066dd71992-09-17 17:54:56 +00001545 0, /*tp_print*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001546 0, /*tp_getattr*/
1547 0, /*tp_setattr*/
1548 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001549 none_repr, /*tp_repr*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001550 0, /*tp_as_number*/
1551 0, /*tp_as_sequence*/
1552 0, /*tp_as_mapping*/
Guido van Rossum9bfef441993-03-29 10:43:31 +00001553 0, /*tp_hash */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001554};
1555
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001556PyObject _Py_NoneStruct = {
Guido van Rossumba21a492001-08-16 08:17:26 +00001557 PyObject_HEAD_INIT(&PyNone_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001558};
1559
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001560/* NotImplemented is an object that can be used to signal that an
1561 operation is not implemented for the given type combination. */
1562
1563static PyObject *
1564NotImplemented_repr(PyObject *op)
1565{
1566 return PyString_FromString("NotImplemented");
1567}
1568
1569static PyTypeObject PyNotImplemented_Type = {
1570 PyObject_HEAD_INIT(&PyType_Type)
1571 0,
Guido van Rossumba21a492001-08-16 08:17:26 +00001572 "NotImplementedType",
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001573 0,
1574 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001575 none_dealloc, /*tp_dealloc*/ /*never called*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001576 0, /*tp_print*/
1577 0, /*tp_getattr*/
1578 0, /*tp_setattr*/
1579 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001580 NotImplemented_repr, /*tp_repr*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001581 0, /*tp_as_number*/
1582 0, /*tp_as_sequence*/
1583 0, /*tp_as_mapping*/
1584 0, /*tp_hash */
1585};
1586
1587PyObject _Py_NotImplementedStruct = {
1588 PyObject_HEAD_INIT(&PyNotImplemented_Type)
1589};
1590
Guido van Rossumba21a492001-08-16 08:17:26 +00001591void
1592_Py_ReadyTypes(void)
1593{
1594 if (PyType_Ready(&PyType_Type) < 0)
1595 Py_FatalError("Can't initialize 'type'");
1596
Fred Drake0a4dd392004-07-02 18:57:45 +00001597 if (PyType_Ready(&_PyWeakref_RefType) < 0)
1598 Py_FatalError("Can't initialize 'weakref'");
1599
Guido van Rossum77f6a652002-04-03 22:41:51 +00001600 if (PyType_Ready(&PyBool_Type) < 0)
1601 Py_FatalError("Can't initialize 'bool'");
1602
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001603 if (PyType_Ready(&PyBytes_Type) < 0)
1604 Py_FatalError("Can't initialize 'bytes'");
1605
Guido van Rossumcacfc072002-05-24 19:01:59 +00001606 if (PyType_Ready(&PyString_Type) < 0)
1607 Py_FatalError("Can't initialize 'str'");
1608
Guido van Rossumba21a492001-08-16 08:17:26 +00001609 if (PyType_Ready(&PyList_Type) < 0)
1610 Py_FatalError("Can't initialize 'list'");
1611
1612 if (PyType_Ready(&PyNone_Type) < 0)
1613 Py_FatalError("Can't initialize type(None)");
1614
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001615 if (PyType_Ready(Py_Ellipsis->ob_type) < 0)
1616 Py_FatalError("Can't initialize type(Ellipsis)");
1617
Guido van Rossumba21a492001-08-16 08:17:26 +00001618 if (PyType_Ready(&PyNotImplemented_Type) < 0)
1619 Py_FatalError("Can't initialize type(NotImplemented)");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001620
1621 if (PyType_Ready(&PyCode_Type) < 0)
1622 Py_FatalError("Can't initialize 'code'");
Guido van Rossumba21a492001-08-16 08:17:26 +00001623}
1624
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001625
Guido van Rossum84a90321996-05-22 16:34:47 +00001626#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001627
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001628void
Fred Drake100814d2000-07-09 15:48:49 +00001629_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001630{
Tim Peters34592512002-07-11 06:23:50 +00001631 _Py_INC_REFTOTAL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001632 op->ob_refcnt = 1;
Tim Peters7571a0f2003-03-23 17:52:28 +00001633 _Py_AddToAllObjects(op, 1);
Tim Peters34592512002-07-11 06:23:50 +00001634 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001635}
1636
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001637void
Fred Drake100814d2000-07-09 15:48:49 +00001638_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001639{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001640#ifdef SLOW_UNREF_CHECK
Guido van Rossum4c08d552000-03-10 22:55:18 +00001641 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001642#endif
Guido van Rossumd7047b31995-01-02 19:07:15 +00001643 if (op->ob_refcnt < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001644 Py_FatalError("UNREF negative refcnt");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001645 if (op == &refchain ||
Guido van Rossumd7047b31995-01-02 19:07:15 +00001646 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001647 Py_FatalError("UNREF invalid object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001648#ifdef SLOW_UNREF_CHECK
Guido van Rossum3f5da241990-12-20 15:06:42 +00001649 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1650 if (p == op)
1651 break;
1652 }
Guido van Rossumd7047b31995-01-02 19:07:15 +00001653 if (p == &refchain) /* Not found */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001654 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001655#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001656 op->_ob_next->_ob_prev = op->_ob_prev;
1657 op->_ob_prev->_ob_next = op->_ob_next;
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001658 op->_ob_next = op->_ob_prev = NULL;
Tim Peters34592512002-07-11 06:23:50 +00001659 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001660}
1661
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001662void
Fred Drake100814d2000-07-09 15:48:49 +00001663_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001664{
Guido van Rossum9776adf1994-09-07 14:36:45 +00001665 destructor dealloc = op->ob_type->tp_dealloc;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001666 _Py_ForgetReference(op);
Guido van Rossum9776adf1994-09-07 14:36:45 +00001667 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001668}
1669
Tim Peters269b2a62003-04-17 19:52:29 +00001670/* Print all live objects. Because PyObject_Print is called, the
1671 * interpreter must be in a healthy state.
1672 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001673void
Fred Drake100814d2000-07-09 15:48:49 +00001674_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001675{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001676 PyObject *op;
Guido van Rossume09fb551997-08-05 02:04:34 +00001677 fprintf(fp, "Remaining objects:\n");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001678 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001679 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001680 if (PyObject_Print(op, fp, 0) != 0)
1681 PyErr_Clear();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001682 putc('\n', fp);
1683 }
1684}
1685
Tim Peters269b2a62003-04-17 19:52:29 +00001686/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1687 * doesn't make any calls to the Python C API, so is always safe to call.
1688 */
1689void
1690_Py_PrintReferenceAddresses(FILE *fp)
1691{
1692 PyObject *op;
1693 fprintf(fp, "Remaining object addresses:\n");
1694 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001695 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
1696 op->ob_refcnt, op->ob_type->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001697}
1698
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001699PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001700_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001701{
1702 int i, n;
1703 PyObject *t = NULL;
1704 PyObject *res, *op;
1705
1706 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1707 return NULL;
1708 op = refchain._ob_next;
1709 res = PyList_New(0);
1710 if (res == NULL)
1711 return NULL;
1712 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1713 while (op == self || op == args || op == res || op == t ||
Guido van Rossum3c296022001-07-14 17:58:00 +00001714 (t != NULL && op->ob_type != (PyTypeObject *) t)) {
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001715 op = op->_ob_next;
1716 if (op == &refchain)
1717 return res;
1718 }
1719 if (PyList_Append(res, op) < 0) {
1720 Py_DECREF(res);
1721 return NULL;
1722 }
1723 op = op->_ob_next;
1724 }
1725 return res;
1726}
1727
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001728#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001729
1730
1731/* Hack to force loading of cobject.o */
Guido van Rossumda9c2711996-12-05 21:58:58 +00001732PyTypeObject *_Py_cobject_hack = &PyCObject_Type;
Guido van Rossum84a90321996-05-22 16:34:47 +00001733
1734
1735/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001736Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001737
1738
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001739/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001740
Thomas Wouters334fb892000-07-25 12:56:38 +00001741void *
Fred Drake100814d2000-07-09 15:48:49 +00001742PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001743{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001744 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001745}
1746
Thomas Wouters334fb892000-07-25 12:56:38 +00001747void *
1748PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001749{
Tim Petersaf3e8de2002-04-12 07:22:56 +00001750 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001751}
1752
1753void
Thomas Wouters334fb892000-07-25 12:56:38 +00001754PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001755{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001756 PyMem_FREE(p);
1757}
1758
1759
Guido van Rossum86610361998-04-10 22:32:46 +00001760/* These methods are used to control infinite recursion in repr, str, print,
1761 etc. Container objects that may recursively contain themselves,
1762 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1763 Py_ReprLeave() to avoid infinite recursion.
1764
1765 Py_ReprEnter() returns 0 the first time it is called for a particular
1766 object and 1 every time thereafter. It returns -1 if an exception
1767 occurred. Py_ReprLeave() has no return value.
1768
1769 See dictobject.c and listobject.c for examples of use.
1770*/
1771
1772#define KEY "Py_Repr"
1773
1774int
Fred Drake100814d2000-07-09 15:48:49 +00001775Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001776{
1777 PyObject *dict;
1778 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001779 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001780
1781 dict = PyThreadState_GetDict();
1782 if (dict == NULL)
Guido van Rossum0fc8f002003-04-15 15:12:39 +00001783 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001784 list = PyDict_GetItemString(dict, KEY);
1785 if (list == NULL) {
1786 list = PyList_New(0);
1787 if (list == NULL)
1788 return -1;
1789 if (PyDict_SetItemString(dict, KEY, list) < 0)
1790 return -1;
1791 Py_DECREF(list);
1792 }
1793 i = PyList_GET_SIZE(list);
1794 while (--i >= 0) {
1795 if (PyList_GET_ITEM(list, i) == obj)
1796 return 1;
1797 }
1798 PyList_Append(list, obj);
1799 return 0;
1800}
1801
1802void
Fred Drake100814d2000-07-09 15:48:49 +00001803Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001804{
1805 PyObject *dict;
1806 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001807 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001808
1809 dict = PyThreadState_GetDict();
Guido van Rossumeb909461998-04-11 15:17:34 +00001810 if (dict == NULL)
1811 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001812 list = PyDict_GetItemString(dict, KEY);
Guido van Rossumeb909461998-04-11 15:17:34 +00001813 if (list == NULL || !PyList_Check(list))
1814 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001815 i = PyList_GET_SIZE(list);
1816 /* Count backwards because we always expect obj to be list[-1] */
1817 while (--i >= 0) {
1818 if (PyList_GET_ITEM(list, i) == obj) {
1819 PyList_SetSlice(list, i, i + 1, NULL);
1820 break;
1821 }
1822 }
1823}
Guido van Rossumd724b232000-03-13 16:01:29 +00001824
Tim Peters803526b2002-07-07 05:13:56 +00001825/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001826
Tim Peters803526b2002-07-07 05:13:56 +00001827/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001828int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001829
Tim Peters803526b2002-07-07 05:13:56 +00001830/* List of objects that still need to be cleaned up, singly linked via their
1831 * gc headers' gc_prev pointers.
1832 */
1833PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001834
Tim Peters803526b2002-07-07 05:13:56 +00001835/* Add op to the _PyTrash_delete_later list. Called when the current
1836 * call-stack depth gets large. op must be a currently untracked gc'ed
1837 * object, with refcount 0. Py_DECREF must already have been called on it.
1838 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001839void
Fred Drake100814d2000-07-09 15:48:49 +00001840_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001841{
Tim Peters803526b2002-07-07 05:13:56 +00001842 assert(PyObject_IS_GC(op));
1843 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1844 assert(op->ob_refcnt == 0);
Neil Schemenauerf589c052002-03-29 03:05:54 +00001845 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
Guido van Rossume92e6102000-04-24 15:40:53 +00001846 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001847}
1848
Tim Peters803526b2002-07-07 05:13:56 +00001849/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1850 * the call-stack unwinds again.
1851 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001852void
Fred Drake100814d2000-07-09 15:48:49 +00001853_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001854{
1855 while (_PyTrash_delete_later) {
Tim Peters803526b2002-07-07 05:13:56 +00001856 PyObject *op = _PyTrash_delete_later;
1857 destructor dealloc = op->ob_type->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001858
Neil Schemenauerf589c052002-03-29 03:05:54 +00001859 _PyTrash_delete_later =
Tim Peters803526b2002-07-07 05:13:56 +00001860 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001861
Tim Peters803526b2002-07-07 05:13:56 +00001862 /* Call the deallocator directly. This used to try to
1863 * fool Py_DECREF into calling it indirectly, but
1864 * Py_DECREF was already called on this object, and in
1865 * assorted non-release builds calling Py_DECREF again ends
1866 * up distorting allocation statistics.
1867 */
1868 assert(op->ob_refcnt == 0);
Guido van Rossumd724b232000-03-13 16:01:29 +00001869 ++_PyTrash_delete_nesting;
Tim Peters803526b2002-07-07 05:13:56 +00001870 (*dealloc)(op);
Guido van Rossumd724b232000-03-13 16:01:29 +00001871 --_PyTrash_delete_nesting;
1872 }
1873}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001874
1875#ifdef __cplusplus
1876}
1877#endif