blob: dd68ecd8a407ac3b29d656447989d798de1a6aa3 [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);
Guido van Rossum04dbf3b2007-08-07 19:51:00 +0000282 else {
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000283 PyObject *s;
284 if (flags & Py_PRINT_RAW)
285 s = PyObject_Str(op);
286 else
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000287 s = PyObject_Repr(op);
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000288 if (s == NULL)
289 ret = -1;
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000290 else if (PyString_Check(s)) {
291 fwrite(PyString_AS_STRING(s), 1,
292 PyString_GET_SIZE(s), fp);
293 }
294 else if (PyUnicode_Check(s)) {
295 PyObject *t;
296 t = _PyUnicode_AsDefaultEncodedString(s, NULL);
297 if (t == NULL)
298 ret = 0;
299 else {
300 fwrite(PyString_AS_STRING(t), 1,
301 PyString_GET_SIZE(t), fp);
302 }
303 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000304 else {
Guido van Rossum6ca130d2007-08-09 20:47:59 +0000305 PyErr_Format(PyExc_TypeError,
306 "str() or repr() returned '%.100s'",
307 s->ob_type->tp_name);
308 ret = -1;
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000309 }
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000310 Py_XDECREF(s);
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000311 }
Guido van Rossum90933611991-06-07 16:10:43 +0000312 }
Guido van Rossum278ef591991-07-27 21:40:24 +0000313 if (ret == 0) {
314 if (ferror(fp)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000315 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum278ef591991-07-27 21:40:24 +0000316 clearerr(fp);
317 ret = -1;
318 }
319 }
320 return ret;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000321}
322
Neal Norwitz1a997502003-01-13 20:13:12 +0000323int
324PyObject_Print(PyObject *op, FILE *fp, int flags)
325{
326 return internal_print(op, fp, flags, 0);
327}
328
Guido van Rossum38938152006-08-21 23:36:26 +0000329/* For debugging convenience. Set a breakpoint here and call it from your DLL */
330void
Thomas Woutersb2137042007-02-01 18:02:27 +0000331_Py_BreakPoint(void)
Guido van Rossum38938152006-08-21 23:36:26 +0000332{
333}
334
Neal Norwitz1a997502003-01-13 20:13:12 +0000335
Barry Warsaw9bf16442001-01-23 16:24:35 +0000336/* For debugging convenience. See Misc/gdbinit for some useful gdb hooks */
Guido van Rossum38938152006-08-21 23:36:26 +0000337void
338_PyObject_Dump(PyObject* op)
Barry Warsaw9bf16442001-01-23 16:24:35 +0000339{
Barry Warsaweefb1072001-02-22 22:39:18 +0000340 if (op == NULL)
341 fprintf(stderr, "NULL\n");
342 else {
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000343 fprintf(stderr, "object : ");
Barry Warsaweefb1072001-02-22 22:39:18 +0000344 (void)PyObject_Print(op, stderr, 0);
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000345 /* XXX(twouters) cast refcount to long until %zd is
346 universally available */
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000347 fprintf(stderr, "\n"
348 "type : %s\n"
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000349 "refcount: %ld\n"
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000350 "address : %p\n",
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000351 Py_Type(op)==NULL ? "NULL" : Py_Type(op)->tp_name,
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000352 (long)op->ob_refcnt,
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000353 op);
Barry Warsaweefb1072001-02-22 22:39:18 +0000354 }
Barry Warsaw9bf16442001-01-23 16:24:35 +0000355}
Barry Warsaw903138f2001-01-23 16:33:18 +0000356
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000357PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000358PyObject_Repr(PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000359{
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000360 PyObject *res;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000361 if (PyErr_CheckSignals())
Guido van Rossum90933611991-06-07 16:10:43 +0000362 return NULL;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000363#ifdef USE_STACKCHECK
364 if (PyOS_CheckStack()) {
Fred Drake661ea262000-10-24 19:57:45 +0000365 PyErr_SetString(PyExc_MemoryError, "stack overflow");
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000366 return NULL;
367 }
368#endif
Guido van Rossum90933611991-06-07 16:10:43 +0000369 if (v == NULL)
Walter Dörwald1ab83302007-05-18 17:15:44 +0000370 return PyUnicode_FromString("<NULL>");
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000371 else if (Py_Type(v)->tp_repr == NULL)
Walter Dörwald1ab83302007-05-18 17:15:44 +0000372 return PyUnicode_FromFormat("<%s object at %p>", v->ob_type->tp_name, v);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000373 else {
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000374 res = (*v->ob_type->tp_repr)(v);
375 if (res != NULL && !PyUnicode_Check(res)) {
Guido van Rossum4c08d552000-03-10 22:55:18 +0000376 PyErr_Format(PyExc_TypeError,
Guido van Rossum5db862d2000-04-10 12:46:51 +0000377 "__repr__ returned non-string (type %.200s)",
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000378 res->ob_type->tp_name);
379 Py_DECREF(res);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000380 return NULL;
381 }
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000382 return res;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000383 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000384}
385
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000386PyObject *
Walter Dörwald1ab83302007-05-18 17:15:44 +0000387PyObject_ReprStr8(PyObject *v)
388{
389 PyObject *resu = PyObject_Repr(v);
390 if (resu) {
391 PyObject *resb = PyUnicode_AsEncodedString(resu, NULL, NULL);
392 Py_DECREF(resu);
393 if (resb) {
394 PyObject *ress = PyString_FromStringAndSize(
395 PyBytes_AS_STRING(resb),
396 PyBytes_GET_SIZE(resb)
397 );
398 Py_DECREF(resb);
399 return ress;
400 }
401 }
402 return NULL;
403}
404
405PyObject *
Neil Schemenauercf52c072005-08-12 17:34:58 +0000406_PyObject_Str(PyObject *v)
Guido van Rossumc6004111993-11-05 10:22:19 +0000407{
Guido van Rossum4c08d552000-03-10 22:55:18 +0000408 PyObject *res;
Guido van Rossumc6004111993-11-05 10:22:19 +0000409 if (v == NULL)
Neal Norwitz6ea45d32007-08-26 04:19:43 +0000410 return PyUnicode_FromString("<NULL>");
Tim Peters5a49ade2001-09-11 01:41:59 +0000411 if (PyString_CheckExact(v)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000412 Py_INCREF(v);
Guido van Rossumc6004111993-11-05 10:22:19 +0000413 return v;
414 }
Neil Schemenauercf52c072005-08-12 17:34:58 +0000415 if (PyUnicode_CheckExact(v)) {
416 Py_INCREF(v);
417 return v;
418 }
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000419 if (Py_Type(v)->tp_str == NULL)
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000420 return PyObject_Repr(v);
421
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000422 res = (*Py_Type(v)->tp_str)(v);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000423 if (res == NULL)
424 return NULL;
Guido van Rossum55b4a7b2007-07-11 09:28:11 +0000425 if (!(PyString_Check(res) || PyUnicode_Check(res))) {
Neil Schemenauercf52c072005-08-12 17:34:58 +0000426 PyErr_Format(PyExc_TypeError,
427 "__str__ returned non-string (type %.200s)",
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000428 Py_Type(res)->tp_name);
Neil Schemenauercf52c072005-08-12 17:34:58 +0000429 Py_DECREF(res);
430 return NULL;
431 }
432 return res;
433}
434
435PyObject *
436PyObject_Str(PyObject *v)
437{
438 PyObject *res = _PyObject_Str(v);
439 if (res == NULL)
440 return NULL;
Marc-André Lemburg891bc652000-07-03 09:57:53 +0000441 if (PyUnicode_Check(res)) {
442 PyObject* str;
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000443 str = _PyUnicode_AsDefaultEncodedString(res, NULL);
444 Py_XINCREF(str);
Marc-André Lemburg891bc652000-07-03 09:57:53 +0000445 Py_DECREF(res);
446 if (str)
447 res = str;
448 else
449 return NULL;
450 }
Neil Schemenauercf52c072005-08-12 17:34:58 +0000451 assert(PyString_Check(res));
Guido van Rossum4c08d552000-03-10 22:55:18 +0000452 return res;
Guido van Rossumc6004111993-11-05 10:22:19 +0000453}
454
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000455PyObject *
456PyObject_Unicode(PyObject *v)
457{
458 PyObject *res;
Brett Cannonc3647ac2005-04-26 03:45:26 +0000459 PyObject *func;
Neal Norwitz75801462006-03-14 06:02:16 +0000460 PyObject *str;
Brett Cannonc3647ac2005-04-26 03:45:26 +0000461 static PyObject *unicodestr;
Tim Peters803526b2002-07-07 05:13:56 +0000462
Walter Dörwaldb03ccc02007-05-11 17:25:52 +0000463 if (v == NULL)
464 return PyUnicode_FromString("<NULL>");
465 else if (PyUnicode_CheckExact(v)) {
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000466 Py_INCREF(v);
467 return v;
468 }
Brett Cannonc3647ac2005-04-26 03:45:26 +0000469 /* XXX As soon as we have a tp_unicode slot, we should
470 check this before trying the __unicode__
471 method. */
472 if (unicodestr == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +0000473 unicodestr= PyUnicode_InternFromString("__unicode__");
Brett Cannonc3647ac2005-04-26 03:45:26 +0000474 if (unicodestr == NULL)
475 return NULL;
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000476 }
Brett Cannonc3647ac2005-04-26 03:45:26 +0000477 func = PyObject_GetAttr(v, unicodestr);
478 if (func != NULL) {
479 res = PyEval_CallObject(func, (PyObject *)NULL);
480 Py_DECREF(func);
481 }
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000482 else {
Brett Cannonc3647ac2005-04-26 03:45:26 +0000483 PyErr_Clear();
Guido van Rossum55b4a7b2007-07-11 09:28:11 +0000484 if (PyUnicode_Check(v) &&
485 v->ob_type->tp_str == PyUnicode_Type.tp_str) {
486 /* For a Unicode subtype that's didn't overwrite
487 __unicode__ or __str__,
Brett Cannonc3647ac2005-04-26 03:45:26 +0000488 return a true Unicode object with the same data. */
489 return PyUnicode_FromUnicode(PyUnicode_AS_UNICODE(v),
490 PyUnicode_GET_SIZE(v));
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000491 }
Brett Cannonc3647ac2005-04-26 03:45:26 +0000492 if (PyString_CheckExact(v)) {
493 Py_INCREF(v);
494 res = v;
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000495 }
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000496 else {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000497 if (Py_Type(v)->tp_str != NULL)
498 res = (*Py_Type(v)->tp_str)(v);
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000499 else
500 res = PyObject_Repr(v);
501 }
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000502 }
503 if (res == NULL)
504 return NULL;
505 if (!PyUnicode_Check(res)) {
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000506 str = PyUnicode_FromEncodedObject(res, NULL, "strict");
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000507 Py_DECREF(res);
Neal Norwitz75801462006-03-14 06:02:16 +0000508 res = str;
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000509 }
510 return res;
511}
512
513
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000514/* The new comparison philosophy is: we completely separate three-way
515 comparison from rich comparison. That is, PyObject_Compare() and
516 PyObject_Cmp() *just* use the tp_compare slot. And PyObject_RichCompare()
517 and PyObject_RichCompareBool() *just* use the tp_richcompare slot.
518
519 See (*) below for practical amendments.
520
521 IOW, only cmp() uses tp_compare; the comparison operators (==, !=, <=, <,
522 >=, >) only use tp_richcompare. Note that list.sort() only uses <.
523
524 (And yes, eventually we'll rip out cmp() and tp_compare.)
525
526 The calling conventions are different: tp_compare only gets called with two
527 objects of the appropriate type; tp_richcompare gets called with a first
528 argument of the appropriate type and a second object of an arbitrary type.
529 We never do any kind of coercion.
530
531 The return conventions are also different.
532
533 The tp_compare slot should return a C int, as follows:
534
535 -1 if a < b or if an exception occurred
536 0 if a == b
537 +1 if a > b
538
539 No other return values are allowed. PyObject_Compare() has the same
540 calling convention.
541
542 The tp_richcompare slot should return an object, as follows:
543
544 NULL if an exception occurred
545 NotImplemented if the requested comparison is not implemented
546 any other false value if the requested comparison is false
547 any other true value if the requested comparison is true
548
549 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
550 NotImplemented.
551
552 (*) Practical amendments:
553
554 - If rich comparison returns NotImplemented, == and != are decided by
555 comparing the object pointer (i.e. falling back to the base object
556 implementation).
557
558 - If three-way comparison is not implemented, it falls back on rich
559 comparison (but not the other way around!).
560
Guido van Rossuma4073002002-05-31 20:03:54 +0000561*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000562
563/* Forward */
564static PyObject *do_richcompare(PyObject *v, PyObject *w, int op);
565
566/* Perform a three-way comparison, raising TypeError if three-way comparison
567 is not supported. */
Guido van Rossuma4073002002-05-31 20:03:54 +0000568static int
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000569do_compare(PyObject *v, PyObject *w)
Guido van Rossuma4073002002-05-31 20:03:54 +0000570{
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000571 cmpfunc f;
572 int ok;
573
574 if (v->ob_type == w->ob_type &&
575 (f = v->ob_type->tp_compare) != NULL) {
576 return (*f)(v, w);
Guido van Rossuma4073002002-05-31 20:03:54 +0000577 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000578
579 /* Now try three-way compare before giving up. This is intentionally
580 elaborate; if you have a it will raise TypeError if it detects two
581 objects that aren't ordered with respect to each other. */
582 ok = PyObject_RichCompareBool(v, w, Py_LT);
583 if (ok < 0)
584 return -1; /* Error */
585 if (ok)
586 return -1; /* Less than */
587 ok = PyObject_RichCompareBool(v, w, Py_GT);
588 if (ok < 0)
589 return -1; /* Error */
590 if (ok)
591 return 1; /* Greater than */
592 ok = PyObject_RichCompareBool(v, w, Py_EQ);
593 if (ok < 0)
594 return -1; /* Error */
595 if (ok)
596 return 0; /* Equal */
597
598 /* Give up */
599 PyErr_Format(PyExc_TypeError,
Neal Norwitz3bd844e2006-08-29 04:39:12 +0000600 "unorderable types: '%.100s' != '%.100s'",
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000601 v->ob_type->tp_name,
602 w->ob_type->tp_name);
603 return -1;
Guido van Rossuma4073002002-05-31 20:03:54 +0000604}
605
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000606/* Perform a three-way comparison. This wraps do_compare() with a check for
607 NULL arguments and a recursion check. */
608int
609PyObject_Compare(PyObject *v, PyObject *w)
610{
611 int res;
Guido van Rossuma4073002002-05-31 20:03:54 +0000612
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000613 if (v == NULL || w == NULL) {
614 if (!PyErr_Occurred())
615 PyErr_BadInternalCall();
616 return -1;
617 }
618 if (Py_EnterRecursiveCall(" in cmp"))
619 return -1;
620 res = do_compare(v, w);
621 Py_LeaveRecursiveCall();
622 return res < 0 ? -1 : res;
623}
Guido van Rossumd1f06b92001-01-24 22:14:43 +0000624
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000625/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000626int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000627
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000628static char *opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000629
630/* Perform a rich comparison, raising TypeError when the requested comparison
631 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000632static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000633do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000634{
635 richcmpfunc f;
636 PyObject *res;
637
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000638 if (v->ob_type != w->ob_type &&
639 PyType_IsSubtype(w->ob_type, v->ob_type) &&
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000640 (f = w->ob_type->tp_richcompare) != NULL) {
Tim Petersf4aca752004-09-23 02:39:37 +0000641 res = (*f)(w, v, _Py_SwappedOp[op]);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000642 if (res != Py_NotImplemented)
643 return res;
644 Py_DECREF(res);
645 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000646 if ((f = v->ob_type->tp_richcompare) != NULL) {
Guido van Rossume797ec12001-01-17 15:24:28 +0000647 res = (*f)(v, w, op);
648 if (res != Py_NotImplemented)
649 return res;
650 Py_DECREF(res);
651 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000652 if ((f = w->ob_type->tp_richcompare) != NULL) {
653 res = (*f)(w, v, _Py_SwappedOp[op]);
654 if (res != Py_NotImplemented)
655 return res;
656 Py_DECREF(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000657 }
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000658 /* If neither object implements it, provide a sensible default
659 for == and !=, but raise an exception for ordering. */
660 switch (op) {
661 case Py_EQ:
662 res = (v == w) ? Py_True : Py_False;
663 break;
664 case Py_NE:
665 res = (v != w) ? Py_True : Py_False;
666 break;
667 default:
Guido van Rossum9a4e95c2006-12-19 21:35:46 +0000668 /* XXX Special-case None so it doesn't show as NoneType() */
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000669 PyErr_Format(PyExc_TypeError,
670 "unorderable types: %.100s() %s %.100s()",
671 v->ob_type->tp_name,
672 opstrings[op],
673 w->ob_type->tp_name);
674 return NULL;
675 }
Guido van Rossume797ec12001-01-17 15:24:28 +0000676 Py_INCREF(res);
677 return res;
678}
679
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000680/* Perform a rich comparison with object result. This wraps do_richcompare()
681 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000682
Guido van Rossume797ec12001-01-17 15:24:28 +0000683PyObject *
684PyObject_RichCompare(PyObject *v, PyObject *w, int op)
685{
686 PyObject *res;
687
688 assert(Py_LT <= op && op <= Py_GE);
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000689 if (v == NULL || w == NULL) {
690 if (!PyErr_Occurred())
691 PyErr_BadInternalCall();
692 return NULL;
693 }
Armin Rigo2b3eb402003-10-28 12:05:48 +0000694 if (Py_EnterRecursiveCall(" in cmp"))
695 return NULL;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000696 res = do_richcompare(v, w, op);
Armin Rigo2b3eb402003-10-28 12:05:48 +0000697 Py_LeaveRecursiveCall();
Guido van Rossume797ec12001-01-17 15:24:28 +0000698 return res;
699}
700
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000701/* Perform a rich comparison with integer result. This wraps
702 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000703int
704PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
705{
Raymond Hettinger93d44812004-03-21 17:01:44 +0000706 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000707 int ok;
708
Raymond Hettinger93d44812004-03-21 17:01:44 +0000709 res = PyObject_RichCompare(v, w, op);
Guido van Rossume797ec12001-01-17 15:24:28 +0000710 if (res == NULL)
711 return -1;
Guido van Rossum81912d42002-08-24 05:33:28 +0000712 if (PyBool_Check(res))
713 ok = (res == Py_True);
714 else
715 ok = PyObject_IsTrue(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000716 Py_DECREF(res);
717 return ok;
718}
Fred Drake13634cf2000-06-29 19:17:04 +0000719
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000720/* Turn the result of a three-way comparison into the result expected by a
721 rich comparison. */
722PyObject *
723Py_CmpToRich(int op, int cmp)
724{
725 PyObject *res;
726 int ok;
727
728 if (PyErr_Occurred())
729 return NULL;
730 switch (op) {
731 case Py_LT:
732 ok = cmp < 0;
733 break;
734 case Py_LE:
735 ok = cmp <= 0;
736 break;
737 case Py_EQ:
738 ok = cmp == 0;
739 break;
740 case Py_NE:
741 ok = cmp != 0;
742 break;
743 case Py_GT:
744 ok = cmp > 0;
745 break;
746 case Py_GE:
747 ok = cmp >= 0;
748 break;
749 default:
750 PyErr_BadArgument();
751 return NULL;
752 }
753 res = ok ? Py_True : Py_False;
754 Py_INCREF(res);
755 return res;
756}
757
Fred Drake13634cf2000-06-29 19:17:04 +0000758/* Set of hash utility functions to help maintaining the invariant that
Raymond Hettinger8183fa42004-03-21 17:35:06 +0000759 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000760
761 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
762*/
763
764long
Fred Drake100814d2000-07-09 15:48:49 +0000765_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000766{
Tim Peters39dce292000-08-15 03:34:48 +0000767 double intpart, fractpart;
768 int expo;
769 long hipart;
770 long x; /* the final hash value */
771 /* This is designed so that Python numbers of different types
772 * that compare equal hash to the same value; otherwise comparisons
773 * of mapping keys will turn out weird.
774 */
775
Tim Peters39dce292000-08-15 03:34:48 +0000776 fractpart = modf(v, &intpart);
Tim Peters39dce292000-08-15 03:34:48 +0000777 if (fractpart == 0.0) {
778 /* This must return the same hash as an equal int or long. */
779 if (intpart > LONG_MAX || -intpart > LONG_MAX) {
780 /* Convert to long and use its hash. */
781 PyObject *plong; /* converted to Python long */
782 if (Py_IS_INFINITY(intpart))
783 /* can't convert to long int -- arbitrary */
784 v = v < 0 ? -271828.0 : 314159.0;
785 plong = PyLong_FromDouble(v);
786 if (plong == NULL)
787 return -1;
788 x = PyObject_Hash(plong);
789 Py_DECREF(plong);
790 return x;
791 }
792 /* Fits in a C long == a Python int, so is its own hash. */
793 x = (long)intpart;
794 if (x == -1)
795 x = -2;
796 return x;
797 }
798 /* The fractional part is non-zero, so we don't have to worry about
799 * making this match the hash of some other type.
800 * Use frexp to get at the bits in the double.
Fred Drake13634cf2000-06-29 19:17:04 +0000801 * Since the VAX D double format has 56 mantissa bits, which is the
802 * most of any double format in use, each of these parts may have as
803 * many as (but no more than) 56 significant bits.
Tim Peters39dce292000-08-15 03:34:48 +0000804 * So, assuming sizeof(long) >= 4, each part can be broken into two
805 * longs; frexp and multiplication are used to do that.
806 * Also, since the Cray double format has 15 exponent bits, which is
807 * the most of any double format in use, shifting the exponent field
808 * left by 15 won't overflow a long (again assuming sizeof(long) >= 4).
Fred Drake13634cf2000-06-29 19:17:04 +0000809 */
Tim Peters39dce292000-08-15 03:34:48 +0000810 v = frexp(v, &expo);
811 v *= 2147483648.0; /* 2**31 */
812 hipart = (long)v; /* take the top 32 bits */
813 v = (v - (double)hipart) * 2147483648.0; /* get the next 32 bits */
814 x = hipart + (long)v + (expo << 15);
815 if (x == -1)
816 x = -2;
817 return x;
Fred Drake13634cf2000-06-29 19:17:04 +0000818}
819
820long
Fred Drake100814d2000-07-09 15:48:49 +0000821_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +0000822{
823#if SIZEOF_LONG >= SIZEOF_VOID_P
824 return (long)p;
825#else
826 /* convert to a Python long and hash that */
827 PyObject* longobj;
828 long x;
Tim Peters803526b2002-07-07 05:13:56 +0000829
Fred Drake13634cf2000-06-29 19:17:04 +0000830 if ((longobj = PyLong_FromVoidPtr(p)) == NULL) {
831 x = -1;
832 goto finally;
833 }
834 x = PyObject_Hash(longobj);
Tim Peters803526b2002-07-07 05:13:56 +0000835
Fred Drake13634cf2000-06-29 19:17:04 +0000836finally:
837 Py_XDECREF(longobj);
838 return x;
839#endif
840}
841
842
Guido van Rossum9bfef441993-03-29 10:43:31 +0000843long
Fred Drake100814d2000-07-09 15:48:49 +0000844PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000845{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000846 PyTypeObject *tp = v->ob_type;
Guido van Rossum9bfef441993-03-29 10:43:31 +0000847 if (tp->tp_hash != NULL)
848 return (*tp->tp_hash)(v);
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000849 /* Otherwise, the object can't be hashed */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000850 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
851 v->ob_type->tp_name);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000852 return -1;
853}
854
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000855PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000856PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000857{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000858 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000859
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000860 if (Py_Type(v)->tp_getattr != NULL)
861 return (*Py_Type(v)->tp_getattr)(v, (char*)name);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000862 w = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000863 if (w == NULL)
864 return NULL;
865 res = PyObject_GetAttr(v, w);
866 Py_XDECREF(w);
867 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000868}
869
870int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000871PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000872{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000873 PyObject *res = PyObject_GetAttrString(v, name);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000874 if (res != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000875 Py_DECREF(res);
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000876 return 1;
877 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000878 PyErr_Clear();
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000879 return 0;
880}
881
882int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000883PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000884{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000885 PyObject *s;
886 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000887
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000888 if (Py_Type(v)->tp_setattr != NULL)
889 return (*Py_Type(v)->tp_setattr)(v, (char*)name, w);
Martin v. Löwis5b222132007-06-10 09:51:05 +0000890 s = PyUnicode_InternFromString(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000891 if (s == NULL)
892 return -1;
893 res = PyObject_SetAttr(v, s, w);
894 Py_XDECREF(s);
895 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000896}
897
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000898PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000899PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000900{
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000901 PyTypeObject *tp = Py_Type(v);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000902
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000903 if (!PyUnicode_Check(name)) {
Martin v. Löwis5b222132007-06-10 09:51:05 +0000904 PyErr_Format(PyExc_TypeError,
905 "attribute name must be string, not '%.200s'",
906 name->ob_type->tp_name);
907 return NULL;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000908 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000909 if (tp->tp_getattro != NULL)
910 return (*tp->tp_getattro)(v, name);
911 if (tp->tp_getattr != NULL)
Martin v. Löwis5b222132007-06-10 09:51:05 +0000912 return (*tp->tp_getattr)(v, PyUnicode_AsString(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +0000913 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000914 "'%.50s' object has no attribute '%U'",
915 tp->tp_name, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000916 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000917}
918
919int
Fred Drake100814d2000-07-09 15:48:49 +0000920PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000921{
922 PyObject *res = PyObject_GetAttr(v, name);
923 if (res != NULL) {
924 Py_DECREF(res);
925 return 1;
926 }
927 PyErr_Clear();
928 return 0;
929}
930
931int
Fred Drake100814d2000-07-09 15:48:49 +0000932PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000933{
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000934 PyTypeObject *tp = Py_Type(v);
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000935 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000936
Martin v. Löwis5b222132007-06-10 09:51:05 +0000937 if (!PyUnicode_Check(name)) {
938 PyErr_Format(PyExc_TypeError,
939 "attribute name must be string, not '%.200s'",
940 name->ob_type->tp_name);
941 return -1;
Jeremy Hylton99a8f902000-06-23 14:36:32 +0000942 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000943 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000944
Martin v. Löwis5b222132007-06-10 09:51:05 +0000945 PyUnicode_InternInPlace(&name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000946 if (tp->tp_setattro != NULL) {
947 err = (*tp->tp_setattro)(v, name, value);
948 Py_DECREF(name);
949 return err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000950 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000951 if (tp->tp_setattr != NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +0000952 err = (*tp->tp_setattr)(v, PyUnicode_AsString(name), value);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000953 Py_DECREF(name);
954 return err;
955 }
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000956 Py_DECREF(name);
Guido van Rossumf15a29f2007-05-04 00:41:39 +0000957 assert(name->ob_refcnt >= 1);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000958 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
959 PyErr_Format(PyExc_TypeError,
960 "'%.100s' object has no attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000961 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000962 tp->tp_name,
963 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000964 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000965 else
966 PyErr_Format(PyExc_TypeError,
967 "'%.100s' object has only read-only attributes "
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000968 "(%s .%U)",
Tim Peters6d6c1a32001-08-02 04:15:00 +0000969 tp->tp_name,
970 value==NULL ? "del" : "assign to",
Walter Dörwaldd376dd92007-06-11 15:37:20 +0000971 name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000972 return -1;
973}
974
975/* Helper to get a pointer to an object's __dict__ slot, if any */
976
977PyObject **
978_PyObject_GetDictPtr(PyObject *obj)
979{
Martin v. Löwis725507b2006-03-07 12:08:51 +0000980 Py_ssize_t dictoffset;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000981 PyTypeObject *tp = Py_Type(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000982
Tim Peters6d6c1a32001-08-02 04:15:00 +0000983 dictoffset = tp->tp_dictoffset;
984 if (dictoffset == 0)
985 return NULL;
986 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000987 Py_ssize_t tsize;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000988 size_t size;
989
990 tsize = ((PyVarObject *)obj)->ob_size;
991 if (tsize < 0)
992 tsize = -tsize;
993 size = _PyObject_VAR_SIZE(tp, tsize);
994
Tim Peters6d483d32001-10-06 21:27:34 +0000995 dictoffset += (long)size;
996 assert(dictoffset > 0);
997 assert(dictoffset % SIZEOF_VOID_P == 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000998 }
999 return (PyObject **) ((char *)obj + dictoffset);
1000}
1001
Tim Peters6d6c1a32001-08-02 04:15:00 +00001002PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +00001003PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +00001004{
1005 Py_INCREF(obj);
1006 return obj;
1007}
1008
Michael W. Hudson1593f502004-09-14 17:09:47 +00001009/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
1010
Raymond Hettinger01538262003-03-17 08:24:35 +00001011PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001012PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
1013{
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001014 PyTypeObject *tp = Py_Type(obj);
Guido van Rossum056fbf42002-08-19 19:22:50 +00001015 PyObject *descr = NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001016 PyObject *res = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001017 descrgetfunc f;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001018 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001019 PyObject **dictptr;
1020
Martin v. Löwis5b222132007-06-10 09:51:05 +00001021 if (!PyUnicode_Check(name)){
1022 PyErr_Format(PyExc_TypeError,
1023 "attribute name must be string, not '%.200s'",
1024 name->ob_type->tp_name);
1025 return NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001026 }
1027 else
1028 Py_INCREF(name);
1029
Tim Peters6d6c1a32001-08-02 04:15:00 +00001030 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001031 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001032 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001033 }
1034
Guido van Rossum056fbf42002-08-19 19:22:50 +00001035 /* Inline _PyType_Lookup */
1036 {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001037 Py_ssize_t i, n;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001038 PyObject *mro, *base, *dict;
1039
1040 /* Look in tp_dict of types in MRO */
1041 mro = tp->tp_mro;
1042 assert(mro != NULL);
1043 assert(PyTuple_Check(mro));
1044 n = PyTuple_GET_SIZE(mro);
1045 for (i = 0; i < n; i++) {
1046 base = PyTuple_GET_ITEM(mro, i);
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001047 assert(PyType_Check(base));
1048 dict = ((PyTypeObject *)base)->tp_dict;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001049 assert(dict && PyDict_Check(dict));
1050 descr = PyDict_GetItem(dict, name);
1051 if (descr != NULL)
1052 break;
1053 }
1054 }
1055
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001056 Py_XINCREF(descr);
1057
Tim Peters6d6c1a32001-08-02 04:15:00 +00001058 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001059 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001060 f = descr->ob_type->tp_descr_get;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001061 if (f != NULL && PyDescr_IsData(descr)) {
1062 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001063 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001064 goto done;
1065 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001066 }
1067
Guido van Rossumc66ff442002-08-19 16:50:48 +00001068 /* Inline _PyObject_GetDictPtr */
1069 dictoffset = tp->tp_dictoffset;
1070 if (dictoffset != 0) {
1071 PyObject *dict;
1072 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001073 Py_ssize_t tsize;
Guido van Rossumc66ff442002-08-19 16:50:48 +00001074 size_t size;
1075
1076 tsize = ((PyVarObject *)obj)->ob_size;
1077 if (tsize < 0)
1078 tsize = -tsize;
1079 size = _PyObject_VAR_SIZE(tp, tsize);
1080
1081 dictoffset += (long)size;
1082 assert(dictoffset > 0);
1083 assert(dictoffset % SIZEOF_VOID_P == 0);
1084 }
1085 dictptr = (PyObject **) ((char *)obj + dictoffset);
1086 dict = *dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001087 if (dict != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001088 res = PyDict_GetItem(dict, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001089 if (res != NULL) {
1090 Py_INCREF(res);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001091 Py_XDECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001092 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001093 }
1094 }
1095 }
1096
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001097 if (f != NULL) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001098 res = f(descr, obj, (PyObject *)Py_Type(obj));
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001099 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001100 goto done;
1101 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001102
1103 if (descr != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001104 res = descr;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001105 /* descr was already increfed above */
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001106 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001107 }
1108
1109 PyErr_Format(PyExc_AttributeError,
1110 "'%.50s' object has no attribute '%.400s'",
Martin v. Löwis5b222132007-06-10 09:51:05 +00001111 tp->tp_name, PyUnicode_AsString(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001112 done:
1113 Py_DECREF(name);
1114 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001115}
1116
1117int
1118PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1119{
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001120 PyTypeObject *tp = Py_Type(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001121 PyObject *descr;
1122 descrsetfunc f;
1123 PyObject **dictptr;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001124 int res = -1;
1125
Martin v. Löwis5b222132007-06-10 09:51:05 +00001126 if (!PyUnicode_Check(name)){
1127 PyErr_Format(PyExc_TypeError,
1128 "attribute name must be string, not '%.200s'",
1129 name->ob_type->tp_name);
1130 return -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001131 }
1132 else
1133 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001134
1135 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001136 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001137 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001138 }
1139
1140 descr = _PyType_Lookup(tp, name);
1141 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001142 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001143 f = descr->ob_type->tp_descr_set;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001144 if (f != NULL && PyDescr_IsData(descr)) {
1145 res = f(descr, obj, value);
1146 goto done;
1147 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001148 }
1149
1150 dictptr = _PyObject_GetDictPtr(obj);
1151 if (dictptr != NULL) {
1152 PyObject *dict = *dictptr;
1153 if (dict == NULL && value != NULL) {
1154 dict = PyDict_New();
1155 if (dict == NULL)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001156 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001157 *dictptr = dict;
1158 }
1159 if (dict != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001160 if (value == NULL)
1161 res = PyDict_DelItem(dict, name);
1162 else
1163 res = PyDict_SetItem(dict, name, value);
1164 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1165 PyErr_SetObject(PyExc_AttributeError, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001166 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001167 }
1168 }
1169
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001170 if (f != NULL) {
1171 res = f(descr, obj, value);
1172 goto done;
1173 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001174
1175 if (descr == NULL) {
1176 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001177 "'%.100s' object has no attribute '%U'",
1178 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001179 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001180 }
1181
1182 PyErr_Format(PyExc_AttributeError,
Walter Dörwaldd376dd92007-06-11 15:37:20 +00001183 "'%.50s' object attribute '%U' is read-only",
1184 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001185 done:
1186 Py_DECREF(name);
1187 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001188}
1189
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001190/* Test a value used as condition, e.g., in a for or if statement.
1191 Return -1 if an error occurred */
1192
1193int
Fred Drake100814d2000-07-09 15:48:49 +00001194PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001195{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001196 Py_ssize_t res;
Guido van Rossum6248f442002-08-24 06:31:34 +00001197 if (v == Py_True)
1198 return 1;
1199 if (v == Py_False)
1200 return 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001201 if (v == Py_None)
Neal Norwitz51290d32002-06-13 21:32:44 +00001202 return 0;
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001203 else if (v->ob_type->tp_as_number != NULL &&
Jack Diederich4dafcc42006-11-28 19:15:13 +00001204 v->ob_type->tp_as_number->nb_bool != NULL)
1205 res = (*v->ob_type->tp_as_number->nb_bool)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001206 else if (v->ob_type->tp_as_mapping != NULL &&
1207 v->ob_type->tp_as_mapping->mp_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001208 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001209 else if (v->ob_type->tp_as_sequence != NULL &&
1210 v->ob_type->tp_as_sequence->sq_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001211 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1212 else
Neal Norwitz51290d32002-06-13 21:32:44 +00001213 return 1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001214 /* if it is negative, it should be either -1 or -2 */
1215 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001216}
1217
Tim Peters803526b2002-07-07 05:13:56 +00001218/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001219 Return -1 if an error occurred */
1220
1221int
Fred Drake100814d2000-07-09 15:48:49 +00001222PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001223{
1224 int res;
1225 res = PyObject_IsTrue(v);
1226 if (res < 0)
1227 return res;
1228 return res == 0;
1229}
1230
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001231/* Test whether an object can be called */
1232
1233int
Fred Drake100814d2000-07-09 15:48:49 +00001234PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001235{
1236 if (x == NULL)
1237 return 0;
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001238 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001239}
1240
Georg Brandle32b4222007-03-10 22:13:27 +00001241/* ------------------------- PyObject_Dir() helpers ------------------------- */
1242
Tim Peters7eea37e2001-09-04 22:08:56 +00001243/* Helper for PyObject_Dir.
1244 Merge the __dict__ of aclass into dict, and recursively also all
1245 the __dict__s of aclass's base classes. The order of merging isn't
1246 defined, as it's expected that only the final set of dict keys is
1247 interesting.
1248 Return 0 on success, -1 on error.
1249*/
1250
1251static int
1252merge_class_dict(PyObject* dict, PyObject* aclass)
1253{
1254 PyObject *classdict;
1255 PyObject *bases;
1256
1257 assert(PyDict_Check(dict));
1258 assert(aclass);
1259
1260 /* Merge in the type's dict (if any). */
1261 classdict = PyObject_GetAttrString(aclass, "__dict__");
1262 if (classdict == NULL)
1263 PyErr_Clear();
1264 else {
1265 int status = PyDict_Update(dict, classdict);
1266 Py_DECREF(classdict);
1267 if (status < 0)
1268 return -1;
1269 }
1270
1271 /* Recursively merge in the base types' (if any) dicts. */
1272 bases = PyObject_GetAttrString(aclass, "__bases__");
Tim Petersbc7e8632001-09-16 20:33:22 +00001273 if (bases == NULL)
1274 PyErr_Clear();
1275 else {
Guido van Rossum44022412002-05-13 18:29:46 +00001276 /* We have no guarantee that bases is a real tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001277 Py_ssize_t i, n;
Guido van Rossum44022412002-05-13 18:29:46 +00001278 n = PySequence_Size(bases); /* This better be right */
1279 if (n < 0)
1280 PyErr_Clear();
1281 else {
1282 for (i = 0; i < n; i++) {
Tim Peters18e70832003-02-05 19:35:19 +00001283 int status;
Guido van Rossum44022412002-05-13 18:29:46 +00001284 PyObject *base = PySequence_GetItem(bases, i);
1285 if (base == NULL) {
1286 Py_DECREF(bases);
1287 return -1;
1288 }
Tim Peters18e70832003-02-05 19:35:19 +00001289 status = merge_class_dict(dict, base);
1290 Py_DECREF(base);
1291 if (status < 0) {
Guido van Rossum44022412002-05-13 18:29:46 +00001292 Py_DECREF(bases);
1293 return -1;
1294 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001295 }
1296 }
1297 Py_DECREF(bases);
1298 }
1299 return 0;
1300}
1301
Georg Brandle32b4222007-03-10 22:13:27 +00001302/* Helper for PyObject_Dir without arguments: returns the local scope. */
1303static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001304_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001305{
Georg Brandled3b8382007-03-12 13:15:14 +00001306 PyObject *names;
Georg Brandle32b4222007-03-10 22:13:27 +00001307 PyObject *locals = PyEval_GetLocals();
Tim Peters305b5852001-09-17 02:38:46 +00001308
Georg Brandle32b4222007-03-10 22:13:27 +00001309 if (locals == NULL) {
1310 PyErr_SetString(PyExc_SystemError, "frame does not exist");
1311 return NULL;
Tim Peters305b5852001-09-17 02:38:46 +00001312 }
1313
Georg Brandled3b8382007-03-12 13:15:14 +00001314 names = PyMapping_Keys(locals);
1315 if (!names)
1316 return NULL;
1317 if (!PyList_Check(names)) {
1318 PyErr_Format(PyExc_TypeError,
1319 "dir(): expected keys() of locals to be a list, "
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001320 "not '%.200s'", Py_Type(names)->tp_name);
Georg Brandled3b8382007-03-12 13:15:14 +00001321 Py_DECREF(names);
1322 return NULL;
1323 }
Georg Brandle32b4222007-03-10 22:13:27 +00001324 /* the locals don't need to be DECREF'd */
Georg Brandled3b8382007-03-12 13:15:14 +00001325 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001326}
1327
1328/* Helper for PyObject_Dir of type objects: returns __dict__ and __bases__.
1329 We deliberately don't suck up its __class__, as methods belonging to the
1330 metaclass would probably be more confusing than helpful.
1331*/
1332static PyObject *
1333_specialized_dir_type(PyObject *obj)
1334{
1335 PyObject *result = NULL;
1336 PyObject *dict = PyDict_New();
1337
1338 if (dict != NULL && merge_class_dict(dict, obj) == 0)
1339 result = PyDict_Keys(dict);
1340
1341 Py_XDECREF(dict);
Tim Peters305b5852001-09-17 02:38:46 +00001342 return result;
1343}
1344
Georg Brandle32b4222007-03-10 22:13:27 +00001345/* Helper for PyObject_Dir of module objects: returns the module's __dict__. */
1346static PyObject *
1347_specialized_dir_module(PyObject *obj)
Tim Peters7eea37e2001-09-04 22:08:56 +00001348{
Georg Brandle32b4222007-03-10 22:13:27 +00001349 PyObject *result = NULL;
1350 PyObject *dict = PyObject_GetAttrString(obj, "__dict__");
Tim Peters7eea37e2001-09-04 22:08:56 +00001351
Georg Brandle32b4222007-03-10 22:13:27 +00001352 if (dict != NULL) {
1353 if (PyDict_Check(dict))
1354 result = PyDict_Keys(dict);
1355 else {
1356 PyErr_Format(PyExc_TypeError,
1357 "%.200s.__dict__ is not a dictionary",
1358 PyModule_GetName(obj));
Guido van Rossum8dbd3d82001-09-10 18:27:43 +00001359 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001360 }
1361
Georg Brandle32b4222007-03-10 22:13:27 +00001362 Py_XDECREF(dict);
1363 return result;
1364}
Tim Peters7eea37e2001-09-04 22:08:56 +00001365
Georg Brandle32b4222007-03-10 22:13:27 +00001366/* Helper for PyObject_Dir of generic objects: returns __dict__, __class__,
1367 and recursively up the __class__.__bases__ chain.
1368*/
1369static PyObject *
1370_generic_dir(PyObject *obj)
1371{
1372 PyObject *result = NULL;
1373 PyObject *dict = NULL;
1374 PyObject *itsclass = NULL;
1375
1376 /* Get __dict__ (which may or may not be a real dict...) */
1377 dict = PyObject_GetAttrString(obj, "__dict__");
1378 if (dict == NULL) {
1379 PyErr_Clear();
1380 dict = PyDict_New();
1381 }
1382 else if (!PyDict_Check(dict)) {
1383 Py_DECREF(dict);
1384 dict = PyDict_New();
1385 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001386 else {
Georg Brandle32b4222007-03-10 22:13:27 +00001387 /* Copy __dict__ to avoid mutating it. */
1388 PyObject *temp = PyDict_Copy(dict);
1389 Py_DECREF(dict);
1390 dict = temp;
Tim Peters7eea37e2001-09-04 22:08:56 +00001391 }
1392
Georg Brandle32b4222007-03-10 22:13:27 +00001393 if (dict == NULL)
Raymond Hettinger2a7dede2004-08-07 04:55:30 +00001394 goto error;
Tim Peters7eea37e2001-09-04 22:08:56 +00001395
Georg Brandle32b4222007-03-10 22:13:27 +00001396 /* Merge in attrs reachable from its class. */
1397 itsclass = PyObject_GetAttrString(obj, "__class__");
1398 if (itsclass == NULL)
1399 /* XXX(tomer): Perhaps fall back to obj->ob_type if no
1400 __class__ exists? */
1401 PyErr_Clear();
1402 else {
1403 if (merge_class_dict(dict, itsclass) != 0)
1404 goto error;
1405 }
1406
1407 result = PyDict_Keys(dict);
Tim Peters7eea37e2001-09-04 22:08:56 +00001408 /* fall through */
Georg Brandle32b4222007-03-10 22:13:27 +00001409error:
1410 Py_XDECREF(itsclass);
1411 Py_XDECREF(dict);
1412 return result;
1413}
1414
1415/* Helper for PyObject_Dir: object introspection.
1416 This calls one of the above specialized versions if no __dir__ method
1417 exists. */
1418static PyObject *
1419_dir_object(PyObject *obj)
1420{
1421 PyObject * result = NULL;
1422 PyObject * dirfunc = PyObject_GetAttrString((PyObject*)obj->ob_type,
1423 "__dir__");
1424
1425 assert(obj);
1426 if (dirfunc == NULL) {
1427 /* use default implementation */
1428 PyErr_Clear();
1429 if (PyModule_Check(obj))
1430 result = _specialized_dir_module(obj);
1431 else if (PyType_Check(obj))
1432 result = _specialized_dir_type(obj);
1433 else
1434 result = _generic_dir(obj);
1435 }
1436 else {
1437 /* use __dir__ */
1438 result = PyObject_CallFunctionObjArgs(dirfunc, obj, NULL);
1439 Py_DECREF(dirfunc);
1440 if (result == NULL)
1441 return NULL;
1442
1443 /* result must be a list */
1444 /* XXX(gbrandl): could also check if all items are strings */
1445 if (!PyList_Check(result)) {
1446 PyErr_Format(PyExc_TypeError,
1447 "__dir__() must return a list, not %.200s",
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001448 Py_Type(result)->tp_name);
Georg Brandle32b4222007-03-10 22:13:27 +00001449 Py_DECREF(result);
1450 result = NULL;
1451 }
1452 }
1453
1454 return result;
1455}
1456
1457/* Implementation of dir() -- if obj is NULL, returns the names in the current
1458 (local) scope. Otherwise, performs introspection of the object: returns a
1459 sorted list of attribute names (supposedly) accessible from the object
1460*/
1461PyObject *
1462PyObject_Dir(PyObject *obj)
1463{
1464 PyObject * result;
1465
1466 if (obj == NULL)
1467 /* no object -- introspect the locals */
1468 result = _dir_locals();
1469 else
1470 /* object -- introspect the object */
1471 result = _dir_object(obj);
1472
1473 assert(result == NULL || PyList_Check(result));
1474
1475 if (result != NULL && PyList_Sort(result) != 0) {
1476 /* sorting the list failed */
1477 Py_DECREF(result);
1478 result = NULL;
1479 }
1480
Tim Peters7eea37e2001-09-04 22:08:56 +00001481 return result;
1482}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001483
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001484/*
1485NoObject is usable as a non-NULL undefined value, used by the macro None.
1486There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001487so there is exactly one (which is indestructible, by the way).
Guido van Rossumba21a492001-08-16 08:17:26 +00001488(XXX This type and the type of NotImplemented below should be unified.)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001489*/
1490
Guido van Rossum0c182a11992-03-27 17:26:13 +00001491/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001492static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001493none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001494{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001495 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001496}
1497
Barry Warsaw9bf16442001-01-23 16:24:35 +00001498/* ARGUSED */
1499static void
Tim Peters803526b2002-07-07 05:13:56 +00001500none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001501{
1502 /* This should never get called, but we also don't want to SEGV if
1503 * we accidently decref None out of existance.
1504 */
Martin v. Löwis3f19b102002-08-07 16:21:51 +00001505 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001506}
1507
1508
Guido van Rossumba21a492001-08-16 08:17:26 +00001509static PyTypeObject PyNone_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001510 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001511 "NoneType",
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001512 0,
1513 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001514 none_dealloc, /*tp_dealloc*/ /*never called*/
Guido van Rossum7066dd71992-09-17 17:54:56 +00001515 0, /*tp_print*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001516 0, /*tp_getattr*/
1517 0, /*tp_setattr*/
1518 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001519 none_repr, /*tp_repr*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001520 0, /*tp_as_number*/
1521 0, /*tp_as_sequence*/
1522 0, /*tp_as_mapping*/
Guido van Rossum9bfef441993-03-29 10:43:31 +00001523 0, /*tp_hash */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001524};
1525
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001526PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001527 _PyObject_EXTRA_INIT
1528 1, &PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001529};
1530
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001531/* NotImplemented is an object that can be used to signal that an
1532 operation is not implemented for the given type combination. */
1533
1534static PyObject *
1535NotImplemented_repr(PyObject *op)
1536{
Walter Dörwald1ab83302007-05-18 17:15:44 +00001537 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001538}
1539
1540static PyTypeObject PyNotImplemented_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001541 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumba21a492001-08-16 08:17:26 +00001542 "NotImplementedType",
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001543 0,
1544 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001545 none_dealloc, /*tp_dealloc*/ /*never called*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001546 0, /*tp_print*/
1547 0, /*tp_getattr*/
1548 0, /*tp_setattr*/
1549 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001550 NotImplemented_repr, /*tp_repr*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001551 0, /*tp_as_number*/
1552 0, /*tp_as_sequence*/
1553 0, /*tp_as_mapping*/
1554 0, /*tp_hash */
1555};
1556
1557PyObject _Py_NotImplementedStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001558 _PyObject_EXTRA_INIT
1559 1, &PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001560};
1561
Guido van Rossumba21a492001-08-16 08:17:26 +00001562void
1563_Py_ReadyTypes(void)
1564{
1565 if (PyType_Ready(&PyType_Type) < 0)
1566 Py_FatalError("Can't initialize 'type'");
1567
Fred Drake0a4dd392004-07-02 18:57:45 +00001568 if (PyType_Ready(&_PyWeakref_RefType) < 0)
1569 Py_FatalError("Can't initialize 'weakref'");
1570
Guido van Rossum77f6a652002-04-03 22:41:51 +00001571 if (PyType_Ready(&PyBool_Type) < 0)
1572 Py_FatalError("Can't initialize 'bool'");
1573
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001574 if (PyType_Ready(&PyBytes_Type) < 0)
1575 Py_FatalError("Can't initialize 'bytes'");
1576
Guido van Rossumcacfc072002-05-24 19:01:59 +00001577 if (PyType_Ready(&PyString_Type) < 0)
1578 Py_FatalError("Can't initialize 'str'");
1579
Guido van Rossumba21a492001-08-16 08:17:26 +00001580 if (PyType_Ready(&PyList_Type) < 0)
1581 Py_FatalError("Can't initialize 'list'");
1582
1583 if (PyType_Ready(&PyNone_Type) < 0)
1584 Py_FatalError("Can't initialize type(None)");
1585
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001586 if (PyType_Ready(Py_Ellipsis->ob_type) < 0)
1587 Py_FatalError("Can't initialize type(Ellipsis)");
1588
Guido van Rossumba21a492001-08-16 08:17:26 +00001589 if (PyType_Ready(&PyNotImplemented_Type) < 0)
1590 Py_FatalError("Can't initialize type(NotImplemented)");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001591
1592 if (PyType_Ready(&PyCode_Type) < 0)
1593 Py_FatalError("Can't initialize 'code'");
Guido van Rossumba21a492001-08-16 08:17:26 +00001594}
1595
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001596
Guido van Rossum84a90321996-05-22 16:34:47 +00001597#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001598
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001599void
Fred Drake100814d2000-07-09 15:48:49 +00001600_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001601{
Tim Peters34592512002-07-11 06:23:50 +00001602 _Py_INC_REFTOTAL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001603 op->ob_refcnt = 1;
Tim Peters7571a0f2003-03-23 17:52:28 +00001604 _Py_AddToAllObjects(op, 1);
Tim Peters34592512002-07-11 06:23:50 +00001605 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001606}
1607
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001608void
Fred Drake100814d2000-07-09 15:48:49 +00001609_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001610{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001611#ifdef SLOW_UNREF_CHECK
Guido van Rossum4c08d552000-03-10 22:55:18 +00001612 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001613#endif
Guido van Rossumd7047b31995-01-02 19:07:15 +00001614 if (op->ob_refcnt < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001615 Py_FatalError("UNREF negative refcnt");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001616 if (op == &refchain ||
Guido van Rossumd7047b31995-01-02 19:07:15 +00001617 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001618 Py_FatalError("UNREF invalid object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001619#ifdef SLOW_UNREF_CHECK
Guido van Rossum3f5da241990-12-20 15:06:42 +00001620 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1621 if (p == op)
1622 break;
1623 }
Guido van Rossumd7047b31995-01-02 19:07:15 +00001624 if (p == &refchain) /* Not found */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001625 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001626#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001627 op->_ob_next->_ob_prev = op->_ob_prev;
1628 op->_ob_prev->_ob_next = op->_ob_next;
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001629 op->_ob_next = op->_ob_prev = NULL;
Tim Peters34592512002-07-11 06:23:50 +00001630 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001631}
1632
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001633void
Fred Drake100814d2000-07-09 15:48:49 +00001634_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001635{
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001636 destructor dealloc = Py_Type(op)->tp_dealloc;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001637 _Py_ForgetReference(op);
Guido van Rossum9776adf1994-09-07 14:36:45 +00001638 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001639}
1640
Tim Peters269b2a62003-04-17 19:52:29 +00001641/* Print all live objects. Because PyObject_Print is called, the
1642 * interpreter must be in a healthy state.
1643 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001644void
Fred Drake100814d2000-07-09 15:48:49 +00001645_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001646{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001647 PyObject *op;
Guido van Rossume09fb551997-08-05 02:04:34 +00001648 fprintf(fp, "Remaining objects:\n");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001649 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001650 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001651 if (PyObject_Print(op, fp, 0) != 0)
1652 PyErr_Clear();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001653 putc('\n', fp);
1654 }
1655}
1656
Tim Peters269b2a62003-04-17 19:52:29 +00001657/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1658 * doesn't make any calls to the Python C API, so is always safe to call.
1659 */
1660void
1661_Py_PrintReferenceAddresses(FILE *fp)
1662{
1663 PyObject *op;
1664 fprintf(fp, "Remaining object addresses:\n");
1665 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001666 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001667 op->ob_refcnt, Py_Type(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001668}
1669
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001670PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001671_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001672{
1673 int i, n;
1674 PyObject *t = NULL;
1675 PyObject *res, *op;
1676
1677 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1678 return NULL;
1679 op = refchain._ob_next;
1680 res = PyList_New(0);
1681 if (res == NULL)
1682 return NULL;
1683 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1684 while (op == self || op == args || op == res || op == t ||
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001685 (t != NULL && Py_Type(op) != (PyTypeObject *) t)) {
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001686 op = op->_ob_next;
1687 if (op == &refchain)
1688 return res;
1689 }
1690 if (PyList_Append(res, op) < 0) {
1691 Py_DECREF(res);
1692 return NULL;
1693 }
1694 op = op->_ob_next;
1695 }
1696 return res;
1697}
1698
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001699#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001700
1701
1702/* Hack to force loading of cobject.o */
Guido van Rossumda9c2711996-12-05 21:58:58 +00001703PyTypeObject *_Py_cobject_hack = &PyCObject_Type;
Guido van Rossum84a90321996-05-22 16:34:47 +00001704
1705
1706/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001707Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001708
1709
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001710/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001711
Thomas Wouters334fb892000-07-25 12:56:38 +00001712void *
Fred Drake100814d2000-07-09 15:48:49 +00001713PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001714{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001715 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001716}
1717
Thomas Wouters334fb892000-07-25 12:56:38 +00001718void *
1719PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001720{
Tim Petersaf3e8de2002-04-12 07:22:56 +00001721 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001722}
1723
1724void
Thomas Wouters334fb892000-07-25 12:56:38 +00001725PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001726{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001727 PyMem_FREE(p);
1728}
1729
1730
Guido van Rossum86610361998-04-10 22:32:46 +00001731/* These methods are used to control infinite recursion in repr, str, print,
1732 etc. Container objects that may recursively contain themselves,
1733 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
1734 Py_ReprLeave() to avoid infinite recursion.
1735
1736 Py_ReprEnter() returns 0 the first time it is called for a particular
1737 object and 1 every time thereafter. It returns -1 if an exception
1738 occurred. Py_ReprLeave() has no return value.
1739
1740 See dictobject.c and listobject.c for examples of use.
1741*/
1742
1743#define KEY "Py_Repr"
1744
1745int
Fred Drake100814d2000-07-09 15:48:49 +00001746Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001747{
1748 PyObject *dict;
1749 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001750 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001751
1752 dict = PyThreadState_GetDict();
1753 if (dict == NULL)
Guido van Rossum0fc8f002003-04-15 15:12:39 +00001754 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001755 list = PyDict_GetItemString(dict, KEY);
1756 if (list == NULL) {
1757 list = PyList_New(0);
1758 if (list == NULL)
1759 return -1;
1760 if (PyDict_SetItemString(dict, KEY, list) < 0)
1761 return -1;
1762 Py_DECREF(list);
1763 }
1764 i = PyList_GET_SIZE(list);
1765 while (--i >= 0) {
1766 if (PyList_GET_ITEM(list, i) == obj)
1767 return 1;
1768 }
1769 PyList_Append(list, obj);
1770 return 0;
1771}
1772
1773void
Fred Drake100814d2000-07-09 15:48:49 +00001774Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001775{
1776 PyObject *dict;
1777 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001778 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001779
1780 dict = PyThreadState_GetDict();
Guido van Rossumeb909461998-04-11 15:17:34 +00001781 if (dict == NULL)
1782 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001783 list = PyDict_GetItemString(dict, KEY);
Guido van Rossumeb909461998-04-11 15:17:34 +00001784 if (list == NULL || !PyList_Check(list))
1785 return;
Guido van Rossum86610361998-04-10 22:32:46 +00001786 i = PyList_GET_SIZE(list);
1787 /* Count backwards because we always expect obj to be list[-1] */
1788 while (--i >= 0) {
1789 if (PyList_GET_ITEM(list, i) == obj) {
1790 PyList_SetSlice(list, i, i + 1, NULL);
1791 break;
1792 }
1793 }
1794}
Guido van Rossumd724b232000-03-13 16:01:29 +00001795
Tim Peters803526b2002-07-07 05:13:56 +00001796/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001797
Tim Peters803526b2002-07-07 05:13:56 +00001798/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00001799int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00001800
Tim Peters803526b2002-07-07 05:13:56 +00001801/* List of objects that still need to be cleaned up, singly linked via their
1802 * gc headers' gc_prev pointers.
1803 */
1804PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00001805
Tim Peters803526b2002-07-07 05:13:56 +00001806/* Add op to the _PyTrash_delete_later list. Called when the current
1807 * call-stack depth gets large. op must be a currently untracked gc'ed
1808 * object, with refcount 0. Py_DECREF must already have been called on it.
1809 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001810void
Fred Drake100814d2000-07-09 15:48:49 +00001811_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00001812{
Tim Peters803526b2002-07-07 05:13:56 +00001813 assert(PyObject_IS_GC(op));
1814 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
1815 assert(op->ob_refcnt == 0);
Neil Schemenauerf589c052002-03-29 03:05:54 +00001816 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
Guido van Rossume92e6102000-04-24 15:40:53 +00001817 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00001818}
1819
Tim Peters803526b2002-07-07 05:13:56 +00001820/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
1821 * the call-stack unwinds again.
1822 */
Guido van Rossumd724b232000-03-13 16:01:29 +00001823void
Fred Drake100814d2000-07-09 15:48:49 +00001824_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00001825{
1826 while (_PyTrash_delete_later) {
Tim Peters803526b2002-07-07 05:13:56 +00001827 PyObject *op = _PyTrash_delete_later;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001828 destructor dealloc = Py_Type(op)->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001829
Neil Schemenauerf589c052002-03-29 03:05:54 +00001830 _PyTrash_delete_later =
Tim Peters803526b2002-07-07 05:13:56 +00001831 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00001832
Tim Peters803526b2002-07-07 05:13:56 +00001833 /* Call the deallocator directly. This used to try to
1834 * fool Py_DECREF into calling it indirectly, but
1835 * Py_DECREF was already called on this object, and in
1836 * assorted non-release builds calling Py_DECREF again ends
1837 * up distorting allocation statistics.
1838 */
1839 assert(op->ob_refcnt == 0);
Guido van Rossumd724b232000-03-13 16:01:29 +00001840 ++_PyTrash_delete_nesting;
Tim Peters803526b2002-07-07 05:13:56 +00001841 (*dealloc)(op);
Guido van Rossumd724b232000-03-13 16:01:29 +00001842 --_PyTrash_delete_nesting;
1843 }
1844}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001845
1846#ifdef __cplusplus
1847}
1848#endif