blob: 40b8b42dbccf8d5e574f46feecdad2d300069314 [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) {
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000274 Py_BEGIN_ALLOW_THREADS
Guido van Rossum90933611991-06-07 16:10:43 +0000275 fprintf(fp, "<nil>");
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000276 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000277 }
Guido van Rossum90933611991-06-07 16:10:43 +0000278 else {
279 if (op->ob_refcnt <= 0)
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000280 /* XXX(twouters) cast refcount to long until %zd is
281 universally available */
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000282 Py_BEGIN_ALLOW_THREADS
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000283 fprintf(fp, "<refcnt %ld at %p>",
284 (long)op->ob_refcnt, op);
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000285 Py_END_ALLOW_THREADS
Guido van Rossum04dbf3b2007-08-07 19:51:00 +0000286 else {
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000287 PyObject *s;
288 if (flags & Py_PRINT_RAW)
289 s = PyObject_Str(op);
290 else
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000291 s = PyObject_Repr(op);
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000292 if (s == NULL)
293 ret = -1;
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000294 else if (PyString_Check(s)) {
295 fwrite(PyString_AS_STRING(s), 1,
296 PyString_GET_SIZE(s), fp);
297 }
298 else if (PyUnicode_Check(s)) {
299 PyObject *t;
300 t = _PyUnicode_AsDefaultEncodedString(s, NULL);
301 if (t == NULL)
302 ret = 0;
303 else {
304 fwrite(PyString_AS_STRING(t), 1,
305 PyString_GET_SIZE(t), fp);
306 }
307 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000308 else {
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000309 PyErr_Format(PyExc_TypeError,
310 "str() or repr() returned '%.100s'",
311 s->ob_type->tp_name);
312 ret = -1;
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000313 }
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000314 Py_XDECREF(s);
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000315 }
Guido van Rossum90933611991-06-07 16:10:43 +0000316 }
Guido van Rossum278ef591991-07-27 21:40:24 +0000317 if (ret == 0) {
318 if (ferror(fp)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000319 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum278ef591991-07-27 21:40:24 +0000320 clearerr(fp);
321 ret = -1;
322 }
323 }
324 return ret;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000325}
326
Neal Norwitz1a997502003-01-13 20:13:12 +0000327int
328PyObject_Print(PyObject *op, FILE *fp, int flags)
329{
330 return internal_print(op, fp, flags, 0);
331}
332
Guido van Rossum38938152006-08-21 23:36:26 +0000333/* For debugging convenience. Set a breakpoint here and call it from your DLL */
334void
Thomas Woutersb2137042007-02-01 18:02:27 +0000335_Py_BreakPoint(void)
Guido van Rossum38938152006-08-21 23:36:26 +0000336{
337}
338
Neal Norwitz1a997502003-01-13 20:13:12 +0000339
Barry Warsaw9bf16442001-01-23 16:24:35 +0000340/* For debugging convenience. See Misc/gdbinit for some useful gdb hooks */
Guido van Rossum38938152006-08-21 23:36:26 +0000341void
342_PyObject_Dump(PyObject* op)
Barry Warsaw9bf16442001-01-23 16:24:35 +0000343{
Barry Warsaweefb1072001-02-22 22:39:18 +0000344 if (op == NULL)
345 fprintf(stderr, "NULL\n");
346 else {
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000347 fprintf(stderr, "object : ");
Barry Warsaweefb1072001-02-22 22:39:18 +0000348 (void)PyObject_Print(op, stderr, 0);
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000349 /* XXX(twouters) cast refcount to long until %zd is
350 universally available */
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000351 fprintf(stderr, "\n"
352 "type : %s\n"
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000353 "refcount: %ld\n"
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000354 "address : %p\n",
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000355 Py_Type(op)==NULL ? "NULL" : Py_Type(op)->tp_name,
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000356 (long)op->ob_refcnt,
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000357 op);
Barry Warsaweefb1072001-02-22 22:39:18 +0000358 }
Barry Warsaw9bf16442001-01-23 16:24:35 +0000359}
Barry Warsaw903138f2001-01-23 16:33:18 +0000360
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000361PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000362PyObject_Repr(PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000363{
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000364 PyObject *res;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000365 if (PyErr_CheckSignals())
Guido van Rossum90933611991-06-07 16:10:43 +0000366 return NULL;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000367#ifdef USE_STACKCHECK
368 if (PyOS_CheckStack()) {
Fred Drake661ea262000-10-24 19:57:45 +0000369 PyErr_SetString(PyExc_MemoryError, "stack overflow");
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000370 return NULL;
371 }
372#endif
Guido van Rossum90933611991-06-07 16:10:43 +0000373 if (v == NULL)
Walter Dörwald1ab83302007-05-18 17:15:44 +0000374 return PyUnicode_FromString("<NULL>");
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000375 else if (Py_Type(v)->tp_repr == NULL)
Walter Dörwald1ab83302007-05-18 17:15:44 +0000376 return PyUnicode_FromFormat("<%s object at %p>", v->ob_type->tp_name, v);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000377 else {
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000378 res = (*v->ob_type->tp_repr)(v);
379 if (res != NULL && !PyUnicode_Check(res)) {
Guido van Rossum4c08d552000-03-10 22:55:18 +0000380 PyErr_Format(PyExc_TypeError,
Guido van Rossum5db862d2000-04-10 12:46:51 +0000381 "__repr__ returned non-string (type %.200s)",
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000382 res->ob_type->tp_name);
383 Py_DECREF(res);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000384 return NULL;
385 }
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000386 return res;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000387 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000388}
389
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000390PyObject *
Walter Dörwald1ab83302007-05-18 17:15:44 +0000391PyObject_ReprStr8(PyObject *v)
392{
393 PyObject *resu = PyObject_Repr(v);
394 if (resu) {
395 PyObject *resb = PyUnicode_AsEncodedString(resu, NULL, NULL);
396 Py_DECREF(resu);
397 if (resb) {
398 PyObject *ress = PyString_FromStringAndSize(
399 PyBytes_AS_STRING(resb),
400 PyBytes_GET_SIZE(resb)
401 );
402 Py_DECREF(resb);
403 return ress;
404 }
405 }
406 return NULL;
407}
408
409PyObject *
Neil Schemenauercf52c072005-08-12 17:34:58 +0000410_PyObject_Str(PyObject *v)
Guido van Rossumc6004111993-11-05 10:22:19 +0000411{
Guido van Rossum4c08d552000-03-10 22:55:18 +0000412 PyObject *res;
Guido van Rossumc6004111993-11-05 10:22:19 +0000413 if (v == NULL)
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000414 return PyUnicode_FromString("<NULL>");
Tim Peters5a49ade2001-09-11 01:41:59 +0000415 if (PyString_CheckExact(v)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000416 Py_INCREF(v);
Guido van Rossumc6004111993-11-05 10:22:19 +0000417 return v;
418 }
Neil Schemenauercf52c072005-08-12 17:34:58 +0000419 if (PyUnicode_CheckExact(v)) {
420 Py_INCREF(v);
421 return v;
422 }
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000423 if (Py_Type(v)->tp_str == NULL)
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000424 return PyObject_Repr(v);
425
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000426 /* It is possible for a type to have a tp_str representation that loops
427 infinitely. */
428 if (Py_EnterRecursiveCall(" while getting the str of an object"))
429 return NULL;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000430 res = (*Py_Type(v)->tp_str)(v);
Guido van Rossum8ce8a782007-11-01 19:42:39 +0000431 Py_LeaveRecursiveCall();
Guido van Rossum4c08d552000-03-10 22:55:18 +0000432 if (res == NULL)
433 return NULL;
Guido van Rossum55b4a7b2007-07-11 09:28:11 +0000434 if (!(PyString_Check(res) || PyUnicode_Check(res))) {
Neil Schemenauercf52c072005-08-12 17:34:58 +0000435 PyErr_Format(PyExc_TypeError,
436 "__str__ returned non-string (type %.200s)",
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000437 Py_Type(res)->tp_name);
Neil Schemenauercf52c072005-08-12 17:34:58 +0000438 Py_DECREF(res);
439 return NULL;
440 }
441 return res;
442}
443
444PyObject *
445PyObject_Str(PyObject *v)
446{
447 PyObject *res = _PyObject_Str(v);
448 if (res == NULL)
449 return NULL;
Marc-André Lemburg891bc652000-07-03 09:57:53 +0000450 if (PyUnicode_Check(res)) {
451 PyObject* str;
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000452 str = _PyUnicode_AsDefaultEncodedString(res, NULL);
453 Py_XINCREF(str);
Marc-André Lemburg891bc652000-07-03 09:57:53 +0000454 Py_DECREF(res);
455 if (str)
456 res = str;
457 else
458 return NULL;
459 }
Neil Schemenauercf52c072005-08-12 17:34:58 +0000460 assert(PyString_Check(res));
Guido van Rossum4c08d552000-03-10 22:55:18 +0000461 return res;
Guido van Rossumc6004111993-11-05 10:22:19 +0000462}
463
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000464PyObject *
465PyObject_Unicode(PyObject *v)
466{
467 PyObject *res;
Brett Cannonc3647ac2005-04-26 03:45:26 +0000468 PyObject *func;
Neal Norwitz75801462006-03-14 06:02:16 +0000469 PyObject *str;
Brett Cannonc3647ac2005-04-26 03:45:26 +0000470 static PyObject *unicodestr;
Tim Peters803526b2002-07-07 05:13:56 +0000471
Walter Dörwaldb03ccc02007-05-11 17:25:52 +0000472 if (v == NULL)
473 return PyUnicode_FromString("<NULL>");
474 else if (PyUnicode_CheckExact(v)) {
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000475 Py_INCREF(v);
476 return v;
477 }
Brett Cannonc3647ac2005-04-26 03:45:26 +0000478 /* XXX As soon as we have a tp_unicode slot, we should
479 check this before trying the __unicode__
480 method. */
481 if (unicodestr == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +0000482 unicodestr= PyUnicode_InternFromString("__unicode__");
Brett Cannonc3647ac2005-04-26 03:45:26 +0000483 if (unicodestr == NULL)
484 return NULL;
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000485 }
Brett Cannonc3647ac2005-04-26 03:45:26 +0000486 func = PyObject_GetAttr(v, unicodestr);
487 if (func != NULL) {
488 res = PyEval_CallObject(func, (PyObject *)NULL);
489 Py_DECREF(func);
490 }
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000491 else {
Brett Cannonc3647ac2005-04-26 03:45:26 +0000492 PyErr_Clear();
Guido van Rossum55b4a7b2007-07-11 09:28:11 +0000493 if (PyUnicode_Check(v) &&
494 v->ob_type->tp_str == PyUnicode_Type.tp_str) {
495 /* For a Unicode subtype that's didn't overwrite
496 __unicode__ or __str__,
Brett Cannonc3647ac2005-04-26 03:45:26 +0000497 return a true Unicode object with the same data. */
498 return PyUnicode_FromUnicode(PyUnicode_AS_UNICODE(v),
499 PyUnicode_GET_SIZE(v));
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000500 }
Brett Cannonc3647ac2005-04-26 03:45:26 +0000501 if (PyString_CheckExact(v)) {
502 Py_INCREF(v);
503 res = v;
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000504 }
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000505 else {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000506 if (Py_Type(v)->tp_str != NULL)
507 res = (*Py_Type(v)->tp_str)(v);
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000508 else
509 res = PyObject_Repr(v);
510 }
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000511 }
512 if (res == NULL)
513 return NULL;
514 if (!PyUnicode_Check(res)) {
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000515 str = PyUnicode_FromEncodedObject(res, NULL, "strict");
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000516 Py_DECREF(res);
Neal Norwitz75801462006-03-14 06:02:16 +0000517 res = str;
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000518 }
519 return res;
520}
521
522
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000523/* The new comparison philosophy is: we completely separate three-way
524 comparison from rich comparison. That is, PyObject_Compare() and
525 PyObject_Cmp() *just* use the tp_compare slot. And PyObject_RichCompare()
526 and PyObject_RichCompareBool() *just* use the tp_richcompare slot.
527
528 See (*) below for practical amendments.
529
530 IOW, only cmp() uses tp_compare; the comparison operators (==, !=, <=, <,
531 >=, >) only use tp_richcompare. Note that list.sort() only uses <.
532
533 (And yes, eventually we'll rip out cmp() and tp_compare.)
534
535 The calling conventions are different: tp_compare only gets called with two
536 objects of the appropriate type; tp_richcompare gets called with a first
537 argument of the appropriate type and a second object of an arbitrary type.
538 We never do any kind of coercion.
539
540 The return conventions are also different.
541
542 The tp_compare slot should return a C int, as follows:
543
544 -1 if a < b or if an exception occurred
545 0 if a == b
546 +1 if a > b
547
548 No other return values are allowed. PyObject_Compare() has the same
549 calling convention.
550
551 The tp_richcompare slot should return an object, as follows:
552
553 NULL if an exception occurred
554 NotImplemented if the requested comparison is not implemented
555 any other false value if the requested comparison is false
556 any other true value if the requested comparison is true
557
558 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
559 NotImplemented.
560
561 (*) Practical amendments:
562
563 - If rich comparison returns NotImplemented, == and != are decided by
564 comparing the object pointer (i.e. falling back to the base object
565 implementation).
566
567 - If three-way comparison is not implemented, it falls back on rich
568 comparison (but not the other way around!).
569
Guido van Rossuma4073002002-05-31 20:03:54 +0000570*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000571
572/* Forward */
573static PyObject *do_richcompare(PyObject *v, PyObject *w, int op);
574
575/* Perform a three-way comparison, raising TypeError if three-way comparison
576 is not supported. */
Guido van Rossuma4073002002-05-31 20:03:54 +0000577static int
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000578do_compare(PyObject *v, PyObject *w)
Guido van Rossuma4073002002-05-31 20:03:54 +0000579{
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000580 cmpfunc f;
581 int ok;
582
583 if (v->ob_type == w->ob_type &&
584 (f = v->ob_type->tp_compare) != NULL) {
585 return (*f)(v, w);
Guido van Rossuma4073002002-05-31 20:03:54 +0000586 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000587
588 /* Now try three-way compare before giving up. This is intentionally
589 elaborate; if you have a it will raise TypeError if it detects two
590 objects that aren't ordered with respect to each other. */
591 ok = PyObject_RichCompareBool(v, w, Py_LT);
592 if (ok < 0)
593 return -1; /* Error */
594 if (ok)
595 return -1; /* Less than */
596 ok = PyObject_RichCompareBool(v, w, Py_GT);
597 if (ok < 0)
598 return -1; /* Error */
599 if (ok)
600 return 1; /* Greater than */
601 ok = PyObject_RichCompareBool(v, w, Py_EQ);
602 if (ok < 0)
603 return -1; /* Error */
604 if (ok)
605 return 0; /* Equal */
606
607 /* Give up */
608 PyErr_Format(PyExc_TypeError,
Neal Norwitz3bd844e2006-08-29 04:39:12 +0000609 "unorderable types: '%.100s' != '%.100s'",
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000610 v->ob_type->tp_name,
611 w->ob_type->tp_name);
612 return -1;
Guido van Rossuma4073002002-05-31 20:03:54 +0000613}
614
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000615/* Perform a three-way comparison. This wraps do_compare() with a check for
616 NULL arguments and a recursion check. */
617int
618PyObject_Compare(PyObject *v, PyObject *w)
619{
620 int res;
Guido van Rossuma4073002002-05-31 20:03:54 +0000621
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000622 if (v == NULL || w == NULL) {
623 if (!PyErr_Occurred())
624 PyErr_BadInternalCall();
625 return -1;
626 }
627 if (Py_EnterRecursiveCall(" in cmp"))
628 return -1;
629 res = do_compare(v, w);
630 Py_LeaveRecursiveCall();
631 return res < 0 ? -1 : res;
632}
Guido van Rossumd1f06b92001-01-24 22:14:43 +0000633
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000634/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000635int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000636
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000637static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000638
639/* Perform a rich comparison, raising TypeError when the requested comparison
640 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000641static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000642do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000643{
644 richcmpfunc f;
645 PyObject *res;
646
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000647 if (v->ob_type != w->ob_type &&
648 PyType_IsSubtype(w->ob_type, v->ob_type) &&
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000649 (f = w->ob_type->tp_richcompare) != NULL) {
Tim Petersf4aca752004-09-23 02:39:37 +0000650 res = (*f)(w, v, _Py_SwappedOp[op]);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000651 if (res != Py_NotImplemented)
652 return res;
653 Py_DECREF(res);
654 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000655 if ((f = v->ob_type->tp_richcompare) != NULL) {
Guido van Rossume797ec12001-01-17 15:24:28 +0000656 res = (*f)(v, w, op);
657 if (res != Py_NotImplemented)
658 return res;
659 Py_DECREF(res);
660 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000661 if ((f = w->ob_type->tp_richcompare) != NULL) {
662 res = (*f)(w, v, _Py_SwappedOp[op]);
663 if (res != Py_NotImplemented)
664 return res;
665 Py_DECREF(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000666 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000667 /* If neither object implements it, provide a sensible default
668 for == and !=, but raise an exception for ordering. */
669 switch (op) {
670 case Py_EQ:
671 res = (v == w) ? Py_True : Py_False;
672 break;
673 case Py_NE:
674 res = (v != w) ? Py_True : Py_False;
675 break;
676 default:
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000677 /* XXX Special-case None so it doesn't show as NoneType() */
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000678 PyErr_Format(PyExc_TypeError,
679 "unorderable types: %.100s() %s %.100s()",
680 v->ob_type->tp_name,
681 opstrings[op],
682 w->ob_type->tp_name);
683 return NULL;
684 }
Guido van Rossume797ec12001-01-17 15:24:28 +0000685 Py_INCREF(res);
686 return res;
687}
688
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000689/* Perform a rich comparison with object result. This wraps do_richcompare()
690 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000691
Guido van Rossume797ec12001-01-17 15:24:28 +0000692PyObject *
693PyObject_RichCompare(PyObject *v, PyObject *w, int op)
694{
695 PyObject *res;
696
697 assert(Py_LT <= op && op <= Py_GE);
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000698 if (v == NULL || w == NULL) {
699 if (!PyErr_Occurred())
700 PyErr_BadInternalCall();
701 return NULL;
702 }
Armin Rigo2b3eb402003-10-28 12:05:48 +0000703 if (Py_EnterRecursiveCall(" in cmp"))
704 return NULL;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000705 res = do_richcompare(v, w, op);
Armin Rigo2b3eb402003-10-28 12:05:48 +0000706 Py_LeaveRecursiveCall();
Guido van Rossume797ec12001-01-17 15:24:28 +0000707 return res;
708}
709
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000710/* Perform a rich comparison with integer result. This wraps
711 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000712int
713PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
714{
Raymond Hettinger93d44812004-03-21 17:01:44 +0000715 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000716 int ok;
717
Raymond Hettinger93d44812004-03-21 17:01:44 +0000718 res = PyObject_RichCompare(v, w, op);
Guido van Rossume797ec12001-01-17 15:24:28 +0000719 if (res == NULL)
720 return -1;
Guido van Rossum81912d42002-08-24 05:33:28 +0000721 if (PyBool_Check(res))
722 ok = (res == Py_True);
723 else
724 ok = PyObject_IsTrue(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000725 Py_DECREF(res);
726 return ok;
727}
Fred Drake13634cf2000-06-29 19:17:04 +0000728
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000729/* Turn the result of a three-way comparison into the result expected by a
730 rich comparison. */
731PyObject *
732Py_CmpToRich(int op, int cmp)
733{
734 PyObject *res;
735 int ok;
736
737 if (PyErr_Occurred())
738 return NULL;
739 switch (op) {
740 case Py_LT:
741 ok = cmp < 0;
742 break;
743 case Py_LE:
744 ok = cmp <= 0;
745 break;
746 case Py_EQ:
747 ok = cmp == 0;
748 break;
749 case Py_NE:
750 ok = cmp != 0;
751 break;
752 case Py_GT:
753 ok = cmp > 0;
754 break;
755 case Py_GE:
756 ok = cmp >= 0;
757 break;
758 default:
759 PyErr_BadArgument();
760 return NULL;
761 }
762 res = ok ? Py_True : Py_False;
763 Py_INCREF(res);
764 return res;
765}
766
Fred Drake13634cf2000-06-29 19:17:04 +0000767/* Set of hash utility functions to help maintaining the invariant that
Raymond Hettinger8183fa42004-03-21 17:35:06 +0000768 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000769
770 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
771*/
772
773long
Fred Drake100814d2000-07-09 15:48:49 +0000774_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000775{
Tim Peters39dce292000-08-15 03:34:48 +0000776 double intpart, fractpart;
777 int expo;
778 long hipart;
779 long x; /* the final hash value */
780 /* This is designed so that Python numbers of different types
781 * that compare equal hash to the same value; otherwise comparisons
782 * of mapping keys will turn out weird.
783 */
784
Tim Peters39dce292000-08-15 03:34:48 +0000785 fractpart = modf(v, &intpart);
Tim Peters39dce292000-08-15 03:34:48 +0000786 if (fractpart == 0.0) {
787 /* This must return the same hash as an equal int or long. */
788 if (intpart > LONG_MAX || -intpart > LONG_MAX) {
789 /* Convert to long and use its hash. */
790 PyObject *plong; /* converted to Python long */
791 if (Py_IS_INFINITY(intpart))
792 /* can't convert to long int -- arbitrary */
793 v = v < 0 ? -271828.0 : 314159.0;
794 plong = PyLong_FromDouble(v);
795 if (plong == NULL)
796 return -1;
797 x = PyObject_Hash(plong);
798 Py_DECREF(plong);
799 return x;
800 }
801 /* Fits in a C long == a Python int, so is its own hash. */
802 x = (long)intpart;
803 if (x == -1)
804 x = -2;
805 return x;
806 }
807 /* The fractional part is non-zero, so we don't have to worry about
808 * making this match the hash of some other type.
809 * Use frexp to get at the bits in the double.
Fred Drake13634cf2000-06-29 19:17:04 +0000810 * Since the VAX D double format has 56 mantissa bits, which is the
811 * most of any double format in use, each of these parts may have as
812 * many as (but no more than) 56 significant bits.
Tim Peters39dce292000-08-15 03:34:48 +0000813 * So, assuming sizeof(long) >= 4, each part can be broken into two
814 * longs; frexp and multiplication are used to do that.
815 * Also, since the Cray double format has 15 exponent bits, which is
816 * the most of any double format in use, shifting the exponent field
817 * left by 15 won't overflow a long (again assuming sizeof(long) >= 4).
Fred Drake13634cf2000-06-29 19:17:04 +0000818 */
Tim Peters39dce292000-08-15 03:34:48 +0000819 v = frexp(v, &expo);
820 v *= 2147483648.0; /* 2**31 */
821 hipart = (long)v; /* take the top 32 bits */
822 v = (v - (double)hipart) * 2147483648.0; /* get the next 32 bits */
823 x = hipart + (long)v + (expo << 15);
824 if (x == -1)
825 x = -2;
826 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000827}
828
829long
Fred Drake100814d2000-07-09 15:48:49 +0000830_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000831{
832#if SIZEOF_LONG >= SIZEOF_VOID_P
833 return (long)p;
834#else
835 /* convert to a Python long and hash that */
836 PyObject* longobj;
837 long x;
Tim Peters803526b2002-07-07 05:13:56 +0000838
Fred Drake13634cf2000-06-29 19:17:04 +0000839 if ((longobj = PyLong_FromVoidPtr(p)) == NULL) {
840 x = -1;
841 goto finally;
842 }
843 x = PyObject_Hash(longobj);
Tim Peters803526b2002-07-07 05:13:56 +0000844
Fred Drake13634cf2000-06-29 19:17:04 +0000845finally:
846 Py_XDECREF(longobj);
847 return x;
848#endif
849}
850
851
Guido van Rossum9bfef441993-03-29 10:43:31 +0000852long
Fred Drake100814d2000-07-09 15:48:49 +0000853PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000854{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000855 PyTypeObject *tp = v->ob_type;
Guido van Rossum9bfef441993-03-29 10:43:31 +0000856 if (tp->tp_hash != NULL)
857 return (*tp->tp_hash)(v);
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000858 /* Otherwise, the object can't be hashed */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000859 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
860 v->ob_type->tp_name);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000861 return -1;
862}
863
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000864PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000865PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000866{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000867 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000868
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000869 if (Py_Type(v)->tp_getattr != NULL)
870 return (*Py_Type(v)->tp_getattr)(v, (char*)name);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000871 w = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000872 if (w == NULL)
873 return NULL;
874 res = PyObject_GetAttr(v, w);
875 Py_XDECREF(w);
876 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000877}
878
879int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000880PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000881{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000882 PyObject *res = PyObject_GetAttrString(v, name);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000883 if (res != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000884 Py_DECREF(res);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000885 return 1;
886 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000887 PyErr_Clear();
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000888 return 0;
889}
890
891int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000892PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000893{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000894 PyObject *s;
895 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000896
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000897 if (Py_Type(v)->tp_setattr != NULL)
898 return (*Py_Type(v)->tp_setattr)(v, (char*)name, w);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000899 s = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000900 if (s == NULL)
901 return -1;
902 res = PyObject_SetAttr(v, s, w);
903 Py_XDECREF(s);
904 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000905}
906
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000907PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000908PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000909{
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000910 PyTypeObject *tp = Py_Type(v);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000911
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000912 if (!PyUnicode_Check(name)) {
Martin v. Löwis5b222132007-06-10 09:51:05 +0000913 PyErr_Format(PyExc_TypeError,
914 "attribute name must be string, not '%.200s'",
915 name->ob_type->tp_name);
916 return NULL;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000917 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000918 if (tp->tp_getattro != NULL)
919 return (*tp->tp_getattro)(v, name);
920 if (tp->tp_getattr != NULL)
Martin v. Löwis5b222132007-06-10 09:51:05 +0000921 return (*tp->tp_getattr)(v, PyUnicode_AsString(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +0000922 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000923 "'%.50s' object has no attribute '%U'",
924 tp->tp_name, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000925 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000926}
927
928int
Fred Drake100814d2000-07-09 15:48:49 +0000929PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000930{
931 PyObject *res = PyObject_GetAttr(v, name);
932 if (res != NULL) {
933 Py_DECREF(res);
934 return 1;
935 }
936 PyErr_Clear();
937 return 0;
938}
939
940int
Fred Drake100814d2000-07-09 15:48:49 +0000941PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000942{
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000943 PyTypeObject *tp = Py_Type(v);
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000944 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000945
Martin v. Löwis5b222132007-06-10 09:51:05 +0000946 if (!PyUnicode_Check(name)) {
947 PyErr_Format(PyExc_TypeError,
948 "attribute name must be string, not '%.200s'",
949 name->ob_type->tp_name);
950 return -1;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000951 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000952 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000953
Martin v. Löwis5b222132007-06-10 09:51:05 +0000954 PyUnicode_InternInPlace(&name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000955 if (tp->tp_setattro != NULL) {
956 err = (*tp->tp_setattro)(v, name, value);
957 Py_DECREF(name);
958 return err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000959 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000960 if (tp->tp_setattr != NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +0000961 err = (*tp->tp_setattr)(v, PyUnicode_AsString(name), value);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000962 Py_DECREF(name);
963 return err;
964 }
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000965 Py_DECREF(name);
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000966 assert(name->ob_refcnt >= 1);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000967 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
968 PyErr_Format(PyExc_TypeError,
969 "'%.100s' object has no attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000970 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000971 tp->tp_name,
972 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000973 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000974 else
975 PyErr_Format(PyExc_TypeError,
976 "'%.100s' object has only read-only attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000977 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000978 tp->tp_name,
979 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000980 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000981 return -1;
982}
983
984/* Helper to get a pointer to an object's __dict__ slot, if any */
985
986PyObject **
987_PyObject_GetDictPtr(PyObject *obj)
988{
Martin v. Löwis725507b2006-03-07 12:08:51 +0000989 Py_ssize_t dictoffset;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000990 PyTypeObject *tp = Py_Type(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000991
Tim Peters6d6c1a32001-08-02 04:15:00 +0000992 dictoffset = tp->tp_dictoffset;
993 if (dictoffset == 0)
994 return NULL;
995 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000996 Py_ssize_t tsize;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000997 size_t size;
998
999 tsize = ((PyVarObject *)obj)->ob_size;
1000 if (tsize < 0)
1001 tsize = -tsize;
1002 size = _PyObject_VAR_SIZE(tp, tsize);
1003
Tim Peters6d483d32001-10-06 21:27:34 +00001004 dictoffset += (long)size;
1005 assert(dictoffset > 0);
1006 assert(dictoffset % SIZEOF_VOID_P == 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001007 }
1008 return (PyObject **) ((char *)obj + dictoffset);
1009}
1010
Tim Peters6d6c1a32001-08-02 04:15:00 +00001011PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +00001012PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +00001013{
1014 Py_INCREF(obj);
1015 return obj;
1016}
1017
Michael W. Hudson1593f502004-09-14 17:09:47 +00001018/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
1019
Raymond Hettinger01538262003-03-17 08:24:35 +00001020PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001021PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
1022{
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001023 PyTypeObject *tp = Py_Type(obj);
Guido van Rossum056fbf42002-08-19 19:22:50 +00001024 PyObject *descr = NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001025 PyObject *res = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001026 descrgetfunc f;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001027 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001028 PyObject **dictptr;
1029
Martin v. Löwis5b222132007-06-10 09:51:05 +00001030 if (!PyUnicode_Check(name)){
1031 PyErr_Format(PyExc_TypeError,
1032 "attribute name must be string, not '%.200s'",
1033 name->ob_type->tp_name);
1034 return NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001035 }
1036 else
1037 Py_INCREF(name);
1038
Tim Peters6d6c1a32001-08-02 04:15:00 +00001039 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001040 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001041 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001042 }
1043
Guido van Rossum056fbf42002-08-19 19:22:50 +00001044 /* Inline _PyType_Lookup */
1045 {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001046 Py_ssize_t i, n;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001047 PyObject *mro, *base, *dict;
1048
1049 /* Look in tp_dict of types in MRO */
1050 mro = tp->tp_mro;
1051 assert(mro != NULL);
1052 assert(PyTuple_Check(mro));
1053 n = PyTuple_GET_SIZE(mro);
1054 for (i = 0; i < n; i++) {
1055 base = PyTuple_GET_ITEM(mro, i);
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001056 assert(PyType_Check(base));
1057 dict = ((PyTypeObject *)base)->tp_dict;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001058 assert(dict && PyDict_Check(dict));
1059 descr = PyDict_GetItem(dict, name);
1060 if (descr != NULL)
1061 break;
1062 }
1063 }
1064
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001065 Py_XINCREF(descr);
1066
Tim Peters6d6c1a32001-08-02 04:15:00 +00001067 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001068 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001069 f = descr->ob_type->tp_descr_get;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001070 if (f != NULL && PyDescr_IsData(descr)) {
1071 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001072 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001073 goto done;
1074 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001075 }
1076
Guido van Rossumc66ff442002-08-19 16:50:48 +00001077 /* Inline _PyObject_GetDictPtr */
1078 dictoffset = tp->tp_dictoffset;
1079 if (dictoffset != 0) {
1080 PyObject *dict;
1081 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001082 Py_ssize_t tsize;
Guido van Rossumc66ff442002-08-19 16:50:48 +00001083 size_t size;
1084
1085 tsize = ((PyVarObject *)obj)->ob_size;
1086 if (tsize < 0)
1087 tsize = -tsize;
1088 size = _PyObject_VAR_SIZE(tp, tsize);
1089
1090 dictoffset += (long)size;
1091 assert(dictoffset > 0);
1092 assert(dictoffset % SIZEOF_VOID_P == 0);
1093 }
1094 dictptr = (PyObject **) ((char *)obj + dictoffset);
1095 dict = *dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001096 if (dict != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001097 res = PyDict_GetItem(dict, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001098 if (res != NULL) {
1099 Py_INCREF(res);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001100 Py_XDECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001101 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001102 }
1103 }
1104 }
1105
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001106 if (f != NULL) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001107 res = f(descr, obj, (PyObject *)Py_Type(obj));
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001108 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001109 goto done;
1110 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001111
1112 if (descr != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001113 res = descr;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001114 /* descr was already increfed above */
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001115 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001116 }
1117
1118 PyErr_Format(PyExc_AttributeError,
1119 "'%.50s' object has no attribute '%.400s'",
Martin v. Löwis5b222132007-06-10 09:51:05 +00001120 tp->tp_name, PyUnicode_AsString(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001121 done:
1122 Py_DECREF(name);
1123 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001124}
1125
1126int
1127PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1128{
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001129 PyTypeObject *tp = Py_Type(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001130 PyObject *descr;
1131 descrsetfunc f;
1132 PyObject **dictptr;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001133 int res = -1;
1134
Martin v. Löwis5b222132007-06-10 09:51:05 +00001135 if (!PyUnicode_Check(name)){
1136 PyErr_Format(PyExc_TypeError,
1137 "attribute name must be string, not '%.200s'",
1138 name->ob_type->tp_name);
1139 return -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001140 }
1141 else
1142 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001143
1144 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001145 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001146 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001147 }
1148
1149 descr = _PyType_Lookup(tp, name);
1150 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001151 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001152 f = descr->ob_type->tp_descr_set;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001153 if (f != NULL && PyDescr_IsData(descr)) {
1154 res = f(descr, obj, value);
1155 goto done;
1156 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001157 }
1158
1159 dictptr = _PyObject_GetDictPtr(obj);
1160 if (dictptr != NULL) {
1161 PyObject *dict = *dictptr;
1162 if (dict == NULL && value != NULL) {
1163 dict = PyDict_New();
1164 if (dict == NULL)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001165 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001166 *dictptr = dict;
1167 }
1168 if (dict != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001169 if (value == NULL)
1170 res = PyDict_DelItem(dict, name);
1171 else
1172 res = PyDict_SetItem(dict, name, value);
1173 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1174 PyErr_SetObject(PyExc_AttributeError, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001175 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001176 }
1177 }
1178
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001179 if (f != NULL) {
1180 res = f(descr, obj, value);
1181 goto done;
1182 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001183
1184 if (descr == NULL) {
1185 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001186 "'%.100s' object has no attribute '%U'",
1187 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001188 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001189 }
1190
1191 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001192 "'%.50s' object attribute '%U' is read-only",
1193 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001194 done:
1195 Py_DECREF(name);
1196 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001197}
1198
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001199/* Test a value used as condition, e.g., in a for or if statement.
1200 Return -1 if an error occurred */
1201
1202int
Fred Drake100814d2000-07-09 15:48:49 +00001203PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001204{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001205 Py_ssize_t res;
Guido van Rossum6248f442002-08-24 06:31:34 +00001206 if (v == Py_True)
1207 return 1;
1208 if (v == Py_False)
1209 return 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001210 if (v == Py_None)
Neal Norwitz51290d32002-06-13 21:32:44 +00001211 return 0;
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001212 else if (v->ob_type->tp_as_number != NULL &&
Jack Diederich4dafcc42006-11-28 19:15:13 +00001213 v->ob_type->tp_as_number->nb_bool != NULL)
1214 res = (*v->ob_type->tp_as_number->nb_bool)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001215 else if (v->ob_type->tp_as_mapping != NULL &&
1216 v->ob_type->tp_as_mapping->mp_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001217 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001218 else if (v->ob_type->tp_as_sequence != NULL &&
1219 v->ob_type->tp_as_sequence->sq_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001220 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1221 else
Neal Norwitz51290d32002-06-13 21:32:44 +00001222 return 1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001223 /* if it is negative, it should be either -1 or -2 */
1224 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001225}
1226
Tim Peters803526b2002-07-07 05:13:56 +00001227/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001228 Return -1 if an error occurred */
1229
1230int
Fred Drake100814d2000-07-09 15:48:49 +00001231PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001232{
1233 int res;
1234 res = PyObject_IsTrue(v);
1235 if (res < 0)
1236 return res;
1237 return res == 0;
1238}
1239
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001240/* Test whether an object can be called */
1241
1242int
Fred Drake100814d2000-07-09 15:48:49 +00001243PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001244{
1245 if (x == NULL)
1246 return 0;
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001247 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001248}
1249
Georg Brandle32b4222007-03-10 22:13:27 +00001250/* ------------------------- PyObject_Dir() helpers ------------------------- */
1251
Tim Peters7eea37e2001-09-04 22:08:56 +00001252/* Helper for PyObject_Dir.
1253 Merge the __dict__ of aclass into dict, and recursively also all
1254 the __dict__s of aclass's base classes. The order of merging isn't
1255 defined, as it's expected that only the final set of dict keys is
1256 interesting.
1257 Return 0 on success, -1 on error.
1258*/
1259
1260static int
1261merge_class_dict(PyObject* dict, PyObject* aclass)
1262{
1263 PyObject *classdict;
1264 PyObject *bases;
1265
1266 assert(PyDict_Check(dict));
1267 assert(aclass);
1268
1269 /* Merge in the type's dict (if any). */
1270 classdict = PyObject_GetAttrString(aclass, "__dict__");
1271 if (classdict == NULL)
1272 PyErr_Clear();
1273 else {
1274 int status = PyDict_Update(dict, classdict);
1275 Py_DECREF(classdict);
1276 if (status < 0)
1277 return -1;
1278 }
1279
1280 /* Recursively merge in the base types' (if any) dicts. */
1281 bases = PyObject_GetAttrString(aclass, "__bases__");
Tim Petersbc7e8632001-09-16 20:33:22 +00001282 if (bases == NULL)
1283 PyErr_Clear();
1284 else {
Guido van Rossum44022412002-05-13 18:29:46 +00001285 /* We have no guarantee that bases is a real tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001286 Py_ssize_t i, n;
Guido van Rossum44022412002-05-13 18:29:46 +00001287 n = PySequence_Size(bases); /* This better be right */
1288 if (n < 0)
1289 PyErr_Clear();
1290 else {
1291 for (i = 0; i < n; i++) {
Tim Peters18e70832003-02-05 19:35:19 +00001292 int status;
Guido van Rossum44022412002-05-13 18:29:46 +00001293 PyObject *base = PySequence_GetItem(bases, i);
1294 if (base == NULL) {
1295 Py_DECREF(bases);
1296 return -1;
1297 }
Tim Peters18e70832003-02-05 19:35:19 +00001298 status = merge_class_dict(dict, base);
1299 Py_DECREF(base);
1300 if (status < 0) {
Guido van Rossum44022412002-05-13 18:29:46 +00001301 Py_DECREF(bases);
1302 return -1;
1303 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001304 }
1305 }
1306 Py_DECREF(bases);
1307 }
1308 return 0;
1309}
1310
Georg Brandle32b4222007-03-10 22:13:27 +00001311/* Helper for PyObject_Dir without arguments: returns the local scope. */
1312static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001313_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001314{
Georg Brandled3b8382007-03-12 13:15:14 +00001315 PyObject *names;
Georg Brandle32b4222007-03-10 22:13:27 +00001316 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001317
Georg Brandle32b4222007-03-10 22:13:27 +00001318 if (locals == NULL) {
1319 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1320 return NULL;
Tim Peters305b5852001-09-17 02:38:46 +00001321 }
1322
Georg Brandled3b8382007-03-12 13:15:14 +00001323 names = PyMapping_Keys(locals);
1324 if (!names)
1325 return NULL;
1326 if (!PyList_Check(names)) {
1327 PyErr_Format(PyExc_TypeError,
1328 "dir(): expected keys() of locals to be a list, "
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001329 "not '%.200s'", Py_Type(names)->tp_name);
Georg Brandled3b8382007-03-12 13:15:14 +00001330 Py_DECREF(names);
1331 return NULL;
1332 }
Georg Brandle32b4222007-03-10 22:13:27 +00001333 /* the locals don't need to be DECREF'd */
Georg Brandled3b8382007-03-12 13:15:14 +00001334 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001335}
1336
1337/* Helper for PyObject_Dir of type objects: returns __dict__ and __bases__.
1338 We deliberately don't suck up its __class__, as methods belonging to the
1339 metaclass would probably be more confusing than helpful.
1340*/
1341static PyObject *
1342_specialized_dir_type(PyObject *obj)
1343{
1344 PyObject *result = NULL;
1345 PyObject *dict = PyDict_New();
1346
1347 if (dict != NULL && merge_class_dict(dict, obj) == 0)
1348 result = PyDict_Keys(dict);
1349
1350 Py_XDECREF(dict);
Tim Peters305b5852001-09-17 02:38:46 +00001351 return result;
1352}
1353
Georg Brandle32b4222007-03-10 22:13:27 +00001354/* Helper for PyObject_Dir of module objects: returns the module's __dict__. */
1355static PyObject *
1356_specialized_dir_module(PyObject *obj)
Tim Peters7eea37e2001-09-04 22:08:56 +00001357{
Georg Brandle32b4222007-03-10 22:13:27 +00001358 PyObject *result = NULL;
1359 PyObject *dict = PyObject_GetAttrString(obj, "__dict__");
Tim Peters7eea37e2001-09-04 22:08:56 +00001360
Georg Brandle32b4222007-03-10 22:13:27 +00001361 if (dict != NULL) {
1362 if (PyDict_Check(dict))
1363 result = PyDict_Keys(dict);
1364 else {
1365 PyErr_Format(PyExc_TypeError,
1366 "%.200s.__dict__ is not a dictionary",
1367 PyModule_GetName(obj));
Guido van Rossum8dbd3d82001-09-10 18:27:43 +00001368 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001369 }
1370
Georg Brandle32b4222007-03-10 22:13:27 +00001371 Py_XDECREF(dict);
1372 return result;
1373}
Tim Peters7eea37e2001-09-04 22:08:56 +00001374
Georg Brandle32b4222007-03-10 22:13:27 +00001375/* Helper for PyObject_Dir of generic objects: returns __dict__, __class__,
1376 and recursively up the __class__.__bases__ chain.
1377*/
1378static PyObject *
1379_generic_dir(PyObject *obj)
1380{
1381 PyObject *result = NULL;
1382 PyObject *dict = NULL;
1383 PyObject *itsclass = NULL;
1384
1385 /* Get __dict__ (which may or may not be a real dict...) */
1386 dict = PyObject_GetAttrString(obj, "__dict__");
1387 if (dict == NULL) {
1388 PyErr_Clear();
1389 dict = PyDict_New();
1390 }
1391 else if (!PyDict_Check(dict)) {
1392 Py_DECREF(dict);
1393 dict = PyDict_New();
1394 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001395 else {
Georg Brandle32b4222007-03-10 22:13:27 +00001396 /* Copy __dict__ to avoid mutating it. */
1397 PyObject *temp = PyDict_Copy(dict);
1398 Py_DECREF(dict);
1399 dict = temp;
Tim Peters7eea37e2001-09-04 22:08:56 +00001400 }
1401
Georg Brandle32b4222007-03-10 22:13:27 +00001402 if (dict == NULL)
Raymond Hettinger2a7dede2004-08-07 04:55:30 +00001403 goto error;
Tim Peters7eea37e2001-09-04 22:08:56 +00001404
Georg Brandle32b4222007-03-10 22:13:27 +00001405 /* Merge in attrs reachable from its class. */
1406 itsclass = PyObject_GetAttrString(obj, "__class__");
1407 if (itsclass == NULL)
1408 /* XXX(tomer): Perhaps fall back to obj->ob_type if no
1409 __class__ exists? */
1410 PyErr_Clear();
1411 else {
1412 if (merge_class_dict(dict, itsclass) != 0)
1413 goto error;
1414 }
1415
1416 result = PyDict_Keys(dict);
Tim Peters7eea37e2001-09-04 22:08:56 +00001417 /* fall through */
Georg Brandle32b4222007-03-10 22:13:27 +00001418error:
1419 Py_XDECREF(itsclass);
1420 Py_XDECREF(dict);
1421 return result;
1422}
1423
1424/* Helper for PyObject_Dir: object introspection.
1425 This calls one of the above specialized versions if no __dir__ method
1426 exists. */
1427static PyObject *
1428_dir_object(PyObject *obj)
1429{
1430 PyObject * result = NULL;
1431 PyObject * dirfunc = PyObject_GetAttrString((PyObject*)obj->ob_type,
1432 "__dir__");
1433
1434 assert(obj);
1435 if (dirfunc == NULL) {
1436 /* use default implementation */
1437 PyErr_Clear();
1438 if (PyModule_Check(obj))
1439 result = _specialized_dir_module(obj);
1440 else if (PyType_Check(obj))
1441 result = _specialized_dir_type(obj);
1442 else
1443 result = _generic_dir(obj);
1444 }
1445 else {
1446 /* use __dir__ */
1447 result = PyObject_CallFunctionObjArgs(dirfunc, obj, NULL);
1448 Py_DECREF(dirfunc);
1449 if (result == NULL)
1450 return NULL;
1451
1452 /* result must be a list */
1453 /* XXX(gbrandl): could also check if all items are strings */
1454 if (!PyList_Check(result)) {
1455 PyErr_Format(PyExc_TypeError,
1456 "__dir__() must return a list, not %.200s",
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001457 Py_Type(result)->tp_name);
Georg Brandle32b4222007-03-10 22:13:27 +00001458 Py_DECREF(result);
1459 result = NULL;
1460 }
1461 }
1462
1463 return result;
1464}
1465
1466/* Implementation of dir() -- if obj is NULL, returns the names in the current
1467 (local) scope. Otherwise, performs introspection of the object: returns a
1468 sorted list of attribute names (supposedly) accessible from the object
1469*/
1470PyObject *
1471PyObject_Dir(PyObject *obj)
1472{
1473 PyObject * result;
1474
1475 if (obj == NULL)
1476 /* no object -- introspect the locals */
1477 result = _dir_locals();
1478 else
1479 /* object -- introspect the object */
1480 result = _dir_object(obj);
1481
1482 assert(result == NULL || PyList_Check(result));
1483
1484 if (result != NULL && PyList_Sort(result) != 0) {
1485 /* sorting the list failed */
1486 Py_DECREF(result);
1487 result = NULL;
1488 }
1489
Tim Peters7eea37e2001-09-04 22:08:56 +00001490 return result;
1491}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001492
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001493/*
1494NoObject is usable as a non-NULL undefined value, used by the macro None.
1495There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001496so there is exactly one (which is indestructible, by the way).
Guido van Rossumba21a492001-08-16 08:17:26 +00001497(XXX This type and the type of NotImplemented below should be unified.)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001498*/
1499
Guido van Rossum0c182a11992-03-27 17:26:13 +00001500/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001501static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001502none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001503{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001504 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001505}
1506
Barry Warsaw9bf16442001-01-23 16:24:35 +00001507/* ARGUSED */
1508static void
Tim Peters803526b2002-07-07 05:13:56 +00001509none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001510{
1511 /* This should never get called, but we also don't want to SEGV if
1512 * we accidently decref None out of existance.
1513 */
Martin v. Löwis3f19b102002-08-07 16:21:51 +00001514 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001515}
1516
1517
Guido van Rossumba21a492001-08-16 08:17:26 +00001518static PyTypeObject PyNone_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001519 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001520 "NoneType",
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001521 0,
1522 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001523 none_dealloc, /*tp_dealloc*/ /*never called*/
Guido van Rossum7066dd71992-09-17 17:54:56 +00001524 0, /*tp_print*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001525 0, /*tp_getattr*/
1526 0, /*tp_setattr*/
1527 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001528 none_repr, /*tp_repr*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001529 0, /*tp_as_number*/
1530 0, /*tp_as_sequence*/
1531 0, /*tp_as_mapping*/
Guido van Rossum9bfef441993-03-29 10:43:31 +00001532 0, /*tp_hash */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001533};
1534
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001535PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001536 _PyObject_EXTRA_INIT
1537 1, &PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001538};
1539
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001540/* NotImplemented is an object that can be used to signal that an
1541 operation is not implemented for the given type combination. */
1542
1543static PyObject *
1544NotImplemented_repr(PyObject *op)
1545{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001546 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001547}
1548
1549static PyTypeObject PyNotImplemented_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001550 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001551 "NotImplementedType",
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001552 0,
1553 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001554 none_dealloc, /*tp_dealloc*/ /*never called*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001555 0, /*tp_print*/
1556 0, /*tp_getattr*/
1557 0, /*tp_setattr*/
1558 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001559 NotImplemented_repr, /*tp_repr*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001560 0, /*tp_as_number*/
1561 0, /*tp_as_sequence*/
1562 0, /*tp_as_mapping*/
1563 0, /*tp_hash */
1564};
1565
1566PyObject _Py_NotImplementedStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001567 _PyObject_EXTRA_INIT
1568 1, &PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001569};
1570
Guido van Rossumba21a492001-08-16 08:17:26 +00001571void
1572_Py_ReadyTypes(void)
1573{
1574 if (PyType_Ready(&PyType_Type) < 0)
1575 Py_FatalError("Can't initialize 'type'");
1576
Fred Drake0a4dd392004-07-02 18:57:45 +00001577 if (PyType_Ready(&_PyWeakref_RefType) < 0)
1578 Py_FatalError("Can't initialize 'weakref'");
1579
Guido van Rossum77f6a652002-04-03 22:41:51 +00001580 if (PyType_Ready(&PyBool_Type) < 0)
1581 Py_FatalError("Can't initialize 'bool'");
1582
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001583 if (PyType_Ready(&PyBytes_Type) < 0)
1584 Py_FatalError("Can't initialize 'bytes'");
1585
Guido van Rossumcacfc072002-05-24 19:01:59 +00001586 if (PyType_Ready(&PyString_Type) < 0)
1587 Py_FatalError("Can't initialize 'str'");
1588
Guido van Rossumba21a492001-08-16 08:17:26 +00001589 if (PyType_Ready(&PyList_Type) < 0)
1590 Py_FatalError("Can't initialize 'list'");
1591
1592 if (PyType_Ready(&PyNone_Type) < 0)
1593 Py_FatalError("Can't initialize type(None)");
1594
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001595 if (PyType_Ready(Py_Ellipsis->ob_type) < 0)
1596 Py_FatalError("Can't initialize type(Ellipsis)");
1597
Guido van Rossumba21a492001-08-16 08:17:26 +00001598 if (PyType_Ready(&PyNotImplemented_Type) < 0)
1599 Py_FatalError("Can't initialize type(NotImplemented)");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001600
1601 if (PyType_Ready(&PyCode_Type) < 0)
1602 Py_FatalError("Can't initialize 'code'");
Guido van Rossum826d8972007-10-30 18:34:07 +00001603
1604 if (PyType_Ready(&PyStdPrinter_Type) < 0)
1605 Py_FatalError("Can't initialize StdPrinter");
Guido van Rossumba21a492001-08-16 08:17:26 +00001606}
1607
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001608
Guido van Rossum84a90321996-05-22 16:34:47 +00001609#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001610
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001611void
Fred Drake100814d2000-07-09 15:48:49 +00001612_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001613{
Tim Peters34592512002-07-11 06:23:50 +00001614 _Py_INC_REFTOTAL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001615 op->ob_refcnt = 1;
Tim Peters7571a0f2003-03-23 17:52:28 +00001616 _Py_AddToAllObjects(op, 1);
Tim Peters34592512002-07-11 06:23:50 +00001617 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001618}
1619
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001620void
Fred Drake100814d2000-07-09 15:48:49 +00001621_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001622{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001623#ifdef SLOW_UNREF_CHECK
Guido van Rossum4c08d552000-03-10 22:55:18 +00001624 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001625#endif
Guido van Rossumd7047b31995-01-02 19:07:15 +00001626 if (op->ob_refcnt < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001627 Py_FatalError("UNREF negative refcnt");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001628 if (op == &refchain ||
Guido van Rossumd7047b31995-01-02 19:07:15 +00001629 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001630 Py_FatalError("UNREF invalid object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001631#ifdef SLOW_UNREF_CHECK
Guido van Rossum3f5da241990-12-20 15:06:42 +00001632 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1633 if (p == op)
1634 break;
1635 }
Guido van Rossumd7047b31995-01-02 19:07:15 +00001636 if (p == &refchain) /* Not found */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001637 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001638#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001639 op->_ob_next->_ob_prev = op->_ob_prev;
1640 op->_ob_prev->_ob_next = op->_ob_next;
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001641 op->_ob_next = op->_ob_prev = NULL;
Tim Peters34592512002-07-11 06:23:50 +00001642 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001643}
1644
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001645void
Fred Drake100814d2000-07-09 15:48:49 +00001646_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001647{
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001648 destructor dealloc = Py_Type(op)->tp_dealloc;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001649 _Py_ForgetReference(op);
Guido van Rossum9776adf1994-09-07 14:36:45 +00001650 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001651}
1652
Tim Peters269b2a62003-04-17 19:52:29 +00001653/* Print all live objects. Because PyObject_Print is called, the
1654 * interpreter must be in a healthy state.
1655 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001656void
Fred Drake100814d2000-07-09 15:48:49 +00001657_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001658{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001659 PyObject *op;
Guido van Rossume09fb551997-08-05 02:04:34 +00001660 fprintf(fp, "Remaining objects:\n");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001661 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001662 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001663 if (PyObject_Print(op, fp, 0) != 0)
1664 PyErr_Clear();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001665 putc('\n', fp);
1666 }
1667}
1668
Tim Peters269b2a62003-04-17 19:52:29 +00001669/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1670 * doesn't make any calls to the Python C API, so is always safe to call.
1671 */
1672void
1673_Py_PrintReferenceAddresses(FILE *fp)
1674{
1675 PyObject *op;
1676 fprintf(fp, "Remaining object addresses:\n");
1677 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001678 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001679 op->ob_refcnt, Py_Type(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001680}
1681
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001682PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001683_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001684{
1685 int i, n;
1686 PyObject *t = NULL;
1687 PyObject *res, *op;
1688
1689 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1690 return NULL;
1691 op = refchain._ob_next;
1692 res = PyList_New(0);
1693 if (res == NULL)
1694 return NULL;
1695 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1696 while (op == self || op == args || op == res || op == t ||
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001697 (t != NULL && Py_Type(op) != (PyTypeObject *) t)) {
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001698 op = op->_ob_next;
1699 if (op == &refchain)
1700 return res;
1701 }
1702 if (PyList_Append(res, op) < 0) {
1703 Py_DECREF(res);
1704 return NULL;
1705 }
1706 op = op->_ob_next;
1707 }
1708 return res;
1709}
1710
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001711#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001712
1713
1714/* Hack to force loading of cobject.o */
Guido van Rossumda9c2711996-12-05 21:58:58 +00001715PyTypeObject *_Py_cobject_hack = &PyCObject_Type;
Guido van Rossum84a90321996-05-22 16:34:47 +00001716
1717
1718/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001719Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001720
1721
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001722/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001723
Thomas Wouters334fb892000-07-25 12:56:38 +00001724void *
Fred Drake100814d2000-07-09 15:48:49 +00001725PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001726{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001727 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001728}
1729
Thomas Wouters334fb892000-07-25 12:56:38 +00001730void *
1731PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001732{
Tim Petersaf3e8de2002-04-12 07:22:56 +00001733 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001734}
1735
1736void
Thomas Wouters334fb892000-07-25 12:56:38 +00001737PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001738{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001739 PyMem_FREE(p);
1740}
1741
1742
Guido van Rossum86610361998-04-10 22:32:46 +00001743/* These methods are used to control infinite recursion in repr, str, print,
1744 etc. Container objects that may recursively contain themselves,
1745 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1746 Py_ReprLeave() to avoid infinite recursion.
1747
1748 Py_ReprEnter() returns 0 the first time it is called for a particular
1749 object and 1 every time thereafter. It returns -1 if an exception
1750 occurred. Py_ReprLeave() has no return value.
1751
1752 See dictobject.c and listobject.c for examples of use.
1753*/
1754
1755#define KEY "Py_Repr"
1756
1757int
Fred Drake100814d2000-07-09 15:48:49 +00001758Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001759{
1760 PyObject *dict;
1761 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001762 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001763
1764 dict = PyThreadState_GetDict();
1765 if (dict == NULL)
Guido van Rossum0fc8f002003-04-15 15:12:39 +00001766 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001767 list = PyDict_GetItemString(dict, KEY);
1768 if (list == NULL) {
1769 list = PyList_New(0);
1770 if (list == NULL)
1771 return -1;
1772 if (PyDict_SetItemString(dict, KEY, list) < 0)
1773 return -1;
1774 Py_DECREF(list);
1775 }
1776 i = PyList_GET_SIZE(list);
1777 while (--i >= 0) {
1778 if (PyList_GET_ITEM(list, i) == obj)
1779 return 1;
1780 }
1781 PyList_Append(list, obj);
1782 return 0;
1783}
1784
1785void
Fred Drake100814d2000-07-09 15:48:49 +00001786Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001787{
1788 PyObject *dict;
1789 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001790 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001791
1792 dict = PyThreadState_GetDict();
Guido van Rossumeb909461998-04-11 15:17:34 +00001793 if (dict == NULL)
1794 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001795 list = PyDict_GetItemString(dict, KEY);
Guido van Rossumeb909461998-04-11 15:17:34 +00001796 if (list == NULL || !PyList_Check(list))
1797 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001798 i = PyList_GET_SIZE(list);
1799 /* Count backwards because we always expect obj to be list[-1] */
1800 while (--i >= 0) {
1801 if (PyList_GET_ITEM(list, i) == obj) {
1802 PyList_SetSlice(list, i, i + 1, NULL);
1803 break;
1804 }
1805 }
1806}
Guido van Rossumd724b232000-03-13 16:01:29 +00001807
Tim Peters803526b2002-07-07 05:13:56 +00001808/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001809
Tim Peters803526b2002-07-07 05:13:56 +00001810/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001811int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001812
Tim Peters803526b2002-07-07 05:13:56 +00001813/* List of objects that still need to be cleaned up, singly linked via their
1814 * gc headers' gc_prev pointers.
1815 */
1816PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001817
Tim Peters803526b2002-07-07 05:13:56 +00001818/* Add op to the _PyTrash_delete_later list. Called when the current
1819 * call-stack depth gets large. op must be a currently untracked gc'ed
1820 * object, with refcount 0. Py_DECREF must already have been called on it.
1821 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001822void
Fred Drake100814d2000-07-09 15:48:49 +00001823_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001824{
Tim Peters803526b2002-07-07 05:13:56 +00001825 assert(PyObject_IS_GC(op));
1826 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1827 assert(op->ob_refcnt == 0);
Neil Schemenauerf589c052002-03-29 03:05:54 +00001828 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
Guido van Rossume92e6102000-04-24 15:40:53 +00001829 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001830}
1831
Tim Peters803526b2002-07-07 05:13:56 +00001832/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1833 * the call-stack unwinds again.
1834 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001835void
Fred Drake100814d2000-07-09 15:48:49 +00001836_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001837{
1838 while (_PyTrash_delete_later) {
Tim Peters803526b2002-07-07 05:13:56 +00001839 PyObject *op = _PyTrash_delete_later;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001840 destructor dealloc = Py_Type(op)->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001841
Neil Schemenauerf589c052002-03-29 03:05:54 +00001842 _PyTrash_delete_later =
Tim Peters803526b2002-07-07 05:13:56 +00001843 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001844
Tim Peters803526b2002-07-07 05:13:56 +00001845 /* Call the deallocator directly. This used to try to
1846 * fool Py_DECREF into calling it indirectly, but
1847 * Py_DECREF was already called on this object, and in
1848 * assorted non-release builds calling Py_DECREF again ends
1849 * up distorting allocation statistics.
1850 */
1851 assert(op->ob_refcnt == 0);
Guido van Rossumd724b232000-03-13 16:01:29 +00001852 ++_PyTrash_delete_nesting;
Tim Peters803526b2002-07-07 05:13:56 +00001853 (*dealloc)(op);
Guido van Rossumd724b232000-03-13 16:01:29 +00001854 --_PyTrash_delete_nesting;
1855 }
1856}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001857
1858#ifdef __cplusplus
1859}
1860#endif