blob: a725022b9f92b0fc0c6b964a999225c132060096 [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) */
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000217 Py_Type(op) = 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;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000229 Py_Type(op) = tp;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000230 _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);
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000282 else if (Py_Type(op)->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
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000297 ret = (*Py_Type(op)->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",
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000337 Py_Type(op)==NULL ? "NULL" : Py_Type(op)->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>");
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000357 else if (Py_Type(v)->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;
Guido van Rossumc6004111993-11-05 10:22:19 +0000401 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000402 return PyString_FromString("<NULL>");
Tim Peters5a49ade2001-09-11 01:41:59 +0000403 if (PyString_CheckExact(v)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000404 Py_INCREF(v);
Guido van Rossumc6004111993-11-05 10:22:19 +0000405 return v;
406 }
Neil Schemenauercf52c072005-08-12 17:34:58 +0000407 if (PyUnicode_CheckExact(v)) {
408 Py_INCREF(v);
409 return v;
410 }
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000411 if (Py_Type(v)->tp_str == NULL)
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000412 return PyObject_Repr(v);
413
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000414 res = (*Py_Type(v)->tp_str)(v);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000415 if (res == NULL)
416 return NULL;
Guido van Rossum55b4a7b2007-07-11 09:28:11 +0000417 if (!(PyString_Check(res) || PyUnicode_Check(res))) {
Neil Schemenauercf52c072005-08-12 17:34:58 +0000418 PyErr_Format(PyExc_TypeError,
419 "__str__ returned non-string (type %.200s)",
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000420 Py_Type(res)->tp_name);
Neil Schemenauercf52c072005-08-12 17:34:58 +0000421 Py_DECREF(res);
422 return NULL;
423 }
424 return res;
425}
426
427PyObject *
428PyObject_Str(PyObject *v)
429{
430 PyObject *res = _PyObject_Str(v);
431 if (res == NULL)
432 return NULL;
Marc-André Lemburg891bc652000-07-03 09:57:53 +0000433 if (PyUnicode_Check(res)) {
434 PyObject* str;
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000435 str = _PyUnicode_AsDefaultEncodedString(res, NULL);
436 Py_XINCREF(str);
Marc-André Lemburg891bc652000-07-03 09:57:53 +0000437 Py_DECREF(res);
438 if (str)
439 res = str;
440 else
441 return NULL;
442 }
Neil Schemenauercf52c072005-08-12 17:34:58 +0000443 assert(PyString_Check(res));
Guido van Rossum4c08d552000-03-10 22:55:18 +0000444 return res;
Guido van Rossumc6004111993-11-05 10:22:19 +0000445}
446
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000447PyObject *
448PyObject_Unicode(PyObject *v)
449{
450 PyObject *res;
Brett Cannonc3647ac2005-04-26 03:45:26 +0000451 PyObject *func;
Neal Norwitz75801462006-03-14 06:02:16 +0000452 PyObject *str;
Brett Cannonc3647ac2005-04-26 03:45:26 +0000453 static PyObject *unicodestr;
Tim Peters803526b2002-07-07 05:13:56 +0000454
Walter Dörwaldb03ccc02007-05-11 17:25:52 +0000455 if (v == NULL)
456 return PyUnicode_FromString("<NULL>");
457 else if (PyUnicode_CheckExact(v)) {
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000458 Py_INCREF(v);
459 return v;
460 }
Brett Cannonc3647ac2005-04-26 03:45:26 +0000461 /* XXX As soon as we have a tp_unicode slot, we should
462 check this before trying the __unicode__
463 method. */
464 if (unicodestr == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +0000465 unicodestr= PyUnicode_InternFromString("__unicode__");
Brett Cannonc3647ac2005-04-26 03:45:26 +0000466 if (unicodestr == NULL)
467 return NULL;
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000468 }
Brett Cannonc3647ac2005-04-26 03:45:26 +0000469 func = PyObject_GetAttr(v, unicodestr);
470 if (func != NULL) {
471 res = PyEval_CallObject(func, (PyObject *)NULL);
472 Py_DECREF(func);
473 }
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000474 else {
Brett Cannonc3647ac2005-04-26 03:45:26 +0000475 PyErr_Clear();
Guido van Rossum55b4a7b2007-07-11 09:28:11 +0000476 if (PyUnicode_Check(v) &&
477 v->ob_type->tp_str == PyUnicode_Type.tp_str) {
478 /* For a Unicode subtype that's didn't overwrite
479 __unicode__ or __str__,
Brett Cannonc3647ac2005-04-26 03:45:26 +0000480 return a true Unicode object with the same data. */
481 return PyUnicode_FromUnicode(PyUnicode_AS_UNICODE(v),
482 PyUnicode_GET_SIZE(v));
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000483 }
Brett Cannonc3647ac2005-04-26 03:45:26 +0000484 if (PyString_CheckExact(v)) {
485 Py_INCREF(v);
486 res = v;
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000487 }
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000488 else {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000489 if (Py_Type(v)->tp_str != NULL)
490 res = (*Py_Type(v)->tp_str)(v);
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000491 else
492 res = PyObject_Repr(v);
493 }
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000494 }
495 if (res == NULL)
496 return NULL;
497 if (!PyUnicode_Check(res)) {
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000498 str = PyUnicode_FromEncodedObject(res, NULL, "strict");
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000499 Py_DECREF(res);
Neal Norwitz75801462006-03-14 06:02:16 +0000500 res = str;
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000501 }
502 return res;
503}
504
505
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000506/* The new comparison philosophy is: we completely separate three-way
507 comparison from rich comparison. That is, PyObject_Compare() and
508 PyObject_Cmp() *just* use the tp_compare slot. And PyObject_RichCompare()
509 and PyObject_RichCompareBool() *just* use the tp_richcompare slot.
510
511 See (*) below for practical amendments.
512
513 IOW, only cmp() uses tp_compare; the comparison operators (==, !=, <=, <,
514 >=, >) only use tp_richcompare. Note that list.sort() only uses <.
515
516 (And yes, eventually we'll rip out cmp() and tp_compare.)
517
518 The calling conventions are different: tp_compare only gets called with two
519 objects of the appropriate type; tp_richcompare gets called with a first
520 argument of the appropriate type and a second object of an arbitrary type.
521 We never do any kind of coercion.
522
523 The return conventions are also different.
524
525 The tp_compare slot should return a C int, as follows:
526
527 -1 if a < b or if an exception occurred
528 0 if a == b
529 +1 if a > b
530
531 No other return values are allowed. PyObject_Compare() has the same
532 calling convention.
533
534 The tp_richcompare slot should return an object, as follows:
535
536 NULL if an exception occurred
537 NotImplemented if the requested comparison is not implemented
538 any other false value if the requested comparison is false
539 any other true value if the requested comparison is true
540
541 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
542 NotImplemented.
543
544 (*) Practical amendments:
545
546 - If rich comparison returns NotImplemented, == and != are decided by
547 comparing the object pointer (i.e. falling back to the base object
548 implementation).
549
550 - If three-way comparison is not implemented, it falls back on rich
551 comparison (but not the other way around!).
552
Guido van Rossuma4073002002-05-31 20:03:54 +0000553*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000554
555/* Forward */
556static PyObject *do_richcompare(PyObject *v, PyObject *w, int op);
557
558/* Perform a three-way comparison, raising TypeError if three-way comparison
559 is not supported. */
Guido van Rossuma4073002002-05-31 20:03:54 +0000560static int
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000561do_compare(PyObject *v, PyObject *w)
Guido van Rossuma4073002002-05-31 20:03:54 +0000562{
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000563 cmpfunc f;
564 int ok;
565
566 if (v->ob_type == w->ob_type &&
567 (f = v->ob_type->tp_compare) != NULL) {
568 return (*f)(v, w);
Guido van Rossuma4073002002-05-31 20:03:54 +0000569 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000570
571 /* Now try three-way compare before giving up. This is intentionally
572 elaborate; if you have a it will raise TypeError if it detects two
573 objects that aren't ordered with respect to each other. */
574 ok = PyObject_RichCompareBool(v, w, Py_LT);
575 if (ok < 0)
576 return -1; /* Error */
577 if (ok)
578 return -1; /* Less than */
579 ok = PyObject_RichCompareBool(v, w, Py_GT);
580 if (ok < 0)
581 return -1; /* Error */
582 if (ok)
583 return 1; /* Greater than */
584 ok = PyObject_RichCompareBool(v, w, Py_EQ);
585 if (ok < 0)
586 return -1; /* Error */
587 if (ok)
588 return 0; /* Equal */
589
590 /* Give up */
591 PyErr_Format(PyExc_TypeError,
Neal Norwitz3bd844e2006-08-29 04:39:12 +0000592 "unorderable types: '%.100s' != '%.100s'",
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000593 v->ob_type->tp_name,
594 w->ob_type->tp_name);
595 return -1;
Guido van Rossuma4073002002-05-31 20:03:54 +0000596}
597
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000598/* Perform a three-way comparison. This wraps do_compare() with a check for
599 NULL arguments and a recursion check. */
600int
601PyObject_Compare(PyObject *v, PyObject *w)
602{
603 int res;
Guido van Rossuma4073002002-05-31 20:03:54 +0000604
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000605 if (v == NULL || w == NULL) {
606 if (!PyErr_Occurred())
607 PyErr_BadInternalCall();
608 return -1;
609 }
610 if (Py_EnterRecursiveCall(" in cmp"))
611 return -1;
612 res = do_compare(v, w);
613 Py_LeaveRecursiveCall();
614 return res < 0 ? -1 : res;
615}
Guido van Rossumd1f06b92001-01-24 22:14:43 +0000616
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000617/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000618int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000619
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000620static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000621
622/* Perform a rich comparison, raising TypeError when the requested comparison
623 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000624static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000625do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000626{
627 richcmpfunc f;
628 PyObject *res;
629
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000630 if (v->ob_type != w->ob_type &&
631 PyType_IsSubtype(w->ob_type, v->ob_type) &&
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000632 (f = w->ob_type->tp_richcompare) != NULL) {
Tim Petersf4aca752004-09-23 02:39:37 +0000633 res = (*f)(w, v, _Py_SwappedOp[op]);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000634 if (res != Py_NotImplemented)
635 return res;
636 Py_DECREF(res);
637 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000638 if ((f = v->ob_type->tp_richcompare) != NULL) {
Guido van Rossume797ec12001-01-17 15:24:28 +0000639 res = (*f)(v, w, op);
640 if (res != Py_NotImplemented)
641 return res;
642 Py_DECREF(res);
643 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000644 if ((f = w->ob_type->tp_richcompare) != NULL) {
645 res = (*f)(w, v, _Py_SwappedOp[op]);
646 if (res != Py_NotImplemented)
647 return res;
648 Py_DECREF(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000649 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000650 /* If neither object implements it, provide a sensible default
651 for == and !=, but raise an exception for ordering. */
652 switch (op) {
653 case Py_EQ:
654 res = (v == w) ? Py_True : Py_False;
655 break;
656 case Py_NE:
657 res = (v != w) ? Py_True : Py_False;
658 break;
659 default:
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000660 /* XXX Special-case None so it doesn't show as NoneType() */
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000661 PyErr_Format(PyExc_TypeError,
662 "unorderable types: %.100s() %s %.100s()",
663 v->ob_type->tp_name,
664 opstrings[op],
665 w->ob_type->tp_name);
666 return NULL;
667 }
Guido van Rossume797ec12001-01-17 15:24:28 +0000668 Py_INCREF(res);
669 return res;
670}
671
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000672/* Perform a rich comparison with object result. This wraps do_richcompare()
673 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000674
Guido van Rossume797ec12001-01-17 15:24:28 +0000675PyObject *
676PyObject_RichCompare(PyObject *v, PyObject *w, int op)
677{
678 PyObject *res;
679
680 assert(Py_LT <= op && op <= Py_GE);
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000681 if (v == NULL || w == NULL) {
682 if (!PyErr_Occurred())
683 PyErr_BadInternalCall();
684 return NULL;
685 }
Armin Rigo2b3eb402003-10-28 12:05:48 +0000686 if (Py_EnterRecursiveCall(" in cmp"))
687 return NULL;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000688 res = do_richcompare(v, w, op);
Armin Rigo2b3eb402003-10-28 12:05:48 +0000689 Py_LeaveRecursiveCall();
Guido van Rossume797ec12001-01-17 15:24:28 +0000690 return res;
691}
692
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000693/* Perform a rich comparison with integer result. This wraps
694 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000695int
696PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
697{
Raymond Hettinger93d44812004-03-21 17:01:44 +0000698 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000699 int ok;
700
Raymond Hettinger93d44812004-03-21 17:01:44 +0000701 res = PyObject_RichCompare(v, w, op);
Guido van Rossume797ec12001-01-17 15:24:28 +0000702 if (res == NULL)
703 return -1;
Guido van Rossum81912d42002-08-24 05:33:28 +0000704 if (PyBool_Check(res))
705 ok = (res == Py_True);
706 else
707 ok = PyObject_IsTrue(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000708 Py_DECREF(res);
709 return ok;
710}
Fred Drake13634cf2000-06-29 19:17:04 +0000711
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000712/* Turn the result of a three-way comparison into the result expected by a
713 rich comparison. */
714PyObject *
715Py_CmpToRich(int op, int cmp)
716{
717 PyObject *res;
718 int ok;
719
720 if (PyErr_Occurred())
721 return NULL;
722 switch (op) {
723 case Py_LT:
724 ok = cmp < 0;
725 break;
726 case Py_LE:
727 ok = cmp <= 0;
728 break;
729 case Py_EQ:
730 ok = cmp == 0;
731 break;
732 case Py_NE:
733 ok = cmp != 0;
734 break;
735 case Py_GT:
736 ok = cmp > 0;
737 break;
738 case Py_GE:
739 ok = cmp >= 0;
740 break;
741 default:
742 PyErr_BadArgument();
743 return NULL;
744 }
745 res = ok ? Py_True : Py_False;
746 Py_INCREF(res);
747 return res;
748}
749
Fred Drake13634cf2000-06-29 19:17:04 +0000750/* Set of hash utility functions to help maintaining the invariant that
Raymond Hettinger8183fa42004-03-21 17:35:06 +0000751 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000752
753 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
754*/
755
756long
Fred Drake100814d2000-07-09 15:48:49 +0000757_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000758{
Tim Peters39dce292000-08-15 03:34:48 +0000759 double intpart, fractpart;
760 int expo;
761 long hipart;
762 long x; /* the final hash value */
763 /* This is designed so that Python numbers of different types
764 * that compare equal hash to the same value; otherwise comparisons
765 * of mapping keys will turn out weird.
766 */
767
Tim Peters39dce292000-08-15 03:34:48 +0000768 fractpart = modf(v, &intpart);
Tim Peters39dce292000-08-15 03:34:48 +0000769 if (fractpart == 0.0) {
770 /* This must return the same hash as an equal int or long. */
771 if (intpart > LONG_MAX || -intpart > LONG_MAX) {
772 /* Convert to long and use its hash. */
773 PyObject *plong; /* converted to Python long */
774 if (Py_IS_INFINITY(intpart))
775 /* can't convert to long int -- arbitrary */
776 v = v < 0 ? -271828.0 : 314159.0;
777 plong = PyLong_FromDouble(v);
778 if (plong == NULL)
779 return -1;
780 x = PyObject_Hash(plong);
781 Py_DECREF(plong);
782 return x;
783 }
784 /* Fits in a C long == a Python int, so is its own hash. */
785 x = (long)intpart;
786 if (x == -1)
787 x = -2;
788 return x;
789 }
790 /* The fractional part is non-zero, so we don't have to worry about
791 * making this match the hash of some other type.
792 * Use frexp to get at the bits in the double.
Fred Drake13634cf2000-06-29 19:17:04 +0000793 * Since the VAX D double format has 56 mantissa bits, which is the
794 * most of any double format in use, each of these parts may have as
795 * many as (but no more than) 56 significant bits.
Tim Peters39dce292000-08-15 03:34:48 +0000796 * So, assuming sizeof(long) >= 4, each part can be broken into two
797 * longs; frexp and multiplication are used to do that.
798 * Also, since the Cray double format has 15 exponent bits, which is
799 * the most of any double format in use, shifting the exponent field
800 * left by 15 won't overflow a long (again assuming sizeof(long) >= 4).
Fred Drake13634cf2000-06-29 19:17:04 +0000801 */
Tim Peters39dce292000-08-15 03:34:48 +0000802 v = frexp(v, &expo);
803 v *= 2147483648.0; /* 2**31 */
804 hipart = (long)v; /* take the top 32 bits */
805 v = (v - (double)hipart) * 2147483648.0; /* get the next 32 bits */
806 x = hipart + (long)v + (expo << 15);
807 if (x == -1)
808 x = -2;
809 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000810}
811
812long
Fred Drake100814d2000-07-09 15:48:49 +0000813_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000814{
815#if SIZEOF_LONG >= SIZEOF_VOID_P
816 return (long)p;
817#else
818 /* convert to a Python long and hash that */
819 PyObject* longobj;
820 long x;
Tim Peters803526b2002-07-07 05:13:56 +0000821
Fred Drake13634cf2000-06-29 19:17:04 +0000822 if ((longobj = PyLong_FromVoidPtr(p)) == NULL) {
823 x = -1;
824 goto finally;
825 }
826 x = PyObject_Hash(longobj);
Tim Peters803526b2002-07-07 05:13:56 +0000827
Fred Drake13634cf2000-06-29 19:17:04 +0000828finally:
829 Py_XDECREF(longobj);
830 return x;
831#endif
832}
833
834
Guido van Rossum9bfef441993-03-29 10:43:31 +0000835long
Fred Drake100814d2000-07-09 15:48:49 +0000836PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000837{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000838 PyTypeObject *tp = v->ob_type;
Guido van Rossum9bfef441993-03-29 10:43:31 +0000839 if (tp->tp_hash != NULL)
840 return (*tp->tp_hash)(v);
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000841 /* Otherwise, the object can't be hashed */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000842 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
843 v->ob_type->tp_name);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000844 return -1;
845}
846
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000847PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000848PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000849{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000850 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000851
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000852 if (Py_Type(v)->tp_getattr != NULL)
853 return (*Py_Type(v)->tp_getattr)(v, (char*)name);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000854 w = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000855 if (w == NULL)
856 return NULL;
857 res = PyObject_GetAttr(v, w);
858 Py_XDECREF(w);
859 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000860}
861
862int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000863PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000864{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000865 PyObject *res = PyObject_GetAttrString(v, name);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000866 if (res != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000867 Py_DECREF(res);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000868 return 1;
869 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000870 PyErr_Clear();
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000871 return 0;
872}
873
874int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000875PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000876{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000877 PyObject *s;
878 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000879
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000880 if (Py_Type(v)->tp_setattr != NULL)
881 return (*Py_Type(v)->tp_setattr)(v, (char*)name, w);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000882 s = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000883 if (s == NULL)
884 return -1;
885 res = PyObject_SetAttr(v, s, w);
886 Py_XDECREF(s);
887 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000888}
889
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000890PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000891PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000892{
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000893 PyTypeObject *tp = Py_Type(v);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000894
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000895 if (!PyUnicode_Check(name)) {
Martin v. Löwis5b222132007-06-10 09:51:05 +0000896 PyErr_Format(PyExc_TypeError,
897 "attribute name must be string, not '%.200s'",
898 name->ob_type->tp_name);
899 return NULL;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000900 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000901 if (tp->tp_getattro != NULL)
902 return (*tp->tp_getattro)(v, name);
903 if (tp->tp_getattr != NULL)
Martin v. Löwis5b222132007-06-10 09:51:05 +0000904 return (*tp->tp_getattr)(v, PyUnicode_AsString(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +0000905 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000906 "'%.50s' object has no attribute '%U'",
907 tp->tp_name, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000908 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000909}
910
911int
Fred Drake100814d2000-07-09 15:48:49 +0000912PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000913{
914 PyObject *res = PyObject_GetAttr(v, name);
915 if (res != NULL) {
916 Py_DECREF(res);
917 return 1;
918 }
919 PyErr_Clear();
920 return 0;
921}
922
923int
Fred Drake100814d2000-07-09 15:48:49 +0000924PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000925{
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000926 PyTypeObject *tp = Py_Type(v);
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000927 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000928
Martin v. Löwis5b222132007-06-10 09:51:05 +0000929 if (!PyUnicode_Check(name)) {
930 PyErr_Format(PyExc_TypeError,
931 "attribute name must be string, not '%.200s'",
932 name->ob_type->tp_name);
933 return -1;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000934 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000935 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000936
Martin v. Löwis5b222132007-06-10 09:51:05 +0000937 PyUnicode_InternInPlace(&name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000938 if (tp->tp_setattro != NULL) {
939 err = (*tp->tp_setattro)(v, name, value);
940 Py_DECREF(name);
941 return err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000942 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000943 if (tp->tp_setattr != NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +0000944 err = (*tp->tp_setattr)(v, PyUnicode_AsString(name), value);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000945 Py_DECREF(name);
946 return err;
947 }
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000948 Py_DECREF(name);
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000949 assert(name->ob_refcnt >= 1);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000950 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
951 PyErr_Format(PyExc_TypeError,
952 "'%.100s' object has no attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000953 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000954 tp->tp_name,
955 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000956 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000957 else
958 PyErr_Format(PyExc_TypeError,
959 "'%.100s' object has only read-only attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000960 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000961 tp->tp_name,
962 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000963 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000964 return -1;
965}
966
967/* Helper to get a pointer to an object's __dict__ slot, if any */
968
969PyObject **
970_PyObject_GetDictPtr(PyObject *obj)
971{
Martin v. Löwis725507b2006-03-07 12:08:51 +0000972 Py_ssize_t dictoffset;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000973 PyTypeObject *tp = Py_Type(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000974
Tim Peters6d6c1a32001-08-02 04:15:00 +0000975 dictoffset = tp->tp_dictoffset;
976 if (dictoffset == 0)
977 return NULL;
978 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000979 Py_ssize_t tsize;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000980 size_t size;
981
982 tsize = ((PyVarObject *)obj)->ob_size;
983 if (tsize < 0)
984 tsize = -tsize;
985 size = _PyObject_VAR_SIZE(tp, tsize);
986
Tim Peters6d483d32001-10-06 21:27:34 +0000987 dictoffset += (long)size;
988 assert(dictoffset > 0);
989 assert(dictoffset % SIZEOF_VOID_P == 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000990 }
991 return (PyObject **) ((char *)obj + dictoffset);
992}
993
Tim Peters6d6c1a32001-08-02 04:15:00 +0000994PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000995PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +0000996{
997 Py_INCREF(obj);
998 return obj;
999}
1000
Michael W. Hudson1593f502004-09-14 17:09:47 +00001001/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
1002
Raymond Hettinger01538262003-03-17 08:24:35 +00001003PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001004PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
1005{
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001006 PyTypeObject *tp = Py_Type(obj);
Guido van Rossum056fbf42002-08-19 19:22:50 +00001007 PyObject *descr = NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001008 PyObject *res = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001009 descrgetfunc f;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001010 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001011 PyObject **dictptr;
1012
Martin v. Löwis5b222132007-06-10 09:51:05 +00001013 if (!PyUnicode_Check(name)){
1014 PyErr_Format(PyExc_TypeError,
1015 "attribute name must be string, not '%.200s'",
1016 name->ob_type->tp_name);
1017 return NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001018 }
1019 else
1020 Py_INCREF(name);
1021
Tim Peters6d6c1a32001-08-02 04:15:00 +00001022 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001023 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001024 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001025 }
1026
Guido van Rossum056fbf42002-08-19 19:22:50 +00001027 /* Inline _PyType_Lookup */
1028 {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001029 Py_ssize_t i, n;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001030 PyObject *mro, *base, *dict;
1031
1032 /* Look in tp_dict of types in MRO */
1033 mro = tp->tp_mro;
1034 assert(mro != NULL);
1035 assert(PyTuple_Check(mro));
1036 n = PyTuple_GET_SIZE(mro);
1037 for (i = 0; i < n; i++) {
1038 base = PyTuple_GET_ITEM(mro, i);
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001039 assert(PyType_Check(base));
1040 dict = ((PyTypeObject *)base)->tp_dict;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001041 assert(dict && PyDict_Check(dict));
1042 descr = PyDict_GetItem(dict, name);
1043 if (descr != NULL)
1044 break;
1045 }
1046 }
1047
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001048 Py_XINCREF(descr);
1049
Tim Peters6d6c1a32001-08-02 04:15:00 +00001050 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001051 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001052 f = descr->ob_type->tp_descr_get;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001053 if (f != NULL && PyDescr_IsData(descr)) {
1054 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001055 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001056 goto done;
1057 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001058 }
1059
Guido van Rossumc66ff442002-08-19 16:50:48 +00001060 /* Inline _PyObject_GetDictPtr */
1061 dictoffset = tp->tp_dictoffset;
1062 if (dictoffset != 0) {
1063 PyObject *dict;
1064 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001065 Py_ssize_t tsize;
Guido van Rossumc66ff442002-08-19 16:50:48 +00001066 size_t size;
1067
1068 tsize = ((PyVarObject *)obj)->ob_size;
1069 if (tsize < 0)
1070 tsize = -tsize;
1071 size = _PyObject_VAR_SIZE(tp, tsize);
1072
1073 dictoffset += (long)size;
1074 assert(dictoffset > 0);
1075 assert(dictoffset % SIZEOF_VOID_P == 0);
1076 }
1077 dictptr = (PyObject **) ((char *)obj + dictoffset);
1078 dict = *dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001079 if (dict != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001080 res = PyDict_GetItem(dict, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001081 if (res != NULL) {
1082 Py_INCREF(res);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001083 Py_XDECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001084 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001085 }
1086 }
1087 }
1088
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001089 if (f != NULL) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001090 res = f(descr, obj, (PyObject *)Py_Type(obj));
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001091 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001092 goto done;
1093 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001094
1095 if (descr != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001096 res = descr;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001097 /* descr was already increfed above */
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001098 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001099 }
1100
1101 PyErr_Format(PyExc_AttributeError,
1102 "'%.50s' object has no attribute '%.400s'",
Martin v. Löwis5b222132007-06-10 09:51:05 +00001103 tp->tp_name, PyUnicode_AsString(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001104 done:
1105 Py_DECREF(name);
1106 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001107}
1108
1109int
1110PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1111{
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001112 PyTypeObject *tp = Py_Type(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001113 PyObject *descr;
1114 descrsetfunc f;
1115 PyObject **dictptr;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001116 int res = -1;
1117
Martin v. Löwis5b222132007-06-10 09:51:05 +00001118 if (!PyUnicode_Check(name)){
1119 PyErr_Format(PyExc_TypeError,
1120 "attribute name must be string, not '%.200s'",
1121 name->ob_type->tp_name);
1122 return -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001123 }
1124 else
1125 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001126
1127 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001128 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001129 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001130 }
1131
1132 descr = _PyType_Lookup(tp, name);
1133 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001134 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001135 f = descr->ob_type->tp_descr_set;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001136 if (f != NULL && PyDescr_IsData(descr)) {
1137 res = f(descr, obj, value);
1138 goto done;
1139 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001140 }
1141
1142 dictptr = _PyObject_GetDictPtr(obj);
1143 if (dictptr != NULL) {
1144 PyObject *dict = *dictptr;
1145 if (dict == NULL && value != NULL) {
1146 dict = PyDict_New();
1147 if (dict == NULL)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001148 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001149 *dictptr = dict;
1150 }
1151 if (dict != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001152 if (value == NULL)
1153 res = PyDict_DelItem(dict, name);
1154 else
1155 res = PyDict_SetItem(dict, name, value);
1156 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1157 PyErr_SetObject(PyExc_AttributeError, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001158 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001159 }
1160 }
1161
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001162 if (f != NULL) {
1163 res = f(descr, obj, value);
1164 goto done;
1165 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001166
1167 if (descr == NULL) {
1168 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001169 "'%.100s' object has no attribute '%U'",
1170 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001171 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001172 }
1173
1174 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001175 "'%.50s' object attribute '%U' is read-only",
1176 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001177 done:
1178 Py_DECREF(name);
1179 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001180}
1181
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001182/* Test a value used as condition, e.g., in a for or if statement.
1183 Return -1 if an error occurred */
1184
1185int
Fred Drake100814d2000-07-09 15:48:49 +00001186PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001187{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001188 Py_ssize_t res;
Guido van Rossum6248f442002-08-24 06:31:34 +00001189 if (v == Py_True)
1190 return 1;
1191 if (v == Py_False)
1192 return 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001193 if (v == Py_None)
Neal Norwitz51290d32002-06-13 21:32:44 +00001194 return 0;
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001195 else if (v->ob_type->tp_as_number != NULL &&
Jack Diederich4dafcc42006-11-28 19:15:13 +00001196 v->ob_type->tp_as_number->nb_bool != NULL)
1197 res = (*v->ob_type->tp_as_number->nb_bool)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001198 else if (v->ob_type->tp_as_mapping != NULL &&
1199 v->ob_type->tp_as_mapping->mp_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001200 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001201 else if (v->ob_type->tp_as_sequence != NULL &&
1202 v->ob_type->tp_as_sequence->sq_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001203 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1204 else
Neal Norwitz51290d32002-06-13 21:32:44 +00001205 return 1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001206 /* if it is negative, it should be either -1 or -2 */
1207 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001208}
1209
Tim Peters803526b2002-07-07 05:13:56 +00001210/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001211 Return -1 if an error occurred */
1212
1213int
Fred Drake100814d2000-07-09 15:48:49 +00001214PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001215{
1216 int res;
1217 res = PyObject_IsTrue(v);
1218 if (res < 0)
1219 return res;
1220 return res == 0;
1221}
1222
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001223/* Test whether an object can be called */
1224
1225int
Fred Drake100814d2000-07-09 15:48:49 +00001226PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001227{
1228 if (x == NULL)
1229 return 0;
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001230 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001231}
1232
Georg Brandle32b4222007-03-10 22:13:27 +00001233/* ------------------------- PyObject_Dir() helpers ------------------------- */
1234
Tim Peters7eea37e2001-09-04 22:08:56 +00001235/* Helper for PyObject_Dir.
1236 Merge the __dict__ of aclass into dict, and recursively also all
1237 the __dict__s of aclass's base classes. The order of merging isn't
1238 defined, as it's expected that only the final set of dict keys is
1239 interesting.
1240 Return 0 on success, -1 on error.
1241*/
1242
1243static int
1244merge_class_dict(PyObject* dict, PyObject* aclass)
1245{
1246 PyObject *classdict;
1247 PyObject *bases;
1248
1249 assert(PyDict_Check(dict));
1250 assert(aclass);
1251
1252 /* Merge in the type's dict (if any). */
1253 classdict = PyObject_GetAttrString(aclass, "__dict__");
1254 if (classdict == NULL)
1255 PyErr_Clear();
1256 else {
1257 int status = PyDict_Update(dict, classdict);
1258 Py_DECREF(classdict);
1259 if (status < 0)
1260 return -1;
1261 }
1262
1263 /* Recursively merge in the base types' (if any) dicts. */
1264 bases = PyObject_GetAttrString(aclass, "__bases__");
Tim Petersbc7e8632001-09-16 20:33:22 +00001265 if (bases == NULL)
1266 PyErr_Clear();
1267 else {
Guido van Rossum44022412002-05-13 18:29:46 +00001268 /* We have no guarantee that bases is a real tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001269 Py_ssize_t i, n;
Guido van Rossum44022412002-05-13 18:29:46 +00001270 n = PySequence_Size(bases); /* This better be right */
1271 if (n < 0)
1272 PyErr_Clear();
1273 else {
1274 for (i = 0; i < n; i++) {
Tim Peters18e70832003-02-05 19:35:19 +00001275 int status;
Guido van Rossum44022412002-05-13 18:29:46 +00001276 PyObject *base = PySequence_GetItem(bases, i);
1277 if (base == NULL) {
1278 Py_DECREF(bases);
1279 return -1;
1280 }
Tim Peters18e70832003-02-05 19:35:19 +00001281 status = merge_class_dict(dict, base);
1282 Py_DECREF(base);
1283 if (status < 0) {
Guido van Rossum44022412002-05-13 18:29:46 +00001284 Py_DECREF(bases);
1285 return -1;
1286 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001287 }
1288 }
1289 Py_DECREF(bases);
1290 }
1291 return 0;
1292}
1293
Georg Brandle32b4222007-03-10 22:13:27 +00001294/* Helper for PyObject_Dir without arguments: returns the local scope. */
1295static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001296_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001297{
Georg Brandled3b8382007-03-12 13:15:14 +00001298 PyObject *names;
Georg Brandle32b4222007-03-10 22:13:27 +00001299 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001300
Georg Brandle32b4222007-03-10 22:13:27 +00001301 if (locals == NULL) {
1302 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1303 return NULL;
Tim Peters305b5852001-09-17 02:38:46 +00001304 }
1305
Georg Brandled3b8382007-03-12 13:15:14 +00001306 names = PyMapping_Keys(locals);
1307 if (!names)
1308 return NULL;
1309 if (!PyList_Check(names)) {
1310 PyErr_Format(PyExc_TypeError,
1311 "dir(): expected keys() of locals to be a list, "
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001312 "not '%.200s'", Py_Type(names)->tp_name);
Georg Brandled3b8382007-03-12 13:15:14 +00001313 Py_DECREF(names);
1314 return NULL;
1315 }
Georg Brandle32b4222007-03-10 22:13:27 +00001316 /* the locals don't need to be DECREF'd */
Georg Brandled3b8382007-03-12 13:15:14 +00001317 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001318}
1319
1320/* Helper for PyObject_Dir of type objects: returns __dict__ and __bases__.
1321 We deliberately don't suck up its __class__, as methods belonging to the
1322 metaclass would probably be more confusing than helpful.
1323*/
1324static PyObject *
1325_specialized_dir_type(PyObject *obj)
1326{
1327 PyObject *result = NULL;
1328 PyObject *dict = PyDict_New();
1329
1330 if (dict != NULL && merge_class_dict(dict, obj) == 0)
1331 result = PyDict_Keys(dict);
1332
1333 Py_XDECREF(dict);
Tim Peters305b5852001-09-17 02:38:46 +00001334 return result;
1335}
1336
Georg Brandle32b4222007-03-10 22:13:27 +00001337/* Helper for PyObject_Dir of module objects: returns the module's __dict__. */
1338static PyObject *
1339_specialized_dir_module(PyObject *obj)
Tim Peters7eea37e2001-09-04 22:08:56 +00001340{
Georg Brandle32b4222007-03-10 22:13:27 +00001341 PyObject *result = NULL;
1342 PyObject *dict = PyObject_GetAttrString(obj, "__dict__");
Tim Peters7eea37e2001-09-04 22:08:56 +00001343
Georg Brandle32b4222007-03-10 22:13:27 +00001344 if (dict != NULL) {
1345 if (PyDict_Check(dict))
1346 result = PyDict_Keys(dict);
1347 else {
1348 PyErr_Format(PyExc_TypeError,
1349 "%.200s.__dict__ is not a dictionary",
1350 PyModule_GetName(obj));
Guido van Rossum8dbd3d82001-09-10 18:27:43 +00001351 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001352 }
1353
Georg Brandle32b4222007-03-10 22:13:27 +00001354 Py_XDECREF(dict);
1355 return result;
1356}
Tim Peters7eea37e2001-09-04 22:08:56 +00001357
Georg Brandle32b4222007-03-10 22:13:27 +00001358/* Helper for PyObject_Dir of generic objects: returns __dict__, __class__,
1359 and recursively up the __class__.__bases__ chain.
1360*/
1361static PyObject *
1362_generic_dir(PyObject *obj)
1363{
1364 PyObject *result = NULL;
1365 PyObject *dict = NULL;
1366 PyObject *itsclass = NULL;
1367
1368 /* Get __dict__ (which may or may not be a real dict...) */
1369 dict = PyObject_GetAttrString(obj, "__dict__");
1370 if (dict == NULL) {
1371 PyErr_Clear();
1372 dict = PyDict_New();
1373 }
1374 else if (!PyDict_Check(dict)) {
1375 Py_DECREF(dict);
1376 dict = PyDict_New();
1377 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001378 else {
Georg Brandle32b4222007-03-10 22:13:27 +00001379 /* Copy __dict__ to avoid mutating it. */
1380 PyObject *temp = PyDict_Copy(dict);
1381 Py_DECREF(dict);
1382 dict = temp;
Tim Peters7eea37e2001-09-04 22:08:56 +00001383 }
1384
Georg Brandle32b4222007-03-10 22:13:27 +00001385 if (dict == NULL)
Raymond Hettinger2a7dede2004-08-07 04:55:30 +00001386 goto error;
Tim Peters7eea37e2001-09-04 22:08:56 +00001387
Georg Brandle32b4222007-03-10 22:13:27 +00001388 /* Merge in attrs reachable from its class. */
1389 itsclass = PyObject_GetAttrString(obj, "__class__");
1390 if (itsclass == NULL)
1391 /* XXX(tomer): Perhaps fall back to obj->ob_type if no
1392 __class__ exists? */
1393 PyErr_Clear();
1394 else {
1395 if (merge_class_dict(dict, itsclass) != 0)
1396 goto error;
1397 }
1398
1399 result = PyDict_Keys(dict);
Tim Peters7eea37e2001-09-04 22:08:56 +00001400 /* fall through */
Georg Brandle32b4222007-03-10 22:13:27 +00001401error:
1402 Py_XDECREF(itsclass);
1403 Py_XDECREF(dict);
1404 return result;
1405}
1406
1407/* Helper for PyObject_Dir: object introspection.
1408 This calls one of the above specialized versions if no __dir__ method
1409 exists. */
1410static PyObject *
1411_dir_object(PyObject *obj)
1412{
1413 PyObject * result = NULL;
1414 PyObject * dirfunc = PyObject_GetAttrString((PyObject*)obj->ob_type,
1415 "__dir__");
1416
1417 assert(obj);
1418 if (dirfunc == NULL) {
1419 /* use default implementation */
1420 PyErr_Clear();
1421 if (PyModule_Check(obj))
1422 result = _specialized_dir_module(obj);
1423 else if (PyType_Check(obj))
1424 result = _specialized_dir_type(obj);
1425 else
1426 result = _generic_dir(obj);
1427 }
1428 else {
1429 /* use __dir__ */
1430 result = PyObject_CallFunctionObjArgs(dirfunc, obj, NULL);
1431 Py_DECREF(dirfunc);
1432 if (result == NULL)
1433 return NULL;
1434
1435 /* result must be a list */
1436 /* XXX(gbrandl): could also check if all items are strings */
1437 if (!PyList_Check(result)) {
1438 PyErr_Format(PyExc_TypeError,
1439 "__dir__() must return a list, not %.200s",
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001440 Py_Type(result)->tp_name);
Georg Brandle32b4222007-03-10 22:13:27 +00001441 Py_DECREF(result);
1442 result = NULL;
1443 }
1444 }
1445
1446 return result;
1447}
1448
1449/* Implementation of dir() -- if obj is NULL, returns the names in the current
1450 (local) scope. Otherwise, performs introspection of the object: returns a
1451 sorted list of attribute names (supposedly) accessible from the object
1452*/
1453PyObject *
1454PyObject_Dir(PyObject *obj)
1455{
1456 PyObject * result;
1457
1458 if (obj == NULL)
1459 /* no object -- introspect the locals */
1460 result = _dir_locals();
1461 else
1462 /* object -- introspect the object */
1463 result = _dir_object(obj);
1464
1465 assert(result == NULL || PyList_Check(result));
1466
1467 if (result != NULL && PyList_Sort(result) != 0) {
1468 /* sorting the list failed */
1469 Py_DECREF(result);
1470 result = NULL;
1471 }
1472
Tim Peters7eea37e2001-09-04 22:08:56 +00001473 return result;
1474}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001475
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001476/*
1477NoObject is usable as a non-NULL undefined value, used by the macro None.
1478There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001479so there is exactly one (which is indestructible, by the way).
Guido van Rossumba21a492001-08-16 08:17:26 +00001480(XXX This type and the type of NotImplemented below should be unified.)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001481*/
1482
Guido van Rossum0c182a11992-03-27 17:26:13 +00001483/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001484static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001485none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001486{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001487 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001488}
1489
Barry Warsaw9bf16442001-01-23 16:24:35 +00001490/* ARGUSED */
1491static void
Tim Peters803526b2002-07-07 05:13:56 +00001492none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001493{
1494 /* This should never get called, but we also don't want to SEGV if
1495 * we accidently decref None out of existance.
1496 */
Martin v. Löwis3f19b102002-08-07 16:21:51 +00001497 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001498}
1499
1500
Guido van Rossumba21a492001-08-16 08:17:26 +00001501static PyTypeObject PyNone_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001502 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001503 "NoneType",
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001504 0,
1505 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001506 none_dealloc, /*tp_dealloc*/ /*never called*/
Guido van Rossum7066dd71992-09-17 17:54:56 +00001507 0, /*tp_print*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001508 0, /*tp_getattr*/
1509 0, /*tp_setattr*/
1510 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001511 none_repr, /*tp_repr*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001512 0, /*tp_as_number*/
1513 0, /*tp_as_sequence*/
1514 0, /*tp_as_mapping*/
Guido van Rossum9bfef441993-03-29 10:43:31 +00001515 0, /*tp_hash */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001516};
1517
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001518PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001519 _PyObject_EXTRA_INIT
1520 1, &PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001521};
1522
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001523/* NotImplemented is an object that can be used to signal that an
1524 operation is not implemented for the given type combination. */
1525
1526static PyObject *
1527NotImplemented_repr(PyObject *op)
1528{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001529 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001530}
1531
1532static PyTypeObject PyNotImplemented_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001533 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001534 "NotImplementedType",
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001535 0,
1536 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001537 none_dealloc, /*tp_dealloc*/ /*never called*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001538 0, /*tp_print*/
1539 0, /*tp_getattr*/
1540 0, /*tp_setattr*/
1541 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001542 NotImplemented_repr, /*tp_repr*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001543 0, /*tp_as_number*/
1544 0, /*tp_as_sequence*/
1545 0, /*tp_as_mapping*/
1546 0, /*tp_hash */
1547};
1548
1549PyObject _Py_NotImplementedStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001550 _PyObject_EXTRA_INIT
1551 1, &PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001552};
1553
Guido van Rossumba21a492001-08-16 08:17:26 +00001554void
1555_Py_ReadyTypes(void)
1556{
1557 if (PyType_Ready(&PyType_Type) < 0)
1558 Py_FatalError("Can't initialize 'type'");
1559
Fred Drake0a4dd392004-07-02 18:57:45 +00001560 if (PyType_Ready(&_PyWeakref_RefType) < 0)
1561 Py_FatalError("Can't initialize 'weakref'");
1562
Guido van Rossum77f6a652002-04-03 22:41:51 +00001563 if (PyType_Ready(&PyBool_Type) < 0)
1564 Py_FatalError("Can't initialize 'bool'");
1565
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001566 if (PyType_Ready(&PyBytes_Type) < 0)
1567 Py_FatalError("Can't initialize 'bytes'");
1568
Guido van Rossumcacfc072002-05-24 19:01:59 +00001569 if (PyType_Ready(&PyString_Type) < 0)
1570 Py_FatalError("Can't initialize 'str'");
1571
Guido van Rossumba21a492001-08-16 08:17:26 +00001572 if (PyType_Ready(&PyList_Type) < 0)
1573 Py_FatalError("Can't initialize 'list'");
1574
1575 if (PyType_Ready(&PyNone_Type) < 0)
1576 Py_FatalError("Can't initialize type(None)");
1577
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001578 if (PyType_Ready(Py_Ellipsis->ob_type) < 0)
1579 Py_FatalError("Can't initialize type(Ellipsis)");
1580
Guido van Rossumba21a492001-08-16 08:17:26 +00001581 if (PyType_Ready(&PyNotImplemented_Type) < 0)
1582 Py_FatalError("Can't initialize type(NotImplemented)");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001583
1584 if (PyType_Ready(&PyCode_Type) < 0)
1585 Py_FatalError("Can't initialize 'code'");
Guido van Rossumba21a492001-08-16 08:17:26 +00001586}
1587
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001588
Guido van Rossum84a90321996-05-22 16:34:47 +00001589#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001590
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001591void
Fred Drake100814d2000-07-09 15:48:49 +00001592_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001593{
Tim Peters34592512002-07-11 06:23:50 +00001594 _Py_INC_REFTOTAL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001595 op->ob_refcnt = 1;
Tim Peters7571a0f2003-03-23 17:52:28 +00001596 _Py_AddToAllObjects(op, 1);
Tim Peters34592512002-07-11 06:23:50 +00001597 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001598}
1599
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001600void
Fred Drake100814d2000-07-09 15:48:49 +00001601_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001602{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001603#ifdef SLOW_UNREF_CHECK
Guido van Rossum4c08d552000-03-10 22:55:18 +00001604 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001605#endif
Guido van Rossumd7047b31995-01-02 19:07:15 +00001606 if (op->ob_refcnt < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001607 Py_FatalError("UNREF negative refcnt");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001608 if (op == &refchain ||
Guido van Rossumd7047b31995-01-02 19:07:15 +00001609 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001610 Py_FatalError("UNREF invalid object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001611#ifdef SLOW_UNREF_CHECK
Guido van Rossum3f5da241990-12-20 15:06:42 +00001612 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1613 if (p == op)
1614 break;
1615 }
Guido van Rossumd7047b31995-01-02 19:07:15 +00001616 if (p == &refchain) /* Not found */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001617 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001618#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001619 op->_ob_next->_ob_prev = op->_ob_prev;
1620 op->_ob_prev->_ob_next = op->_ob_next;
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001621 op->_ob_next = op->_ob_prev = NULL;
Tim Peters34592512002-07-11 06:23:50 +00001622 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001623}
1624
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001625void
Fred Drake100814d2000-07-09 15:48:49 +00001626_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001627{
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001628 destructor dealloc = Py_Type(op)->tp_dealloc;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001629 _Py_ForgetReference(op);
Guido van Rossum9776adf1994-09-07 14:36:45 +00001630 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001631}
1632
Tim Peters269b2a62003-04-17 19:52:29 +00001633/* Print all live objects. Because PyObject_Print is called, the
1634 * interpreter must be in a healthy state.
1635 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001636void
Fred Drake100814d2000-07-09 15:48:49 +00001637_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001638{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001639 PyObject *op;
Guido van Rossume09fb551997-08-05 02:04:34 +00001640 fprintf(fp, "Remaining objects:\n");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001641 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001642 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001643 if (PyObject_Print(op, fp, 0) != 0)
1644 PyErr_Clear();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001645 putc('\n', fp);
1646 }
1647}
1648
Tim Peters269b2a62003-04-17 19:52:29 +00001649/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1650 * doesn't make any calls to the Python C API, so is always safe to call.
1651 */
1652void
1653_Py_PrintReferenceAddresses(FILE *fp)
1654{
1655 PyObject *op;
1656 fprintf(fp, "Remaining object addresses:\n");
1657 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001658 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001659 op->ob_refcnt, Py_Type(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001660}
1661
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001662PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001663_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001664{
1665 int i, n;
1666 PyObject *t = NULL;
1667 PyObject *res, *op;
1668
1669 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1670 return NULL;
1671 op = refchain._ob_next;
1672 res = PyList_New(0);
1673 if (res == NULL)
1674 return NULL;
1675 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1676 while (op == self || op == args || op == res || op == t ||
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001677 (t != NULL && Py_Type(op) != (PyTypeObject *) t)) {
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001678 op = op->_ob_next;
1679 if (op == &refchain)
1680 return res;
1681 }
1682 if (PyList_Append(res, op) < 0) {
1683 Py_DECREF(res);
1684 return NULL;
1685 }
1686 op = op->_ob_next;
1687 }
1688 return res;
1689}
1690
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001691#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001692
1693
1694/* Hack to force loading of cobject.o */
Guido van Rossumda9c2711996-12-05 21:58:58 +00001695PyTypeObject *_Py_cobject_hack = &PyCObject_Type;
Guido van Rossum84a90321996-05-22 16:34:47 +00001696
1697
1698/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001699Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001700
1701
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001702/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001703
Thomas Wouters334fb892000-07-25 12:56:38 +00001704void *
Fred Drake100814d2000-07-09 15:48:49 +00001705PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001706{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001707 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001708}
1709
Thomas Wouters334fb892000-07-25 12:56:38 +00001710void *
1711PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001712{
Tim Petersaf3e8de2002-04-12 07:22:56 +00001713 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001714}
1715
1716void
Thomas Wouters334fb892000-07-25 12:56:38 +00001717PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001718{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001719 PyMem_FREE(p);
1720}
1721
1722
Guido van Rossum86610361998-04-10 22:32:46 +00001723/* These methods are used to control infinite recursion in repr, str, print,
1724 etc. Container objects that may recursively contain themselves,
1725 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1726 Py_ReprLeave() to avoid infinite recursion.
1727
1728 Py_ReprEnter() returns 0 the first time it is called for a particular
1729 object and 1 every time thereafter. It returns -1 if an exception
1730 occurred. Py_ReprLeave() has no return value.
1731
1732 See dictobject.c and listobject.c for examples of use.
1733*/
1734
1735#define KEY "Py_Repr"
1736
1737int
Fred Drake100814d2000-07-09 15:48:49 +00001738Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001739{
1740 PyObject *dict;
1741 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001742 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001743
1744 dict = PyThreadState_GetDict();
1745 if (dict == NULL)
Guido van Rossum0fc8f002003-04-15 15:12:39 +00001746 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001747 list = PyDict_GetItemString(dict, KEY);
1748 if (list == NULL) {
1749 list = PyList_New(0);
1750 if (list == NULL)
1751 return -1;
1752 if (PyDict_SetItemString(dict, KEY, list) < 0)
1753 return -1;
1754 Py_DECREF(list);
1755 }
1756 i = PyList_GET_SIZE(list);
1757 while (--i >= 0) {
1758 if (PyList_GET_ITEM(list, i) == obj)
1759 return 1;
1760 }
1761 PyList_Append(list, obj);
1762 return 0;
1763}
1764
1765void
Fred Drake100814d2000-07-09 15:48:49 +00001766Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001767{
1768 PyObject *dict;
1769 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001770 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001771
1772 dict = PyThreadState_GetDict();
Guido van Rossumeb909461998-04-11 15:17:34 +00001773 if (dict == NULL)
1774 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001775 list = PyDict_GetItemString(dict, KEY);
Guido van Rossumeb909461998-04-11 15:17:34 +00001776 if (list == NULL || !PyList_Check(list))
1777 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001778 i = PyList_GET_SIZE(list);
1779 /* Count backwards because we always expect obj to be list[-1] */
1780 while (--i >= 0) {
1781 if (PyList_GET_ITEM(list, i) == obj) {
1782 PyList_SetSlice(list, i, i + 1, NULL);
1783 break;
1784 }
1785 }
1786}
Guido van Rossumd724b232000-03-13 16:01:29 +00001787
Tim Peters803526b2002-07-07 05:13:56 +00001788/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001789
Tim Peters803526b2002-07-07 05:13:56 +00001790/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001791int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001792
Tim Peters803526b2002-07-07 05:13:56 +00001793/* List of objects that still need to be cleaned up, singly linked via their
1794 * gc headers' gc_prev pointers.
1795 */
1796PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001797
Tim Peters803526b2002-07-07 05:13:56 +00001798/* Add op to the _PyTrash_delete_later list. Called when the current
1799 * call-stack depth gets large. op must be a currently untracked gc'ed
1800 * object, with refcount 0. Py_DECREF must already have been called on it.
1801 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001802void
Fred Drake100814d2000-07-09 15:48:49 +00001803_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001804{
Tim Peters803526b2002-07-07 05:13:56 +00001805 assert(PyObject_IS_GC(op));
1806 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1807 assert(op->ob_refcnt == 0);
Neil Schemenauerf589c052002-03-29 03:05:54 +00001808 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
Guido van Rossume92e6102000-04-24 15:40:53 +00001809 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001810}
1811
Tim Peters803526b2002-07-07 05:13:56 +00001812/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1813 * the call-stack unwinds again.
1814 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001815void
Fred Drake100814d2000-07-09 15:48:49 +00001816_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001817{
1818 while (_PyTrash_delete_later) {
Tim Peters803526b2002-07-07 05:13:56 +00001819 PyObject *op = _PyTrash_delete_later;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001820 destructor dealloc = Py_Type(op)->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001821
Neil Schemenauerf589c052002-03-29 03:05:54 +00001822 _PyTrash_delete_later =
Tim Peters803526b2002-07-07 05:13:56 +00001823 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001824
Tim Peters803526b2002-07-07 05:13:56 +00001825 /* Call the deallocator directly. This used to try to
1826 * fool Py_DECREF into calling it indirectly, but
1827 * Py_DECREF was already called on this object, and in
1828 * assorted non-release builds calling Py_DECREF again ends
1829 * up distorting allocation statistics.
1830 */
1831 assert(op->ob_refcnt == 0);
Guido van Rossumd724b232000-03-13 16:01:29 +00001832 ++_PyTrash_delete_nesting;
Tim Peters803526b2002-07-07 05:13:56 +00001833 (*dealloc)(op);
Guido van Rossumd724b232000-03-13 16:01:29 +00001834 --_PyTrash_delete_nesting;
1835 }
1836}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001837
1838#ifdef __cplusplus
1839}
1840#endif