blob: 516098dfadd58f41a188d63b9640d18d57539a36 [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum3f5da241990-12-20 15:06:42 +00002/* Generic object operations; and implementation of None (NoObject) */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004#include "Python.h"
Guido van Rossum50e9fb92006-08-17 05:42:55 +00005#include "sliceobject.h" /* For PyEllipsis_Type */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00006
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007#ifdef __cplusplus
8extern "C" {
9#endif
10
Tim Peters34592512002-07-11 06:23:50 +000011#ifdef Py_REF_DEBUG
Neal Norwitz84632ee2006-03-04 20:00:59 +000012Py_ssize_t _Py_RefTotal;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000013
14Py_ssize_t
15_Py_GetRefTotal(void)
16{
17 PyObject *o;
18 Py_ssize_t total = _Py_RefTotal;
19 /* ignore the references to the dummy object of the dicts and sets
20 because they are not reliable and not useful (now that the
21 hash table code is well-tested) */
22 o = _PyDict_Dummy();
23 if (o != NULL)
24 total -= o->ob_refcnt;
25 o = _PySet_Dummy();
26 if (o != NULL)
27 total -= o->ob_refcnt;
28 return total;
29}
30#endif /* Py_REF_DEBUG */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000031
Mark Hammonda2905272002-07-29 13:42:14 +000032int Py_DivisionWarningFlag;
Guido van Rossum393661d2001-08-31 17:40:15 +000033
Guido van Rossum3f5da241990-12-20 15:06:42 +000034/* Object allocation routines used by NEWOBJ and NEWVAROBJ macros.
35 These are used by the individual routines for object creation.
36 Do not call them otherwise, they do not initialize the object! */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000037
Tim Peters78be7992003-03-23 02:51:01 +000038#ifdef Py_TRACE_REFS
Tim Peters7571a0f2003-03-23 17:52:28 +000039/* Head of circular doubly-linked list of all objects. These are linked
40 * together via the _ob_prev and _ob_next members of a PyObject, which
41 * exist only in a Py_TRACE_REFS build.
42 */
Tim Peters78be7992003-03-23 02:51:01 +000043static PyObject refchain = {&refchain, &refchain};
Tim Peters36eb4df2003-03-23 03:33:13 +000044
Tim Peters7571a0f2003-03-23 17:52:28 +000045/* Insert op at the front of the list of all objects. If force is true,
46 * op is added even if _ob_prev and _ob_next are non-NULL already. If
47 * force is false amd _ob_prev or _ob_next are non-NULL, do nothing.
48 * force should be true if and only if op points to freshly allocated,
49 * uninitialized memory, or you've unlinked op from the list and are
Tim Peters51f8d382003-03-23 18:06:08 +000050 * relinking it into the front.
Tim Peters7571a0f2003-03-23 17:52:28 +000051 * Note that objects are normally added to the list via _Py_NewReference,
52 * which is called by PyObject_Init. Not all objects are initialized that
53 * way, though; exceptions include statically allocated type objects, and
54 * statically allocated singletons (like Py_True and Py_None).
55 */
Tim Peters36eb4df2003-03-23 03:33:13 +000056void
Tim Peters7571a0f2003-03-23 17:52:28 +000057_Py_AddToAllObjects(PyObject *op, int force)
Tim Peters36eb4df2003-03-23 03:33:13 +000058{
Tim Peters7571a0f2003-03-23 17:52:28 +000059#ifdef Py_DEBUG
60 if (!force) {
61 /* If it's initialized memory, op must be in or out of
62 * the list unambiguously.
63 */
64 assert((op->_ob_prev == NULL) == (op->_ob_next == NULL));
65 }
Tim Peters78be7992003-03-23 02:51:01 +000066#endif
Tim Peters7571a0f2003-03-23 17:52:28 +000067 if (force || op->_ob_prev == NULL) {
68 op->_ob_next = refchain._ob_next;
69 op->_ob_prev = &refchain;
70 refchain._ob_next->_ob_prev = op;
71 refchain._ob_next = op;
72 }
73}
74#endif /* Py_TRACE_REFS */
Tim Peters78be7992003-03-23 02:51:01 +000075
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000076#ifdef COUNT_ALLOCS
Guido van Rossumc0b618a1997-05-02 03:12:38 +000077static PyTypeObject *type_list;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000078/* All types are added to type_list, at least when
79 they get one object created. That makes them
80 immortal, which unfortunately contributes to
81 garbage itself. If unlist_types_without_objects
82 is set, they will be removed from the type_list
83 once the last object is deallocated. */
84int unlist_types_without_objects;
Sjoerd Mullender842d2cc1993-10-15 16:18:48 +000085extern int tuple_zero_allocs, fast_tuple_allocs;
86extern int quick_int_allocs, quick_neg_int_allocs;
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +000087extern int null_strings, one_strings;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000088void
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000089dump_counts(FILE* f)
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000090{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000091 PyTypeObject *tp;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000092
93 for (tp = type_list; tp; tp = tp->tp_next)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000094 fprintf(f, "%s alloc'd: %d, freed: %d, max in use: %d\n",
Tim Peters6d6c1a32001-08-02 04:15:00 +000095 tp->tp_name, tp->tp_allocs, tp->tp_frees,
Sjoerd Mullender52c1f511993-10-25 08:40:52 +000096 tp->tp_maxalloc);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000097 fprintf(f, "fast tuple allocs: %d, empty: %d\n",
Sjoerd Mullender52c1f511993-10-25 08:40:52 +000098 fast_tuple_allocs, tuple_zero_allocs);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000099 fprintf(f, "fast int allocs: pos: %d, neg: %d\n",
Sjoerd Mullender52c1f511993-10-25 08:40:52 +0000100 quick_int_allocs, quick_neg_int_allocs);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000101 fprintf(f, "null strings: %d, 1-strings: %d\n",
Sjoerd Mullender52c1f511993-10-25 08:40:52 +0000102 null_strings, one_strings);
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000103}
104
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000105PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000106get_counts(void)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000107{
108 PyTypeObject *tp;
109 PyObject *result;
110 PyObject *v;
111
112 result = PyList_New(0);
113 if (result == NULL)
114 return NULL;
115 for (tp = type_list; tp; tp = tp->tp_next) {
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000116 v = Py_BuildValue("(snnn)", tp->tp_name, tp->tp_allocs,
Tim Peters6d6c1a32001-08-02 04:15:00 +0000117 tp->tp_frees, tp->tp_maxalloc);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000118 if (v == NULL) {
119 Py_DECREF(result);
120 return NULL;
121 }
122 if (PyList_Append(result, v) < 0) {
123 Py_DECREF(v);
124 Py_DECREF(result);
125 return NULL;
126 }
127 Py_DECREF(v);
128 }
129 return result;
130}
131
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000132void
Fred Drake100814d2000-07-09 15:48:49 +0000133inc_count(PyTypeObject *tp)
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000134{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000135 if (tp->tp_next == NULL && tp->tp_prev == NULL) {
Guido van Rossumd8953cb1995-04-06 14:46:26 +0000136 /* first time; insert in linked list */
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000137 if (tp->tp_next != NULL) /* sanity check */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000138 Py_FatalError("XXX inc_count sanity check");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000139 if (type_list)
140 type_list->tp_prev = tp;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000141 tp->tp_next = type_list;
Tim Petersc6a3ff62002-07-08 22:11:52 +0000142 /* Note that as of Python 2.2, heap-allocated type objects
143 * can go away, but this code requires that they stay alive
144 * until program exit. That's why we're careful with
145 * refcounts here. type_list gets a new reference to tp,
146 * while ownership of the reference type_list used to hold
147 * (if any) was transferred to tp->tp_next in the line above.
148 * tp is thus effectively immortal after this.
149 */
150 Py_INCREF(tp);
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000151 type_list = tp;
Tim Peters3e40c7f2003-03-23 03:04:32 +0000152#ifdef Py_TRACE_REFS
Tim Peters7571a0f2003-03-23 17:52:28 +0000153 /* Also insert in the doubly-linked list of all objects,
154 * if not already there.
155 */
156 _Py_AddToAllObjects((PyObject *)tp, 0);
Tim Peters78be7992003-03-23 02:51:01 +0000157#endif
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000158 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000159 tp->tp_allocs++;
160 if (tp->tp_allocs - tp->tp_frees > tp->tp_maxalloc)
161 tp->tp_maxalloc = tp->tp_allocs - tp->tp_frees;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000162}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000163
164void dec_count(PyTypeObject *tp)
165{
166 tp->tp_frees++;
167 if (unlist_types_without_objects &&
168 tp->tp_allocs == tp->tp_frees) {
169 /* unlink the type from type_list */
170 if (tp->tp_prev)
171 tp->tp_prev->tp_next = tp->tp_next;
172 else
173 type_list = tp->tp_next;
174 if (tp->tp_next)
175 tp->tp_next->tp_prev = tp->tp_prev;
176 tp->tp_next = tp->tp_prev = NULL;
177 Py_DECREF(tp);
178 }
179}
180
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000181#endif
182
Tim Peters7c321a82002-07-09 02:57:01 +0000183#ifdef Py_REF_DEBUG
184/* Log a fatal error; doesn't return. */
185void
186_Py_NegativeRefcount(const char *fname, int lineno, PyObject *op)
187{
188 char buf[300];
189
190 PyOS_snprintf(buf, sizeof(buf),
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000191 "%s:%i object at %p has negative ref count "
192 "%" PY_FORMAT_SIZE_T "d",
193 fname, lineno, op, op->ob_refcnt);
Tim Peters7c321a82002-07-09 02:57:01 +0000194 Py_FatalError(buf);
195}
196
197#endif /* Py_REF_DEBUG */
198
Thomas Heller1328b522004-04-22 17:23:49 +0000199void
200Py_IncRef(PyObject *o)
201{
202 Py_XINCREF(o);
203}
204
205void
206Py_DecRef(PyObject *o)
207{
208 Py_XDECREF(o);
209}
210
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000211PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000212PyObject_Init(PyObject *op, PyTypeObject *tp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000213{
Guido van Rossum6e08c142002-10-11 20:37:24 +0000214 if (op == NULL)
215 return PyErr_NoMemory();
Guido van Rossumb18618d2000-05-03 23:44:39 +0000216 /* Any changes should be reflected in PyObject_INIT (objimpl.h) */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000217 op->ob_type = tp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000218 _Py_NewReference(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000219 return op;
220}
221
Guido van Rossumb18618d2000-05-03 23:44:39 +0000222PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000223PyObject_InitVar(PyVarObject *op, PyTypeObject *tp, Py_ssize_t size)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000224{
Guido van Rossum6e08c142002-10-11 20:37:24 +0000225 if (op == NULL)
226 return (PyVarObject *) PyErr_NoMemory();
Guido van Rossumb18618d2000-05-03 23:44:39 +0000227 /* Any changes should be reflected in PyObject_INIT_VAR */
228 op->ob_size = size;
229 op->ob_type = tp;
230 _Py_NewReference((PyObject *)op);
231 return op;
232}
233
234PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000235_PyObject_New(PyTypeObject *tp)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000236{
237 PyObject *op;
238 op = (PyObject *) PyObject_MALLOC(_PyObject_SIZE(tp));
239 if (op == NULL)
240 return PyErr_NoMemory();
241 return PyObject_INIT(op, tp);
242}
243
Guido van Rossumd0c87ee1997-05-15 21:31:03 +0000244PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000245_PyObject_NewVar(PyTypeObject *tp, Py_ssize_t nitems)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000246{
Guido van Rossumb18618d2000-05-03 23:44:39 +0000247 PyVarObject *op;
Tim Petersf2a67da2001-10-07 03:54:51 +0000248 const size_t size = _PyObject_VAR_SIZE(tp, nitems);
Tim Peters6d483d32001-10-06 21:27:34 +0000249 op = (PyVarObject *) PyObject_MALLOC(size);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000250 if (op == NULL)
Guido van Rossumd0c87ee1997-05-15 21:31:03 +0000251 return (PyVarObject *)PyErr_NoMemory();
Tim Peters6d483d32001-10-06 21:27:34 +0000252 return PyObject_INIT_VAR(op, tp, nitems);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000253}
254
Neil Schemenauerbdf0eed2002-04-12 03:08:42 +0000255/* for binary compatibility with 2.2 */
256#undef _PyObject_Del
Guido van Rossumb18618d2000-05-03 23:44:39 +0000257void
Fred Drake100814d2000-07-09 15:48:49 +0000258_PyObject_Del(PyObject *op)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000259{
Guido van Rossum4cc6ac72000-07-01 01:00:38 +0000260 PyObject_FREE(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000261}
262
Neal Norwitz1a997502003-01-13 20:13:12 +0000263/* Implementation of PyObject_Print with recursion checking */
264static int
265internal_print(PyObject *op, FILE *fp, int flags, int nesting)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000266{
Guido van Rossum278ef591991-07-27 21:40:24 +0000267 int ret = 0;
Neal Norwitz1a997502003-01-13 20:13:12 +0000268 if (nesting > 10) {
269 PyErr_SetString(PyExc_RuntimeError, "print recursion");
270 return -1;
271 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000272 if (PyErr_CheckSignals())
Guido van Rossum90933611991-06-07 16:10:43 +0000273 return -1;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000274#ifdef USE_STACKCHECK
275 if (PyOS_CheckStack()) {
Fred Drake661ea262000-10-24 19:57:45 +0000276 PyErr_SetString(PyExc_MemoryError, "stack overflow");
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000277 return -1;
278 }
279#endif
Guido van Rossum687ef6e2000-01-12 16:28:58 +0000280 clearerr(fp); /* Clear any previous error condition */
Guido van Rossum90933611991-06-07 16:10:43 +0000281 if (op == NULL) {
282 fprintf(fp, "<nil>");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000283 }
Guido van Rossum90933611991-06-07 16:10:43 +0000284 else {
285 if (op->ob_refcnt <= 0)
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000286 /* XXX(twouters) cast refcount to long until %zd is
287 universally available */
288 fprintf(fp, "<refcnt %ld at %p>",
289 (long)op->ob_refcnt, op);
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000290 else if (op->ob_type->tp_print == NULL) {
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000291 PyObject *s;
292 if (flags & Py_PRINT_RAW)
293 s = PyObject_Str(op);
294 else
295 s = PyObject_Repr(op);
296 if (s == NULL)
297 ret = -1;
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000298 else {
Neal Norwitz1a997502003-01-13 20:13:12 +0000299 ret = internal_print(s, fp, Py_PRINT_RAW,
300 nesting+1);
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000301 }
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000302 Py_XDECREF(s);
Guido van Rossum2e8f6141992-09-03 20:32:55 +0000303 }
Guido van Rossum90933611991-06-07 16:10:43 +0000304 else
Guido van Rossum278ef591991-07-27 21:40:24 +0000305 ret = (*op->ob_type->tp_print)(op, fp, flags);
Guido van Rossum90933611991-06-07 16:10:43 +0000306 }
Guido van Rossum278ef591991-07-27 21:40:24 +0000307 if (ret == 0) {
308 if (ferror(fp)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000309 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum278ef591991-07-27 21:40:24 +0000310 clearerr(fp);
311 ret = -1;
312 }
313 }
314 return ret;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000315}
316
Neal Norwitz1a997502003-01-13 20:13:12 +0000317int
318PyObject_Print(PyObject *op, FILE *fp, int flags)
319{
320 return internal_print(op, fp, flags, 0);
321}
322
323
Barry Warsaw9bf16442001-01-23 16:24:35 +0000324/* For debugging convenience. See Misc/gdbinit for some useful gdb hooks */
Tim Peters803526b2002-07-07 05:13:56 +0000325void _PyObject_Dump(PyObject* op)
Barry Warsaw9bf16442001-01-23 16:24:35 +0000326{
Barry Warsaweefb1072001-02-22 22:39:18 +0000327 if (op == NULL)
328 fprintf(stderr, "NULL\n");
329 else {
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000330 fprintf(stderr, "object : ");
Barry Warsaweefb1072001-02-22 22:39:18 +0000331 (void)PyObject_Print(op, stderr, 0);
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000332 /* XXX(twouters) cast refcount to long until %zd is
333 universally available */
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000334 fprintf(stderr, "\n"
335 "type : %s\n"
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000336 "refcount: %ld\n"
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000337 "address : %p\n",
338 op->ob_type==NULL ? "NULL" : op->ob_type->tp_name,
Thomas Wouters8b87a0b2006-03-01 05:41:20 +0000339 (long)op->ob_refcnt,
Guido van Rossum5f5512d2001-09-14 15:50:08 +0000340 op);
Barry Warsaweefb1072001-02-22 22:39:18 +0000341 }
Barry Warsaw9bf16442001-01-23 16:24:35 +0000342}
Barry Warsaw903138f2001-01-23 16:33:18 +0000343
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000344PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000345PyObject_Repr(PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000346{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000347 if (PyErr_CheckSignals())
Guido van Rossum90933611991-06-07 16:10:43 +0000348 return NULL;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000349#ifdef USE_STACKCHECK
350 if (PyOS_CheckStack()) {
Fred Drake661ea262000-10-24 19:57:45 +0000351 PyErr_SetString(PyExc_MemoryError, "stack overflow");
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000352 return NULL;
353 }
354#endif
Guido van Rossum90933611991-06-07 16:10:43 +0000355 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000356 return PyString_FromString("<NULL>");
Barry Warsaw7ce36942001-08-24 18:34:26 +0000357 else if (v->ob_type->tp_repr == NULL)
Guido van Rossum21922aa2001-08-30 20:26:05 +0000358 return PyString_FromFormat("<%s object at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +0000359 v->ob_type->tp_name, v);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000360 else {
361 PyObject *res;
362 res = (*v->ob_type->tp_repr)(v);
363 if (res == NULL)
364 return NULL;
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000365#ifdef Py_USING_UNICODE
Fredrik Lundhefecc7d2000-07-01 14:31:09 +0000366 if (PyUnicode_Check(res)) {
367 PyObject* str;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000368 str = PyUnicode_AsEncodedString(res, NULL, NULL);
Marc-André Lemburg891bc652000-07-03 09:57:53 +0000369 Py_DECREF(res);
370 if (str)
Fredrik Lundhefecc7d2000-07-01 14:31:09 +0000371 res = str;
Marc-André Lemburg891bc652000-07-03 09:57:53 +0000372 else
373 return NULL;
Fredrik Lundhefecc7d2000-07-01 14:31:09 +0000374 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000375#endif
Guido van Rossum4c08d552000-03-10 22:55:18 +0000376 if (!PyString_Check(res)) {
377 PyErr_Format(PyExc_TypeError,
Guido van Rossum5db862d2000-04-10 12:46:51 +0000378 "__repr__ returned non-string (type %.200s)",
Guido van Rossum4c08d552000-03-10 22:55:18 +0000379 res->ob_type->tp_name);
380 Py_DECREF(res);
381 return NULL;
382 }
383 return res;
384 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000385}
386
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000387PyObject *
Neil Schemenauercf52c072005-08-12 17:34:58 +0000388_PyObject_Str(PyObject *v)
Guido van Rossumc6004111993-11-05 10:22:19 +0000389{
Guido van Rossum4c08d552000-03-10 22:55:18 +0000390 PyObject *res;
Neil Schemenauercf52c072005-08-12 17:34:58 +0000391 int type_ok;
Guido van Rossumc6004111993-11-05 10:22:19 +0000392 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000393 return PyString_FromString("<NULL>");
Tim Peters5a49ade2001-09-11 01:41:59 +0000394 if (PyString_CheckExact(v)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000395 Py_INCREF(v);
Guido van Rossumc6004111993-11-05 10:22:19 +0000396 return v;
397 }
Neil Schemenauercf52c072005-08-12 17:34:58 +0000398#ifdef Py_USING_UNICODE
399 if (PyUnicode_CheckExact(v)) {
400 Py_INCREF(v);
401 return v;
402 }
403#endif
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000404 if (v->ob_type->tp_str == NULL)
405 return PyObject_Repr(v);
406
407 res = (*v->ob_type->tp_str)(v);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000408 if (res == NULL)
409 return NULL;
Neil Schemenauercf52c072005-08-12 17:34:58 +0000410 type_ok = PyString_Check(res);
411#ifdef Py_USING_UNICODE
412 type_ok = type_ok || PyUnicode_Check(res);
413#endif
414 if (!type_ok) {
415 PyErr_Format(PyExc_TypeError,
416 "__str__ returned non-string (type %.200s)",
417 res->ob_type->tp_name);
418 Py_DECREF(res);
419 return NULL;
420 }
421 return res;
422}
423
424PyObject *
425PyObject_Str(PyObject *v)
426{
427 PyObject *res = _PyObject_Str(v);
428 if (res == NULL)
429 return NULL;
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000430#ifdef Py_USING_UNICODE
Marc-André Lemburg891bc652000-07-03 09:57:53 +0000431 if (PyUnicode_Check(res)) {
432 PyObject* str;
433 str = PyUnicode_AsEncodedString(res, NULL, NULL);
434 Py_DECREF(res);
435 if (str)
436 res = str;
437 else
438 return NULL;
439 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000440#endif
Neil Schemenauercf52c072005-08-12 17:34:58 +0000441 assert(PyString_Check(res));
Guido van Rossum4c08d552000-03-10 22:55:18 +0000442 return res;
Guido van Rossumc6004111993-11-05 10:22:19 +0000443}
444
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000445#ifdef Py_USING_UNICODE
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000446PyObject *
447PyObject_Unicode(PyObject *v)
448{
449 PyObject *res;
Brett Cannonc3647ac2005-04-26 03:45:26 +0000450 PyObject *func;
Neal Norwitz75801462006-03-14 06:02:16 +0000451 PyObject *str;
Brett Cannonc3647ac2005-04-26 03:45:26 +0000452 static PyObject *unicodestr;
Tim Peters803526b2002-07-07 05:13:56 +0000453
Georg Brandl3daf7582006-03-13 22:22:11 +0000454 if (v == NULL) {
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000455 res = PyString_FromString("<NULL>");
Neal Norwitz75801462006-03-14 06:02:16 +0000456 if (res == NULL)
457 return NULL;
458 str = PyUnicode_FromEncodedObject(res, NULL, "strict");
459 Py_DECREF(res);
460 return str;
Georg Brandl3daf7582006-03-13 22:22:11 +0000461 } else if (PyUnicode_CheckExact(v)) {
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000462 Py_INCREF(v);
463 return v;
464 }
Brett Cannonc3647ac2005-04-26 03:45:26 +0000465 /* XXX As soon as we have a tp_unicode slot, we should
466 check this before trying the __unicode__
467 method. */
468 if (unicodestr == NULL) {
469 unicodestr= PyString_InternFromString("__unicode__");
470 if (unicodestr == NULL)
471 return NULL;
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000472 }
Brett Cannonc3647ac2005-04-26 03:45:26 +0000473 func = PyObject_GetAttr(v, unicodestr);
474 if (func != NULL) {
475 res = PyEval_CallObject(func, (PyObject *)NULL);
476 Py_DECREF(func);
477 }
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000478 else {
Brett Cannonc3647ac2005-04-26 03:45:26 +0000479 PyErr_Clear();
480 if (PyUnicode_Check(v)) {
481 /* For a Unicode subtype that's didn't overwrite __unicode__,
482 return a true Unicode object with the same data. */
483 return PyUnicode_FromUnicode(PyUnicode_AS_UNICODE(v),
484 PyUnicode_GET_SIZE(v));
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000485 }
Brett Cannonc3647ac2005-04-26 03:45:26 +0000486 if (PyString_CheckExact(v)) {
487 Py_INCREF(v);
488 res = v;
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000489 }
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000490 else {
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000491 if (v->ob_type->tp_str != NULL)
492 res = (*v->ob_type->tp_str)(v);
493 else
494 res = PyObject_Repr(v);
495 }
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000496 }
497 if (res == NULL)
498 return NULL;
499 if (!PyUnicode_Check(res)) {
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000500 str = PyUnicode_FromEncodedObject(res, NULL, "strict");
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000501 Py_DECREF(res);
Neal Norwitz75801462006-03-14 06:02:16 +0000502 res = str;
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000503 }
504 return res;
505}
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000506#endif
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000507
508
Guido van Rossuma4073002002-05-31 20:03:54 +0000509/* Helper to warn about deprecated tp_compare return values. Return:
510 -2 for an exception;
511 -1 if v < w;
512 0 if v == w;
513 1 if v > w.
514 (This function cannot return 2.)
515*/
516static int
517adjust_tp_compare(int c)
518{
519 if (PyErr_Occurred()) {
520 if (c != -1 && c != -2) {
521 PyObject *t, *v, *tb;
522 PyErr_Fetch(&t, &v, &tb);
523 if (PyErr_Warn(PyExc_RuntimeWarning,
524 "tp_compare didn't return -1 or -2 "
525 "for exception") < 0) {
526 Py_XDECREF(t);
527 Py_XDECREF(v);
528 Py_XDECREF(tb);
529 }
530 else
531 PyErr_Restore(t, v, tb);
532 }
533 return -2;
534 }
535 else if (c < -1 || c > 1) {
536 if (PyErr_Warn(PyExc_RuntimeWarning,
537 "tp_compare didn't return -1, 0 or 1") < 0)
538 return -2;
539 else
540 return c < -1 ? -1 : 1;
541 }
542 else {
543 assert(c >= -1 && c <= 1);
544 return c;
545 }
546}
547
548
Guido van Rossumd1f06b92001-01-24 22:14:43 +0000549/* Macro to get the tp_richcompare field of a type if defined */
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000550#define RICHCOMPARE(t) ((t)->tp_richcompare)
Guido van Rossumd1f06b92001-01-24 22:14:43 +0000551
Guido van Rossume797ec12001-01-17 15:24:28 +0000552/* Map rich comparison operators to their swapped version, e.g. LT --> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000553int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000554
Guido van Rossume797ec12001-01-17 15:24:28 +0000555/* Try a genuine rich comparison, returning an object. Return:
556 NULL for exception;
557 NotImplemented if this particular rich comparison is not implemented or
558 undefined;
559 some object not equal to NotImplemented if it is implemented
560 (this latter object may not be a Boolean).
561*/
562static PyObject *
563try_rich_compare(PyObject *v, PyObject *w, int op)
564{
565 richcmpfunc f;
566 PyObject *res;
567
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000568 if (v->ob_type != w->ob_type &&
569 PyType_IsSubtype(w->ob_type, v->ob_type) &&
570 (f = RICHCOMPARE(w->ob_type)) != NULL) {
Tim Petersf4aca752004-09-23 02:39:37 +0000571 res = (*f)(w, v, _Py_SwappedOp[op]);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +0000572 if (res != Py_NotImplemented)
573 return res;
574 Py_DECREF(res);
575 }
Guido van Rossumd1f06b92001-01-24 22:14:43 +0000576 if ((f = RICHCOMPARE(v->ob_type)) != NULL) {
Guido van Rossume797ec12001-01-17 15:24:28 +0000577 res = (*f)(v, w, op);
578 if (res != Py_NotImplemented)
579 return res;
580 Py_DECREF(res);
581 }
Guido van Rossumd1f06b92001-01-24 22:14:43 +0000582 if ((f = RICHCOMPARE(w->ob_type)) != NULL) {
Tim Petersf4aca752004-09-23 02:39:37 +0000583 return (*f)(w, v, _Py_SwappedOp[op]);
Guido van Rossume797ec12001-01-17 15:24:28 +0000584 }
585 res = Py_NotImplemented;
586 Py_INCREF(res);
587 return res;
588}
589
590/* Try a genuine rich comparison, returning an int. Return:
591 -1 for exception (including the case where try_rich_compare() returns an
592 object that's not a Boolean);
Tim Petersc99213f2001-11-04 05:57:16 +0000593 0 if the outcome is false;
594 1 if the outcome is true;
595 2 if this particular rich comparison is not implemented or undefined.
Guido van Rossume797ec12001-01-17 15:24:28 +0000596*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000597static int
Guido van Rossume797ec12001-01-17 15:24:28 +0000598try_rich_compare_bool(PyObject *v, PyObject *w, int op)
599{
600 PyObject *res;
601 int ok;
602
Guido van Rossumd1f06b92001-01-24 22:14:43 +0000603 if (RICHCOMPARE(v->ob_type) == NULL && RICHCOMPARE(w->ob_type) == NULL)
Guido van Rossume797ec12001-01-17 15:24:28 +0000604 return 2; /* Shortcut, avoid INCREF+DECREF */
605 res = try_rich_compare(v, w, op);
606 if (res == NULL)
607 return -1;
608 if (res == Py_NotImplemented) {
609 Py_DECREF(res);
610 return 2;
611 }
612 ok = PyObject_IsTrue(res);
613 Py_DECREF(res);
614 return ok;
615}
616
617/* Try rich comparisons to determine a 3-way comparison. Return:
618 -2 for an exception;
Tim Petersc99213f2001-11-04 05:57:16 +0000619 -1 if v < w;
620 0 if v == w;
621 1 if v > w;
622 2 if this particular rich comparison is not implemented or undefined.
Guido van Rossume797ec12001-01-17 15:24:28 +0000623*/
624static int
625try_rich_to_3way_compare(PyObject *v, PyObject *w)
626{
Guido van Rossum2ffbf6b2001-01-17 21:27:02 +0000627 static struct { int op; int outcome; } tries[3] = {
628 /* Try this operator, and if it is true, use this outcome: */
629 {Py_EQ, 0},
630 {Py_LT, -1},
631 {Py_GT, 1},
632 };
633 int i;
634
Guido van Rossumd1f06b92001-01-24 22:14:43 +0000635 if (RICHCOMPARE(v->ob_type) == NULL && RICHCOMPARE(w->ob_type) == NULL)
Guido van Rossume797ec12001-01-17 15:24:28 +0000636 return 2; /* Shortcut */
Guido van Rossum2ffbf6b2001-01-17 21:27:02 +0000637
638 for (i = 0; i < 3; i++) {
639 switch (try_rich_compare_bool(v, w, tries[i].op)) {
640 case -1:
Tim Peters6d60b2e2001-05-07 20:53:51 +0000641 return -2;
Guido van Rossum2ffbf6b2001-01-17 21:27:02 +0000642 case 1:
643 return tries[i].outcome;
644 }
Guido van Rossume797ec12001-01-17 15:24:28 +0000645 }
Guido van Rossum2ffbf6b2001-01-17 21:27:02 +0000646
647 return 2;
Guido van Rossume797ec12001-01-17 15:24:28 +0000648}
649
650/* Try a 3-way comparison, returning an int. Return:
651 -2 for an exception;
Tim Petersc99213f2001-11-04 05:57:16 +0000652 -1 if v < w;
653 0 if v == w;
654 1 if v > w;
655 2 if this particular 3-way comparison is not implemented or undefined.
Guido van Rossume797ec12001-01-17 15:24:28 +0000656*/
657static int
658try_3way_compare(PyObject *v, PyObject *w)
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000659{
660 int c;
Guido van Rossume797ec12001-01-17 15:24:28 +0000661 cmpfunc f;
662
663 /* Comparisons involving instances are given to instance_compare,
664 which has the same return conventions as this function. */
665
Guido van Rossumab3b0342001-09-18 20:38:53 +0000666 f = v->ob_type->tp_compare;
Guido van Rossume797ec12001-01-17 15:24:28 +0000667
Guido van Rossumab3b0342001-09-18 20:38:53 +0000668 /* If both have the same (non-NULL) tp_compare, use it. */
669 if (f != NULL && f == w->ob_type->tp_compare) {
670 c = (*f)(v, w);
Guido van Rossuma4073002002-05-31 20:03:54 +0000671 return adjust_tp_compare(c);
Guido van Rossumab3b0342001-09-18 20:38:53 +0000672 }
673
674 /* If either tp_compare is _PyObject_SlotCompare, that's safe. */
675 if (f == _PyObject_SlotCompare ||
676 w->ob_type->tp_compare == _PyObject_SlotCompare)
677 return _PyObject_SlotCompare(v, w);
678
Armin Rigoa1748132004-12-23 22:13:13 +0000679 /* If we're here, v and w,
680 a) are not instances;
681 b) have different types or a type without tp_compare; and
682 c) don't have a user-defined tp_compare.
683 tp_compare implementations in C assume that both arguments
684 have their type, so we give up if the coercion fails or if
685 it yields types which are still incompatible (which can
686 happen with a user-defined nb_coerce).
687 */
Guido van Rossume797ec12001-01-17 15:24:28 +0000688 c = PyNumber_CoerceEx(&v, &w);
689 if (c < 0)
690 return -2;
691 if (c > 0)
692 return 2;
Armin Rigoa1748132004-12-23 22:13:13 +0000693 f = v->ob_type->tp_compare;
694 if (f != NULL && f == w->ob_type->tp_compare) {
Guido van Rossume797ec12001-01-17 15:24:28 +0000695 c = (*f)(v, w);
696 Py_DECREF(v);
697 Py_DECREF(w);
Guido van Rossuma4073002002-05-31 20:03:54 +0000698 return adjust_tp_compare(c);
Guido van Rossume797ec12001-01-17 15:24:28 +0000699 }
700
Guido van Rossume797ec12001-01-17 15:24:28 +0000701 /* No comparison defined */
702 Py_DECREF(v);
703 Py_DECREF(w);
704 return 2;
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000705}
706
Guido van Rossume797ec12001-01-17 15:24:28 +0000707/* Final fallback 3-way comparison, returning an int. Return:
708 -2 if an error occurred;
Tim Petersc99213f2001-11-04 05:57:16 +0000709 -1 if v < w;
710 0 if v == w;
711 1 if v > w.
Guido van Rossume797ec12001-01-17 15:24:28 +0000712*/
713static int
714default_3way_compare(PyObject *v, PyObject *w)
715{
716 int c;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000717 const char *vname, *wname;
Guido van Rossume797ec12001-01-17 15:24:28 +0000718
719 if (v->ob_type == w->ob_type) {
Barry Warsawb0e754d2001-01-20 06:24:55 +0000720 /* When comparing these pointers, they must be cast to
721 * integer types (i.e. Py_uintptr_t, our spelling of C9X's
722 * uintptr_t). ANSI specifies that pointer compares other
723 * than == and != to non-related structures are undefined.
724 */
Barry Warsaw71ff8d52001-01-20 06:08:10 +0000725 Py_uintptr_t vv = (Py_uintptr_t)v;
726 Py_uintptr_t ww = (Py_uintptr_t)w;
Guido van Rossume797ec12001-01-17 15:24:28 +0000727 return (vv < ww) ? -1 : (vv > ww) ? 1 : 0;
728 }
729
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000730#ifdef Py_USING_UNICODE
Guido van Rossume797ec12001-01-17 15:24:28 +0000731 /* Special case for Unicode */
732 if (PyUnicode_Check(v) || PyUnicode_Check(w)) {
733 c = PyUnicode_Compare(v, w);
734 if (!PyErr_Occurred())
735 return c;
736 /* TypeErrors are ignored: if Unicode coercion fails due
737 to one of the arguments not having the right type, we
738 continue as defined by the coercion protocol (see
739 above). Luckily, decoding errors are reported as
740 ValueErrors and are not masked by this technique. */
741 if (!PyErr_ExceptionMatches(PyExc_TypeError))
742 return -2;
743 PyErr_Clear();
744 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000745#endif
Guido van Rossume797ec12001-01-17 15:24:28 +0000746
Guido van Rossum0871e932001-01-22 19:28:09 +0000747 /* None is smaller than anything */
748 if (v == Py_None)
749 return -1;
750 if (w == Py_None)
751 return 1;
752
Guido van Rossumfb50d3f2003-02-18 16:40:09 +0000753 /* different type: compare type names; numbers are smaller */
754 if (PyNumber_Check(v))
Guido van Rossum8f9143d2001-01-22 15:59:32 +0000755 vname = "";
756 else
757 vname = v->ob_type->tp_name;
Guido van Rossumfb50d3f2003-02-18 16:40:09 +0000758 if (PyNumber_Check(w))
Guido van Rossum8f9143d2001-01-22 15:59:32 +0000759 wname = "";
760 else
761 wname = w->ob_type->tp_name;
762 c = strcmp(vname, wname);
763 if (c < 0)
764 return -1;
765 if (c > 0)
766 return 1;
767 /* Same type name, or (more likely) incomparable numeric types */
768 return ((Py_uintptr_t)(v->ob_type) < (
769 Py_uintptr_t)(w->ob_type)) ? -1 : 1;
Guido van Rossume797ec12001-01-17 15:24:28 +0000770}
771
Tim Peters6d60b2e2001-05-07 20:53:51 +0000772/* Do a 3-way comparison, by hook or by crook. Return:
Guido van Rossuma4073002002-05-31 20:03:54 +0000773 -2 for an exception (but see below);
Tim Petersc99213f2001-11-04 05:57:16 +0000774 -1 if v < w;
Tim Peters6d60b2e2001-05-07 20:53:51 +0000775 0 if v == w;
Tim Petersc99213f2001-11-04 05:57:16 +0000776 1 if v > w;
Guido van Rossuma4073002002-05-31 20:03:54 +0000777 BUT: if the object implements a tp_compare function, it returns
Martin v. Löwis0163d6d2001-06-09 07:34:05 +0000778 whatever this function returns (whether with an exception or not).
Tim Peters6d60b2e2001-05-07 20:53:51 +0000779*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000780static int
Fred Drake100814d2000-07-09 15:48:49 +0000781do_cmp(PyObject *v, PyObject *w)
Guido van Rossum20566841995-01-12 11:26:10 +0000782{
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000783 int c;
Martin v. Löwis0163d6d2001-06-09 07:34:05 +0000784 cmpfunc f;
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000785
Martin v. Löwis0163d6d2001-06-09 07:34:05 +0000786 if (v->ob_type == w->ob_type
Guido van Rossum82fc51c12001-08-16 08:02:45 +0000787 && (f = v->ob_type->tp_compare) != NULL) {
788 c = (*f)(v, w);
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000789 return adjust_tp_compare(c);
Guido van Rossum82fc51c12001-08-16 08:02:45 +0000790 }
Guido van Rossuma4073002002-05-31 20:03:54 +0000791 /* We only get here if one of the following is true:
792 a) v and w have different types
793 b) v and w have the same type, which doesn't have tp_compare
794 c) v and w are instances, and either __cmp__ is not defined or
795 __cmp__ returns NotImplemented
796 */
Guido van Rossume797ec12001-01-17 15:24:28 +0000797 c = try_rich_to_3way_compare(v, w);
798 if (c < 2)
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000799 return c;
Guido van Rossume797ec12001-01-17 15:24:28 +0000800 c = try_3way_compare(v, w);
801 if (c < 2)
802 return c;
803 return default_3way_compare(v, w);
Guido van Rossum20566841995-01-12 11:26:10 +0000804}
805
Tim Petersc99213f2001-11-04 05:57:16 +0000806/* Compare v to w. Return
807 -1 if v < w or exception (PyErr_Occurred() true in latter case).
808 0 if v == w.
809 1 if v > w.
810 XXX The docs (C API manual) say the return value is undefined in case
811 XXX of error.
812*/
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000813int
Fred Drake100814d2000-07-09 15:48:49 +0000814PyObject_Compare(PyObject *v, PyObject *w)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000815{
Jeremy Hylton4a3dd2d2000-04-14 19:13:24 +0000816 int result;
817
Guido van Rossumc8b6df91997-05-23 00:06:51 +0000818 if (v == NULL || w == NULL) {
819 PyErr_BadInternalCall();
820 return -1;
821 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000822 if (v == w)
823 return 0;
Armin Rigo2b3eb402003-10-28 12:05:48 +0000824 if (Py_EnterRecursiveCall(" in cmp"))
825 return -1;
826 result = do_cmp(v, w);
827 Py_LeaveRecursiveCall();
Guido van Rossume797ec12001-01-17 15:24:28 +0000828 return result < 0 ? -1 : result;
829}
830
Tim Petersc99213f2001-11-04 05:57:16 +0000831/* Return (new reference to) Py_True or Py_False. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000832static PyObject *
Martin v. Löwis0163d6d2001-06-09 07:34:05 +0000833convert_3way_to_object(int op, int c)
Guido van Rossume797ec12001-01-17 15:24:28 +0000834{
Guido van Rossume797ec12001-01-17 15:24:28 +0000835 PyObject *result;
Guido van Rossume797ec12001-01-17 15:24:28 +0000836 switch (op) {
837 case Py_LT: c = c < 0; break;
838 case Py_LE: c = c <= 0; break;
839 case Py_EQ: c = c == 0; break;
840 case Py_NE: c = c != 0; break;
841 case Py_GT: c = c > 0; break;
842 case Py_GE: c = c >= 0; break;
843 }
844 result = c ? Py_True : Py_False;
845 Py_INCREF(result);
Jeremy Hylton4a3dd2d2000-04-14 19:13:24 +0000846 return result;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000847}
Tim Peters803526b2002-07-07 05:13:56 +0000848
Tim Petersc99213f2001-11-04 05:57:16 +0000849/* We want a rich comparison but don't have one. Try a 3-way cmp instead.
850 Return
851 NULL if error
852 Py_True if v op w
853 Py_False if not (v op w)
854*/
Martin v. Löwis0163d6d2001-06-09 07:34:05 +0000855static PyObject *
856try_3way_to_rich_compare(PyObject *v, PyObject *w, int op)
857{
858 int c;
859
860 c = try_3way_compare(v, w);
861 if (c >= 2)
862 c = default_3way_compare(v, w);
863 if (c <= -2)
864 return NULL;
865 return convert_3way_to_object(op, c);
866}
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000867
Tim Petersc99213f2001-11-04 05:57:16 +0000868/* Do rich comparison on v and w. Return
869 NULL if error
870 Else a new reference to an object other than Py_NotImplemented, usually(?):
871 Py_True if v op w
872 Py_False if not (v op w)
873*/
Neil Schemenauerd38855c2001-01-21 16:25:18 +0000874static PyObject *
Guido van Rossume797ec12001-01-17 15:24:28 +0000875do_richcmp(PyObject *v, PyObject *w, int op)
876{
877 PyObject *res;
878
879 res = try_rich_compare(v, w, op);
880 if (res != Py_NotImplemented)
881 return res;
882 Py_DECREF(res);
883
884 return try_3way_to_rich_compare(v, w, op);
885}
886
Tim Petersc99213f2001-11-04 05:57:16 +0000887/* Return:
888 NULL for exception;
Tim Petersc99213f2001-11-04 05:57:16 +0000889 some object not equal to NotImplemented if it is implemented
890 (this latter object may not be a Boolean).
891*/
Guido van Rossume797ec12001-01-17 15:24:28 +0000892PyObject *
893PyObject_RichCompare(PyObject *v, PyObject *w, int op)
894{
895 PyObject *res;
896
897 assert(Py_LT <= op && op <= Py_GE);
Armin Rigo2b3eb402003-10-28 12:05:48 +0000898 if (Py_EnterRecursiveCall(" in cmp"))
899 return NULL;
Guido van Rossume797ec12001-01-17 15:24:28 +0000900
Armin Rigo2b3eb402003-10-28 12:05:48 +0000901 /* If the types are equal, and not old-style instances, try to
Tim Peters67754e92001-11-04 07:29:31 +0000902 get out cheap (don't bother with coercions etc.). */
Guido van Rossum50e9fb92006-08-17 05:42:55 +0000903 if (v->ob_type == w->ob_type) {
Tim Peters67754e92001-11-04 07:29:31 +0000904 cmpfunc fcmp;
905 richcmpfunc frich = RICHCOMPARE(v->ob_type);
906 /* If the type has richcmp, try it first. try_rich_compare
907 tries it two-sided, which is not needed since we've a
908 single type only. */
909 if (frich != NULL) {
910 res = (*frich)(v, w, op);
911 if (res != Py_NotImplemented)
912 goto Done;
913 Py_DECREF(res);
914 }
915 /* No richcmp, or this particular richmp not implemented.
916 Try 3-way cmp. */
917 fcmp = v->ob_type->tp_compare;
918 if (fcmp != NULL) {
919 int c = (*fcmp)(v, w);
Guido van Rossuma4073002002-05-31 20:03:54 +0000920 c = adjust_tp_compare(c);
921 if (c == -2) {
Tim Peters67754e92001-11-04 07:29:31 +0000922 res = NULL;
923 goto Done;
924 }
925 res = convert_3way_to_object(op, c);
926 goto Done;
927 }
Guido van Rossum2ffbf6b2001-01-17 21:27:02 +0000928 }
Tim Peters67754e92001-11-04 07:29:31 +0000929
930 /* Fast path not taken, or couldn't deliver a useful result. */
931 res = do_richcmp(v, w, op);
932Done:
Armin Rigo2b3eb402003-10-28 12:05:48 +0000933 Py_LeaveRecursiveCall();
Guido van Rossume797ec12001-01-17 15:24:28 +0000934 return res;
935}
936
Tim Petersde9725f2001-05-05 10:06:17 +0000937/* Return -1 if error; 1 if v op w; 0 if not (v op w). */
Guido van Rossume797ec12001-01-17 15:24:28 +0000938int
939PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
940{
Raymond Hettinger93d44812004-03-21 17:01:44 +0000941 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000942 int ok;
943
Raymond Hettinger93d44812004-03-21 17:01:44 +0000944 /* Quick result when objects are the same.
945 Guarantees that identity implies equality. */
946 if (v == w) {
947 if (op == Py_EQ)
948 return 1;
949 else if (op == Py_NE)
950 return 0;
951 }
952
953 res = PyObject_RichCompare(v, w, op);
Guido van Rossume797ec12001-01-17 15:24:28 +0000954 if (res == NULL)
955 return -1;
Guido van Rossum81912d42002-08-24 05:33:28 +0000956 if (PyBool_Check(res))
957 ok = (res == Py_True);
958 else
959 ok = PyObject_IsTrue(res);
Guido van Rossume797ec12001-01-17 15:24:28 +0000960 Py_DECREF(res);
961 return ok;
962}
Fred Drake13634cf2000-06-29 19:17:04 +0000963
964/* Set of hash utility functions to help maintaining the invariant that
Raymond Hettinger8183fa42004-03-21 17:35:06 +0000965 if a==b then hash(a)==hash(b)
Fred Drake13634cf2000-06-29 19:17:04 +0000966
967 All the utility functions (_Py_Hash*()) return "-1" to signify an error.
968*/
969
970long
Fred Drake100814d2000-07-09 15:48:49 +0000971_Py_HashDouble(double v)
Fred Drake13634cf2000-06-29 19:17:04 +0000972{
Tim Peters39dce292000-08-15 03:34:48 +0000973 double intpart, fractpart;
974 int expo;
975 long hipart;
976 long x; /* the final hash value */
977 /* This is designed so that Python numbers of different types
978 * that compare equal hash to the same value; otherwise comparisons
979 * of mapping keys will turn out weird.
980 */
981
Tim Peters39dce292000-08-15 03:34:48 +0000982 fractpart = modf(v, &intpart);
Tim Peters39dce292000-08-15 03:34:48 +0000983 if (fractpart == 0.0) {
984 /* This must return the same hash as an equal int or long. */
985 if (intpart > LONG_MAX || -intpart > LONG_MAX) {
986 /* Convert to long and use its hash. */
987 PyObject *plong; /* converted to Python long */
988 if (Py_IS_INFINITY(intpart))
989 /* can't convert to long int -- arbitrary */
990 v = v < 0 ? -271828.0 : 314159.0;
991 plong = PyLong_FromDouble(v);
992 if (plong == NULL)
993 return -1;
994 x = PyObject_Hash(plong);
995 Py_DECREF(plong);
996 return x;
997 }
998 /* Fits in a C long == a Python int, so is its own hash. */
999 x = (long)intpart;
1000 if (x == -1)
1001 x = -2;
1002 return x;
1003 }
1004 /* The fractional part is non-zero, so we don't have to worry about
1005 * making this match the hash of some other type.
1006 * Use frexp to get at the bits in the double.
Fred Drake13634cf2000-06-29 19:17:04 +00001007 * Since the VAX D double format has 56 mantissa bits, which is the
1008 * most of any double format in use, each of these parts may have as
1009 * many as (but no more than) 56 significant bits.
Tim Peters39dce292000-08-15 03:34:48 +00001010 * So, assuming sizeof(long) >= 4, each part can be broken into two
1011 * longs; frexp and multiplication are used to do that.
1012 * Also, since the Cray double format has 15 exponent bits, which is
1013 * the most of any double format in use, shifting the exponent field
1014 * left by 15 won't overflow a long (again assuming sizeof(long) >= 4).
Fred Drake13634cf2000-06-29 19:17:04 +00001015 */
Tim Peters39dce292000-08-15 03:34:48 +00001016 v = frexp(v, &expo);
1017 v *= 2147483648.0; /* 2**31 */
1018 hipart = (long)v; /* take the top 32 bits */
1019 v = (v - (double)hipart) * 2147483648.0; /* get the next 32 bits */
1020 x = hipart + (long)v + (expo << 15);
1021 if (x == -1)
1022 x = -2;
1023 return x;
Fred Drake13634cf2000-06-29 19:17:04 +00001024}
1025
1026long
Fred Drake100814d2000-07-09 15:48:49 +00001027_Py_HashPointer(void *p)
Fred Drake13634cf2000-06-29 19:17:04 +00001028{
1029#if SIZEOF_LONG >= SIZEOF_VOID_P
1030 return (long)p;
1031#else
1032 /* convert to a Python long and hash that */
1033 PyObject* longobj;
1034 long x;
Tim Peters803526b2002-07-07 05:13:56 +00001035
Fred Drake13634cf2000-06-29 19:17:04 +00001036 if ((longobj = PyLong_FromVoidPtr(p)) == NULL) {
1037 x = -1;
1038 goto finally;
1039 }
1040 x = PyObject_Hash(longobj);
Tim Peters803526b2002-07-07 05:13:56 +00001041
Fred Drake13634cf2000-06-29 19:17:04 +00001042finally:
1043 Py_XDECREF(longobj);
1044 return x;
1045#endif
1046}
1047
1048
Guido van Rossum9bfef441993-03-29 10:43:31 +00001049long
Fred Drake100814d2000-07-09 15:48:49 +00001050PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +00001051{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001052 PyTypeObject *tp = v->ob_type;
Guido van Rossum9bfef441993-03-29 10:43:31 +00001053 if (tp->tp_hash != NULL)
1054 return (*tp->tp_hash)(v);
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001055 /* Otherwise, the object can't be hashed */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001056 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
1057 v->ob_type->tp_name);
Guido van Rossum9bfef441993-03-29 10:43:31 +00001058 return -1;
1059}
1060
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001061PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001062PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001063{
Tim Peters6d6c1a32001-08-02 04:15:00 +00001064 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +00001065
Tim Peters6d6c1a32001-08-02 04:15:00 +00001066 if (v->ob_type->tp_getattr != NULL)
Martin v. Löwis15e62742006-02-27 16:46:16 +00001067 return (*v->ob_type->tp_getattr)(v, (char*)name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001068 w = PyString_InternFromString(name);
1069 if (w == NULL)
1070 return NULL;
1071 res = PyObject_GetAttr(v, w);
1072 Py_XDECREF(w);
1073 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +00001074}
1075
1076int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001077PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +00001078{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001079 PyObject *res = PyObject_GetAttrString(v, name);
Guido van Rossumed18fdc1993-07-11 19:55:34 +00001080 if (res != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001081 Py_DECREF(res);
Guido van Rossumed18fdc1993-07-11 19:55:34 +00001082 return 1;
1083 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001084 PyErr_Clear();
Guido van Rossumed18fdc1993-07-11 19:55:34 +00001085 return 0;
1086}
1087
1088int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001089PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001090{
Tim Peters6d6c1a32001-08-02 04:15:00 +00001091 PyObject *s;
1092 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +00001093
Tim Peters6d6c1a32001-08-02 04:15:00 +00001094 if (v->ob_type->tp_setattr != NULL)
Martin v. Löwis15e62742006-02-27 16:46:16 +00001095 return (*v->ob_type->tp_setattr)(v, (char*)name, w);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001096 s = PyString_InternFromString(name);
1097 if (s == NULL)
1098 return -1;
1099 res = PyObject_SetAttr(v, s, w);
1100 Py_XDECREF(s);
1101 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +00001102}
1103
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001104PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001105PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001106{
Tim Peters6d6c1a32001-08-02 04:15:00 +00001107 PyTypeObject *tp = v->ob_type;
1108
Jeremy Hylton99a8f902000-06-23 14:36:32 +00001109 if (!PyString_Check(name)) {
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001110#ifdef Py_USING_UNICODE
1111 /* The Unicode to string conversion is done here because the
1112 existing tp_getattro slots expect a string object as name
1113 and we wouldn't want to break those. */
1114 if (PyUnicode_Check(name)) {
1115 name = _PyUnicode_AsDefaultEncodedString(name, NULL);
1116 if (name == NULL)
1117 return NULL;
1118 }
1119 else
1120#endif
1121 {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001122 PyErr_Format(PyExc_TypeError,
1123 "attribute name must be string, not '%.200s'",
1124 name->ob_type->tp_name);
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001125 return NULL;
1126 }
Jeremy Hylton99a8f902000-06-23 14:36:32 +00001127 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001128 if (tp->tp_getattro != NULL)
1129 return (*tp->tp_getattro)(v, name);
1130 if (tp->tp_getattr != NULL)
1131 return (*tp->tp_getattr)(v, PyString_AS_STRING(name));
1132 PyErr_Format(PyExc_AttributeError,
1133 "'%.50s' object has no attribute '%.400s'",
1134 tp->tp_name, PyString_AS_STRING(name));
1135 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001136}
1137
1138int
Fred Drake100814d2000-07-09 15:48:49 +00001139PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001140{
1141 PyObject *res = PyObject_GetAttr(v, name);
1142 if (res != NULL) {
1143 Py_DECREF(res);
1144 return 1;
1145 }
1146 PyErr_Clear();
1147 return 0;
1148}
1149
1150int
Fred Drake100814d2000-07-09 15:48:49 +00001151PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001152{
Tim Peters6d6c1a32001-08-02 04:15:00 +00001153 PyTypeObject *tp = v->ob_type;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001154 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +00001155
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001156 if (!PyString_Check(name)){
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001157#ifdef Py_USING_UNICODE
1158 /* The Unicode to string conversion is done here because the
1159 existing tp_setattro slots expect a string object as name
1160 and we wouldn't want to break those. */
1161 if (PyUnicode_Check(name)) {
1162 name = PyUnicode_AsEncodedString(name, NULL, NULL);
1163 if (name == NULL)
1164 return -1;
1165 }
Tim Peters803526b2002-07-07 05:13:56 +00001166 else
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001167#endif
1168 {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001169 PyErr_Format(PyExc_TypeError,
1170 "attribute name must be string, not '%.200s'",
1171 name->ob_type->tp_name);
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001172 return -1;
1173 }
Jeremy Hylton99a8f902000-06-23 14:36:32 +00001174 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001175 else
1176 Py_INCREF(name);
1177
1178 PyString_InternInPlace(&name);
1179 if (tp->tp_setattro != NULL) {
1180 err = (*tp->tp_setattro)(v, name, value);
1181 Py_DECREF(name);
1182 return err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +00001183 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001184 if (tp->tp_setattr != NULL) {
1185 err = (*tp->tp_setattr)(v, PyString_AS_STRING(name), value);
1186 Py_DECREF(name);
1187 return err;
1188 }
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001189 Py_DECREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001190 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
1191 PyErr_Format(PyExc_TypeError,
1192 "'%.100s' object has no attributes "
1193 "(%s .%.100s)",
1194 tp->tp_name,
1195 value==NULL ? "del" : "assign to",
1196 PyString_AS_STRING(name));
1197 else
1198 PyErr_Format(PyExc_TypeError,
1199 "'%.100s' object has only read-only attributes "
1200 "(%s .%.100s)",
1201 tp->tp_name,
1202 value==NULL ? "del" : "assign to",
1203 PyString_AS_STRING(name));
1204 return -1;
1205}
1206
1207/* Helper to get a pointer to an object's __dict__ slot, if any */
1208
1209PyObject **
1210_PyObject_GetDictPtr(PyObject *obj)
1211{
Martin v. Löwis725507b2006-03-07 12:08:51 +00001212 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001213 PyTypeObject *tp = obj->ob_type;
1214
Tim Peters6d6c1a32001-08-02 04:15:00 +00001215 dictoffset = tp->tp_dictoffset;
1216 if (dictoffset == 0)
1217 return NULL;
1218 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001219 Py_ssize_t tsize;
Guido van Rossum2eb0b872002-03-01 22:24:49 +00001220 size_t size;
1221
1222 tsize = ((PyVarObject *)obj)->ob_size;
1223 if (tsize < 0)
1224 tsize = -tsize;
1225 size = _PyObject_VAR_SIZE(tp, tsize);
1226
Tim Peters6d483d32001-10-06 21:27:34 +00001227 dictoffset += (long)size;
1228 assert(dictoffset > 0);
1229 assert(dictoffset % SIZEOF_VOID_P == 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001230 }
1231 return (PyObject **) ((char *)obj + dictoffset);
1232}
1233
Tim Peters6d6c1a32001-08-02 04:15:00 +00001234PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +00001235PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +00001236{
1237 Py_INCREF(obj);
1238 return obj;
1239}
1240
Michael W. Hudson1593f502004-09-14 17:09:47 +00001241/* Generic GetAttr functions - put these in your tp_[gs]etattro slot */
1242
Raymond Hettinger01538262003-03-17 08:24:35 +00001243PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001244PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
1245{
1246 PyTypeObject *tp = obj->ob_type;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001247 PyObject *descr = NULL;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001248 PyObject *res = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001249 descrgetfunc f;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001250 Py_ssize_t dictoffset;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001251 PyObject **dictptr;
1252
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001253 if (!PyString_Check(name)){
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001254#ifdef Py_USING_UNICODE
1255 /* The Unicode to string conversion is done here because the
1256 existing tp_setattro slots expect a string object as name
1257 and we wouldn't want to break those. */
1258 if (PyUnicode_Check(name)) {
1259 name = PyUnicode_AsEncodedString(name, NULL, NULL);
1260 if (name == NULL)
1261 return NULL;
1262 }
Tim Peters803526b2002-07-07 05:13:56 +00001263 else
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001264#endif
1265 {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001266 PyErr_Format(PyExc_TypeError,
1267 "attribute name must be string, not '%.200s'",
1268 name->ob_type->tp_name);
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001269 return NULL;
1270 }
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001271 }
1272 else
1273 Py_INCREF(name);
1274
Tim Peters6d6c1a32001-08-02 04:15:00 +00001275 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001276 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001277 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001278 }
1279
Guido van Rossum056fbf42002-08-19 19:22:50 +00001280 /* Inline _PyType_Lookup */
1281 {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001282 Py_ssize_t i, n;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001283 PyObject *mro, *base, *dict;
1284
1285 /* Look in tp_dict of types in MRO */
1286 mro = tp->tp_mro;
1287 assert(mro != NULL);
1288 assert(PyTuple_Check(mro));
1289 n = PyTuple_GET_SIZE(mro);
1290 for (i = 0; i < n; i++) {
1291 base = PyTuple_GET_ITEM(mro, i);
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001292 assert(PyType_Check(base));
1293 dict = ((PyTypeObject *)base)->tp_dict;
Guido van Rossum056fbf42002-08-19 19:22:50 +00001294 assert(dict && PyDict_Check(dict));
1295 descr = PyDict_GetItem(dict, name);
1296 if (descr != NULL)
1297 break;
1298 }
1299 }
1300
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001301 Py_XINCREF(descr);
1302
Tim Peters6d6c1a32001-08-02 04:15:00 +00001303 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001304 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001305 f = descr->ob_type->tp_descr_get;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001306 if (f != NULL && PyDescr_IsData(descr)) {
1307 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001308 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001309 goto done;
1310 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001311 }
1312
Guido van Rossumc66ff442002-08-19 16:50:48 +00001313 /* Inline _PyObject_GetDictPtr */
1314 dictoffset = tp->tp_dictoffset;
1315 if (dictoffset != 0) {
1316 PyObject *dict;
1317 if (dictoffset < 0) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001318 Py_ssize_t tsize;
Guido van Rossumc66ff442002-08-19 16:50:48 +00001319 size_t size;
1320
1321 tsize = ((PyVarObject *)obj)->ob_size;
1322 if (tsize < 0)
1323 tsize = -tsize;
1324 size = _PyObject_VAR_SIZE(tp, tsize);
1325
1326 dictoffset += (long)size;
1327 assert(dictoffset > 0);
1328 assert(dictoffset % SIZEOF_VOID_P == 0);
1329 }
1330 dictptr = (PyObject **) ((char *)obj + dictoffset);
1331 dict = *dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001332 if (dict != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001333 res = PyDict_GetItem(dict, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001334 if (res != NULL) {
1335 Py_INCREF(res);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001336 Py_XDECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001337 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001338 }
1339 }
1340 }
1341
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001342 if (f != NULL) {
1343 res = f(descr, obj, (PyObject *)obj->ob_type);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001344 Py_DECREF(descr);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001345 goto done;
1346 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001347
1348 if (descr != NULL) {
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001349 res = descr;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001350 /* descr was already increfed above */
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001351 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001352 }
1353
1354 PyErr_Format(PyExc_AttributeError,
1355 "'%.50s' object has no attribute '%.400s'",
1356 tp->tp_name, PyString_AS_STRING(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001357 done:
1358 Py_DECREF(name);
1359 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001360}
1361
1362int
1363PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1364{
1365 PyTypeObject *tp = obj->ob_type;
1366 PyObject *descr;
1367 descrsetfunc f;
1368 PyObject **dictptr;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001369 int res = -1;
1370
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001371 if (!PyString_Check(name)){
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001372#ifdef Py_USING_UNICODE
1373 /* The Unicode to string conversion is done here because the
1374 existing tp_setattro slots expect a string object as name
1375 and we wouldn't want to break those. */
1376 if (PyUnicode_Check(name)) {
1377 name = PyUnicode_AsEncodedString(name, NULL, NULL);
1378 if (name == NULL)
1379 return -1;
1380 }
Tim Peters803526b2002-07-07 05:13:56 +00001381 else
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001382#endif
1383 {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001384 PyErr_Format(PyExc_TypeError,
1385 "attribute name must be string, not '%.200s'",
1386 name->ob_type->tp_name);
Martin v. Löwis0c160a02002-03-15 13:40:30 +00001387 return -1;
1388 }
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001389 }
1390 else
1391 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001392
1393 if (tp->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001394 if (PyType_Ready(tp) < 0)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001395 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001396 }
1397
1398 descr = _PyType_Lookup(tp, name);
1399 f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001400 if (descr != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001401 f = descr->ob_type->tp_descr_set;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001402 if (f != NULL && PyDescr_IsData(descr)) {
1403 res = f(descr, obj, value);
1404 goto done;
1405 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001406 }
1407
1408 dictptr = _PyObject_GetDictPtr(obj);
1409 if (dictptr != NULL) {
1410 PyObject *dict = *dictptr;
1411 if (dict == NULL && value != NULL) {
1412 dict = PyDict_New();
1413 if (dict == NULL)
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001414 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001415 *dictptr = dict;
1416 }
1417 if (dict != NULL) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001418 if (value == NULL)
1419 res = PyDict_DelItem(dict, name);
1420 else
1421 res = PyDict_SetItem(dict, name, value);
1422 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1423 PyErr_SetObject(PyExc_AttributeError, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001424 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001425 }
1426 }
1427
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001428 if (f != NULL) {
1429 res = f(descr, obj, value);
1430 goto done;
1431 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001432
1433 if (descr == NULL) {
1434 PyErr_Format(PyExc_AttributeError,
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001435 "'%.100s' object has no attribute '%.200s'",
Tim Peters6d6c1a32001-08-02 04:15:00 +00001436 tp->tp_name, PyString_AS_STRING(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001437 goto done;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001438 }
1439
1440 PyErr_Format(PyExc_AttributeError,
1441 "'%.50s' object attribute '%.400s' is read-only",
1442 tp->tp_name, PyString_AS_STRING(name));
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001443 done:
1444 Py_DECREF(name);
1445 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001446}
1447
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001448/* Test a value used as condition, e.g., in a for or if statement.
1449 Return -1 if an error occurred */
1450
1451int
Fred Drake100814d2000-07-09 15:48:49 +00001452PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001453{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001454 Py_ssize_t res;
Guido van Rossum6248f442002-08-24 06:31:34 +00001455 if (v == Py_True)
1456 return 1;
1457 if (v == Py_False)
1458 return 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001459 if (v == Py_None)
Neal Norwitz51290d32002-06-13 21:32:44 +00001460 return 0;
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001461 else if (v->ob_type->tp_as_number != NULL &&
1462 v->ob_type->tp_as_number->nb_nonzero != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001463 res = (*v->ob_type->tp_as_number->nb_nonzero)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001464 else if (v->ob_type->tp_as_mapping != NULL &&
1465 v->ob_type->tp_as_mapping->mp_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001466 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
Guido van Rossum1c4f4581998-05-22 00:53:24 +00001467 else if (v->ob_type->tp_as_sequence != NULL &&
1468 v->ob_type->tp_as_sequence->sq_length != NULL)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001469 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1470 else
Neal Norwitz51290d32002-06-13 21:32:44 +00001471 return 1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001472 /* if it is negative, it should be either -1 or -2 */
1473 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001474}
1475
Tim Peters803526b2002-07-07 05:13:56 +00001476/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001477 Return -1 if an error occurred */
1478
1479int
Fred Drake100814d2000-07-09 15:48:49 +00001480PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001481{
1482 int res;
1483 res = PyObject_IsTrue(v);
1484 if (res < 0)
1485 return res;
1486 return res == 0;
1487}
1488
Guido van Rossum5524a591995-01-10 15:26:20 +00001489/* Coerce two numeric types to the "larger" one.
1490 Increment the reference count on each argument.
Guido van Rossume797ec12001-01-17 15:24:28 +00001491 Return value:
1492 -1 if an error occurred;
1493 0 if the coercion succeeded (and then the reference counts are increased);
1494 1 if no coercion is possible (and no error is raised).
Guido van Rossum5524a591995-01-10 15:26:20 +00001495*/
Guido van Rossum5524a591995-01-10 15:26:20 +00001496int
Fred Drake100814d2000-07-09 15:48:49 +00001497PyNumber_CoerceEx(PyObject **pv, PyObject **pw)
Guido van Rossum5524a591995-01-10 15:26:20 +00001498{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001499 register PyObject *v = *pv;
1500 register PyObject *w = *pw;
Guido van Rossum5524a591995-01-10 15:26:20 +00001501 int res;
1502
Guido van Rossum5524a591995-01-10 15:26:20 +00001503 if (v->ob_type->tp_as_number && v->ob_type->tp_as_number->nb_coerce) {
1504 res = (*v->ob_type->tp_as_number->nb_coerce)(pv, pw);
1505 if (res <= 0)
1506 return res;
1507 }
1508 if (w->ob_type->tp_as_number && w->ob_type->tp_as_number->nb_coerce) {
1509 res = (*w->ob_type->tp_as_number->nb_coerce)(pw, pv);
1510 if (res <= 0)
1511 return res;
1512 }
Guido van Rossum242c6421997-11-19 16:03:17 +00001513 return 1;
1514}
1515
Guido van Rossume797ec12001-01-17 15:24:28 +00001516/* Coerce two numeric types to the "larger" one.
1517 Increment the reference count on each argument.
1518 Return -1 and raise an exception if no coercion is possible
1519 (and then no reference count is incremented).
1520*/
Guido van Rossum242c6421997-11-19 16:03:17 +00001521int
Fred Drake100814d2000-07-09 15:48:49 +00001522PyNumber_Coerce(PyObject **pv, PyObject **pw)
Guido van Rossum242c6421997-11-19 16:03:17 +00001523{
1524 int err = PyNumber_CoerceEx(pv, pw);
1525 if (err <= 0)
1526 return err;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001527 PyErr_SetString(PyExc_TypeError, "number coercion failed");
Guido van Rossum5524a591995-01-10 15:26:20 +00001528 return -1;
1529}
1530
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001531
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001532/* Test whether an object can be called */
1533
1534int
Fred Drake100814d2000-07-09 15:48:49 +00001535PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001536{
1537 if (x == NULL)
1538 return 0;
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001539 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001540}
1541
Tim Peters7eea37e2001-09-04 22:08:56 +00001542/* Helper for PyObject_Dir.
1543 Merge the __dict__ of aclass into dict, and recursively also all
1544 the __dict__s of aclass's base classes. The order of merging isn't
1545 defined, as it's expected that only the final set of dict keys is
1546 interesting.
1547 Return 0 on success, -1 on error.
1548*/
1549
1550static int
1551merge_class_dict(PyObject* dict, PyObject* aclass)
1552{
1553 PyObject *classdict;
1554 PyObject *bases;
1555
1556 assert(PyDict_Check(dict));
1557 assert(aclass);
1558
1559 /* Merge in the type's dict (if any). */
1560 classdict = PyObject_GetAttrString(aclass, "__dict__");
1561 if (classdict == NULL)
1562 PyErr_Clear();
1563 else {
1564 int status = PyDict_Update(dict, classdict);
1565 Py_DECREF(classdict);
1566 if (status < 0)
1567 return -1;
1568 }
1569
1570 /* Recursively merge in the base types' (if any) dicts. */
1571 bases = PyObject_GetAttrString(aclass, "__bases__");
Tim Petersbc7e8632001-09-16 20:33:22 +00001572 if (bases == NULL)
1573 PyErr_Clear();
1574 else {
Guido van Rossum44022412002-05-13 18:29:46 +00001575 /* We have no guarantee that bases is a real tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001576 Py_ssize_t i, n;
Guido van Rossum44022412002-05-13 18:29:46 +00001577 n = PySequence_Size(bases); /* This better be right */
1578 if (n < 0)
1579 PyErr_Clear();
1580 else {
1581 for (i = 0; i < n; i++) {
Tim Peters18e70832003-02-05 19:35:19 +00001582 int status;
Guido van Rossum44022412002-05-13 18:29:46 +00001583 PyObject *base = PySequence_GetItem(bases, i);
1584 if (base == NULL) {
1585 Py_DECREF(bases);
1586 return -1;
1587 }
Tim Peters18e70832003-02-05 19:35:19 +00001588 status = merge_class_dict(dict, base);
1589 Py_DECREF(base);
1590 if (status < 0) {
Guido van Rossum44022412002-05-13 18:29:46 +00001591 Py_DECREF(bases);
1592 return -1;
1593 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001594 }
1595 }
1596 Py_DECREF(bases);
1597 }
1598 return 0;
1599}
1600
Tim Peters305b5852001-09-17 02:38:46 +00001601/* Helper for PyObject_Dir.
1602 If obj has an attr named attrname that's a list, merge its string
1603 elements into keys of dict.
1604 Return 0 on success, -1 on error. Errors due to not finding the attr,
1605 or the attr not being a list, are suppressed.
1606*/
1607
1608static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001609merge_list_attr(PyObject* dict, PyObject* obj, const char *attrname)
Tim Peters305b5852001-09-17 02:38:46 +00001610{
1611 PyObject *list;
1612 int result = 0;
1613
1614 assert(PyDict_Check(dict));
1615 assert(obj);
1616 assert(attrname);
1617
1618 list = PyObject_GetAttrString(obj, attrname);
1619 if (list == NULL)
1620 PyErr_Clear();
1621
1622 else if (PyList_Check(list)) {
1623 int i;
1624 for (i = 0; i < PyList_GET_SIZE(list); ++i) {
1625 PyObject *item = PyList_GET_ITEM(list, i);
1626 if (PyString_Check(item)) {
1627 result = PyDict_SetItem(dict, item, Py_None);
1628 if (result < 0)
1629 break;
1630 }
1631 }
1632 }
1633
1634 Py_XDECREF(list);
1635 return result;
1636}
1637
Tim Peters7eea37e2001-09-04 22:08:56 +00001638/* Like __builtin__.dir(arg). See bltinmodule.c's builtin_dir for the
1639 docstring, which should be kept in synch with this implementation. */
1640
1641PyObject *
1642PyObject_Dir(PyObject *arg)
1643{
1644 /* Set exactly one of these non-NULL before the end. */
1645 PyObject *result = NULL; /* result list */
1646 PyObject *masterdict = NULL; /* result is masterdict.keys() */
1647
1648 /* If NULL arg, return the locals. */
1649 if (arg == NULL) {
1650 PyObject *locals = PyEval_GetLocals();
1651 if (locals == NULL)
1652 goto error;
Raymond Hettinger214b1c32004-07-02 06:41:07 +00001653 result = PyMapping_Keys(locals);
Tim Peters7eea37e2001-09-04 22:08:56 +00001654 if (result == NULL)
1655 goto error;
1656 }
1657
1658 /* Elif this is some form of module, we only want its dict. */
Guido van Rossum8dbd3d82001-09-10 18:27:43 +00001659 else if (PyModule_Check(arg)) {
Tim Peters7eea37e2001-09-04 22:08:56 +00001660 masterdict = PyObject_GetAttrString(arg, "__dict__");
1661 if (masterdict == NULL)
1662 goto error;
Guido van Rossum8dbd3d82001-09-10 18:27:43 +00001663 if (!PyDict_Check(masterdict)) {
1664 PyErr_SetString(PyExc_TypeError,
1665 "module.__dict__ is not a dictionary");
1666 goto error;
1667 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001668 }
1669
1670 /* Elif some form of type or class, grab its dict and its bases.
1671 We deliberately don't suck up its __class__, as methods belonging
1672 to the metaclass would probably be more confusing than helpful. */
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001673 else if (PyType_Check(arg)) {
Tim Peters7eea37e2001-09-04 22:08:56 +00001674 masterdict = PyDict_New();
1675 if (masterdict == NULL)
1676 goto error;
1677 if (merge_class_dict(masterdict, arg) < 0)
1678 goto error;
1679 }
1680
1681 /* Else look at its dict, and the attrs reachable from its class. */
1682 else {
1683 PyObject *itsclass;
1684 /* Create a dict to start with. CAUTION: Not everything
1685 responding to __dict__ returns a dict! */
1686 masterdict = PyObject_GetAttrString(arg, "__dict__");
1687 if (masterdict == NULL) {
1688 PyErr_Clear();
1689 masterdict = PyDict_New();
1690 }
1691 else if (!PyDict_Check(masterdict)) {
1692 Py_DECREF(masterdict);
1693 masterdict = PyDict_New();
1694 }
1695 else {
1696 /* The object may have returned a reference to its
1697 dict, so copy it to avoid mutating it. */
1698 PyObject *temp = PyDict_Copy(masterdict);
1699 Py_DECREF(masterdict);
1700 masterdict = temp;
1701 }
1702 if (masterdict == NULL)
1703 goto error;
1704
Tim Peters305b5852001-09-17 02:38:46 +00001705 /* Merge in __members__ and __methods__ (if any).
1706 XXX Would like this to go away someday; for now, it's
1707 XXX needed to get at im_self etc of method objects. */
1708 if (merge_list_attr(masterdict, arg, "__members__") < 0)
1709 goto error;
1710 if (merge_list_attr(masterdict, arg, "__methods__") < 0)
1711 goto error;
1712
Tim Peters7eea37e2001-09-04 22:08:56 +00001713 /* Merge in attrs reachable from its class.
1714 CAUTION: Not all objects have a __class__ attr. */
1715 itsclass = PyObject_GetAttrString(arg, "__class__");
1716 if (itsclass == NULL)
1717 PyErr_Clear();
1718 else {
1719 int status = merge_class_dict(masterdict, itsclass);
1720 Py_DECREF(itsclass);
1721 if (status < 0)
1722 goto error;
1723 }
1724 }
1725
1726 assert((result == NULL) ^ (masterdict == NULL));
1727 if (masterdict != NULL) {
1728 /* The result comes from its keys. */
1729 assert(result == NULL);
1730 result = PyDict_Keys(masterdict);
1731 if (result == NULL)
1732 goto error;
1733 }
1734
1735 assert(result);
Raymond Hettinger2a7dede2004-08-07 04:55:30 +00001736 if (!PyList_Check(result)) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001737 PyErr_Format(PyExc_TypeError,
1738 "Expected keys() to be a list, not '%.200s'",
1739 result->ob_type->tp_name);
Raymond Hettinger2a7dede2004-08-07 04:55:30 +00001740 goto error;
1741 }
Tim Peters7eea37e2001-09-04 22:08:56 +00001742 if (PyList_Sort(result) != 0)
1743 goto error;
1744 else
1745 goto normal_return;
1746
1747 error:
1748 Py_XDECREF(result);
1749 result = NULL;
1750 /* fall through */
1751 normal_return:
1752 Py_XDECREF(masterdict);
1753 return result;
1754}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001755
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001756/*
1757NoObject is usable as a non-NULL undefined value, used by the macro None.
1758There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001759so there is exactly one (which is indestructible, by the way).
Guido van Rossumba21a492001-08-16 08:17:26 +00001760(XXX This type and the type of NotImplemented below should be unified.)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001761*/
1762
Guido van Rossum0c182a11992-03-27 17:26:13 +00001763/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001764static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001765none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001766{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001767 return PyString_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001768}
1769
Barry Warsaw9bf16442001-01-23 16:24:35 +00001770/* ARGUSED */
1771static void
Tim Peters803526b2002-07-07 05:13:56 +00001772none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001773{
1774 /* This should never get called, but we also don't want to SEGV if
1775 * we accidently decref None out of existance.
1776 */
Martin v. Löwis3f19b102002-08-07 16:21:51 +00001777 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001778}
1779
1780
Guido van Rossumba21a492001-08-16 08:17:26 +00001781static PyTypeObject PyNone_Type = {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001782 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001783 0,
Guido van Rossumba21a492001-08-16 08:17:26 +00001784 "NoneType",
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001785 0,
1786 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001787 none_dealloc, /*tp_dealloc*/ /*never called*/
Guido van Rossum7066dd71992-09-17 17:54:56 +00001788 0, /*tp_print*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001789 0, /*tp_getattr*/
1790 0, /*tp_setattr*/
1791 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001792 none_repr, /*tp_repr*/
Guido van Rossum3f5da241990-12-20 15:06:42 +00001793 0, /*tp_as_number*/
1794 0, /*tp_as_sequence*/
1795 0, /*tp_as_mapping*/
Guido van Rossum9bfef441993-03-29 10:43:31 +00001796 0, /*tp_hash */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001797};
1798
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001799PyObject _Py_NoneStruct = {
Guido van Rossumba21a492001-08-16 08:17:26 +00001800 PyObject_HEAD_INIT(&PyNone_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001801};
1802
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001803/* NotImplemented is an object that can be used to signal that an
1804 operation is not implemented for the given type combination. */
1805
1806static PyObject *
1807NotImplemented_repr(PyObject *op)
1808{
1809 return PyString_FromString("NotImplemented");
1810}
1811
1812static PyTypeObject PyNotImplemented_Type = {
1813 PyObject_HEAD_INIT(&PyType_Type)
1814 0,
Guido van Rossumba21a492001-08-16 08:17:26 +00001815 "NotImplementedType",
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001816 0,
1817 0,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001818 none_dealloc, /*tp_dealloc*/ /*never called*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001819 0, /*tp_print*/
1820 0, /*tp_getattr*/
1821 0, /*tp_setattr*/
1822 0, /*tp_compare*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001823 NotImplemented_repr, /*tp_repr*/
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001824 0, /*tp_as_number*/
1825 0, /*tp_as_sequence*/
1826 0, /*tp_as_mapping*/
1827 0, /*tp_hash */
1828};
1829
1830PyObject _Py_NotImplementedStruct = {
1831 PyObject_HEAD_INIT(&PyNotImplemented_Type)
1832};
1833
Guido van Rossumba21a492001-08-16 08:17:26 +00001834void
1835_Py_ReadyTypes(void)
1836{
1837 if (PyType_Ready(&PyType_Type) < 0)
1838 Py_FatalError("Can't initialize 'type'");
1839
Fred Drake0a4dd392004-07-02 18:57:45 +00001840 if (PyType_Ready(&_PyWeakref_RefType) < 0)
1841 Py_FatalError("Can't initialize 'weakref'");
1842
Guido van Rossum77f6a652002-04-03 22:41:51 +00001843 if (PyType_Ready(&PyBool_Type) < 0)
1844 Py_FatalError("Can't initialize 'bool'");
1845
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001846 if (PyType_Ready(&PyBytes_Type) < 0)
1847 Py_FatalError("Can't initialize 'bytes'");
1848
Guido van Rossumcacfc072002-05-24 19:01:59 +00001849 if (PyType_Ready(&PyString_Type) < 0)
1850 Py_FatalError("Can't initialize 'str'");
1851
Guido van Rossumba21a492001-08-16 08:17:26 +00001852 if (PyType_Ready(&PyList_Type) < 0)
1853 Py_FatalError("Can't initialize 'list'");
1854
1855 if (PyType_Ready(&PyNone_Type) < 0)
1856 Py_FatalError("Can't initialize type(None)");
1857
Guido van Rossum50e9fb92006-08-17 05:42:55 +00001858 if (PyType_Ready(Py_Ellipsis->ob_type) < 0)
1859 Py_FatalError("Can't initialize type(Ellipsis)");
1860
Guido van Rossumba21a492001-08-16 08:17:26 +00001861 if (PyType_Ready(&PyNotImplemented_Type) < 0)
1862 Py_FatalError("Can't initialize type(NotImplemented)");
1863}
1864
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001865
Guido van Rossum84a90321996-05-22 16:34:47 +00001866#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001867
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001868void
Fred Drake100814d2000-07-09 15:48:49 +00001869_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001870{
Tim Peters34592512002-07-11 06:23:50 +00001871 _Py_INC_REFTOTAL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001872 op->ob_refcnt = 1;
Tim Peters7571a0f2003-03-23 17:52:28 +00001873 _Py_AddToAllObjects(op, 1);
Tim Peters34592512002-07-11 06:23:50 +00001874 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001875}
1876
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001877void
Fred Drake100814d2000-07-09 15:48:49 +00001878_Py_ForgetReference(register PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001879{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001880#ifdef SLOW_UNREF_CHECK
Guido van Rossum4c08d552000-03-10 22:55:18 +00001881 register PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001882#endif
Guido van Rossumd7047b31995-01-02 19:07:15 +00001883 if (op->ob_refcnt < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001884 Py_FatalError("UNREF negative refcnt");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001885 if (op == &refchain ||
Guido van Rossumd7047b31995-01-02 19:07:15 +00001886 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001887 Py_FatalError("UNREF invalid object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001888#ifdef SLOW_UNREF_CHECK
Guido van Rossum3f5da241990-12-20 15:06:42 +00001889 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1890 if (p == op)
1891 break;
1892 }
Guido van Rossumd7047b31995-01-02 19:07:15 +00001893 if (p == &refchain) /* Not found */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001894 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001895#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001896 op->_ob_next->_ob_prev = op->_ob_prev;
1897 op->_ob_prev->_ob_next = op->_ob_next;
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001898 op->_ob_next = op->_ob_prev = NULL;
Tim Peters34592512002-07-11 06:23:50 +00001899 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001900}
1901
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001902void
Fred Drake100814d2000-07-09 15:48:49 +00001903_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001904{
Guido van Rossum9776adf1994-09-07 14:36:45 +00001905 destructor dealloc = op->ob_type->tp_dealloc;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001906 _Py_ForgetReference(op);
Guido van Rossum9776adf1994-09-07 14:36:45 +00001907 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001908}
1909
Tim Peters269b2a62003-04-17 19:52:29 +00001910/* Print all live objects. Because PyObject_Print is called, the
1911 * interpreter must be in a healthy state.
1912 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001913void
Fred Drake100814d2000-07-09 15:48:49 +00001914_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001915{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001916 PyObject *op;
Guido van Rossume09fb551997-08-05 02:04:34 +00001917 fprintf(fp, "Remaining objects:\n");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001918 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001919 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001920 if (PyObject_Print(op, fp, 0) != 0)
1921 PyErr_Clear();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001922 putc('\n', fp);
1923 }
1924}
1925
Tim Peters269b2a62003-04-17 19:52:29 +00001926/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1927 * doesn't make any calls to the Python C API, so is always safe to call.
1928 */
1929void
1930_Py_PrintReferenceAddresses(FILE *fp)
1931{
1932 PyObject *op;
1933 fprintf(fp, "Remaining object addresses:\n");
1934 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001935 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
1936 op->ob_refcnt, op->ob_type->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001937}
1938
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001939PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001940_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001941{
1942 int i, n;
1943 PyObject *t = NULL;
1944 PyObject *res, *op;
1945
1946 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1947 return NULL;
1948 op = refchain._ob_next;
1949 res = PyList_New(0);
1950 if (res == NULL)
1951 return NULL;
1952 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1953 while (op == self || op == args || op == res || op == t ||
Guido van Rossum3c296022001-07-14 17:58:00 +00001954 (t != NULL && op->ob_type != (PyTypeObject *) t)) {
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001955 op = op->_ob_next;
1956 if (op == &refchain)
1957 return res;
1958 }
1959 if (PyList_Append(res, op) < 0) {
1960 Py_DECREF(res);
1961 return NULL;
1962 }
1963 op = op->_ob_next;
1964 }
1965 return res;
1966}
1967
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001968#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001969
1970
1971/* Hack to force loading of cobject.o */
Guido van Rossumda9c2711996-12-05 21:58:58 +00001972PyTypeObject *_Py_cobject_hack = &PyCObject_Type;
Guido van Rossum84a90321996-05-22 16:34:47 +00001973
1974
1975/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001976Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001977
1978
Andrew M. Kuchling1582a3a2000-08-16 12:27:23 +00001979/* Python's malloc wrappers (see pymem.h) */
Guido van Rossume09fb551997-08-05 02:04:34 +00001980
Thomas Wouters334fb892000-07-25 12:56:38 +00001981void *
Fred Drake100814d2000-07-09 15:48:49 +00001982PyMem_Malloc(size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001983{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001984 return PyMem_MALLOC(nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001985}
1986
Thomas Wouters334fb892000-07-25 12:56:38 +00001987void *
1988PyMem_Realloc(void *p, size_t nbytes)
Guido van Rossume09fb551997-08-05 02:04:34 +00001989{
Tim Petersaf3e8de2002-04-12 07:22:56 +00001990 return PyMem_REALLOC(p, nbytes);
Guido van Rossume09fb551997-08-05 02:04:34 +00001991}
1992
1993void
Thomas Wouters334fb892000-07-25 12:56:38 +00001994PyMem_Free(void *p)
Guido van Rossume09fb551997-08-05 02:04:34 +00001995{
Guido van Rossumb18618d2000-05-03 23:44:39 +00001996 PyMem_FREE(p);
1997}
1998
1999
Guido van Rossum86610361998-04-10 22:32:46 +00002000/* These methods are used to control infinite recursion in repr, str, print,
2001 etc. Container objects that may recursively contain themselves,
2002 e.g. builtin dictionaries and lists, should used Py_ReprEnter() and
2003 Py_ReprLeave() to avoid infinite recursion.
2004
2005 Py_ReprEnter() returns 0 the first time it is called for a particular
2006 object and 1 every time thereafter. It returns -1 if an exception
2007 occurred. Py_ReprLeave() has no return value.
2008
2009 See dictobject.c and listobject.c for examples of use.
2010*/
2011
2012#define KEY "Py_Repr"
2013
2014int
Fred Drake100814d2000-07-09 15:48:49 +00002015Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00002016{
2017 PyObject *dict;
2018 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002019 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00002020
2021 dict = PyThreadState_GetDict();
2022 if (dict == NULL)
Guido van Rossum0fc8f002003-04-15 15:12:39 +00002023 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00002024 list = PyDict_GetItemString(dict, KEY);
2025 if (list == NULL) {
2026 list = PyList_New(0);
2027 if (list == NULL)
2028 return -1;
2029 if (PyDict_SetItemString(dict, KEY, list) < 0)
2030 return -1;
2031 Py_DECREF(list);
2032 }
2033 i = PyList_GET_SIZE(list);
2034 while (--i >= 0) {
2035 if (PyList_GET_ITEM(list, i) == obj)
2036 return 1;
2037 }
2038 PyList_Append(list, obj);
2039 return 0;
2040}
2041
2042void
Fred Drake100814d2000-07-09 15:48:49 +00002043Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00002044{
2045 PyObject *dict;
2046 PyObject *list;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002047 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00002048
2049 dict = PyThreadState_GetDict();
Guido van Rossumeb909461998-04-11 15:17:34 +00002050 if (dict == NULL)
2051 return;
Guido van Rossum86610361998-04-10 22:32:46 +00002052 list = PyDict_GetItemString(dict, KEY);
Guido van Rossumeb909461998-04-11 15:17:34 +00002053 if (list == NULL || !PyList_Check(list))
2054 return;
Guido van Rossum86610361998-04-10 22:32:46 +00002055 i = PyList_GET_SIZE(list);
2056 /* Count backwards because we always expect obj to be list[-1] */
2057 while (--i >= 0) {
2058 if (PyList_GET_ITEM(list, i) == obj) {
2059 PyList_SetSlice(list, i, i + 1, NULL);
2060 break;
2061 }
2062 }
2063}
Guido van Rossumd724b232000-03-13 16:01:29 +00002064
Tim Peters803526b2002-07-07 05:13:56 +00002065/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00002066
Tim Peters803526b2002-07-07 05:13:56 +00002067/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00002068int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00002069
Tim Peters803526b2002-07-07 05:13:56 +00002070/* List of objects that still need to be cleaned up, singly linked via their
2071 * gc headers' gc_prev pointers.
2072 */
2073PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00002074
Tim Peters803526b2002-07-07 05:13:56 +00002075/* Add op to the _PyTrash_delete_later list. Called when the current
2076 * call-stack depth gets large. op must be a currently untracked gc'ed
2077 * object, with refcount 0. Py_DECREF must already have been called on it.
2078 */
Guido van Rossumd724b232000-03-13 16:01:29 +00002079void
Fred Drake100814d2000-07-09 15:48:49 +00002080_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00002081{
Tim Peters803526b2002-07-07 05:13:56 +00002082 assert(PyObject_IS_GC(op));
2083 assert(_Py_AS_GC(op)->gc.gc_refs == _PyGC_REFS_UNTRACKED);
2084 assert(op->ob_refcnt == 0);
Neil Schemenauerf589c052002-03-29 03:05:54 +00002085 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
Guido van Rossume92e6102000-04-24 15:40:53 +00002086 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00002087}
2088
Tim Peters803526b2002-07-07 05:13:56 +00002089/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
2090 * the call-stack unwinds again.
2091 */
Guido van Rossumd724b232000-03-13 16:01:29 +00002092void
Fred Drake100814d2000-07-09 15:48:49 +00002093_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00002094{
2095 while (_PyTrash_delete_later) {
Tim Peters803526b2002-07-07 05:13:56 +00002096 PyObject *op = _PyTrash_delete_later;
2097 destructor dealloc = op->ob_type->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00002098
Neil Schemenauerf589c052002-03-29 03:05:54 +00002099 _PyTrash_delete_later =
Tim Peters803526b2002-07-07 05:13:56 +00002100 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00002101
Tim Peters803526b2002-07-07 05:13:56 +00002102 /* Call the deallocator directly. This used to try to
2103 * fool Py_DECREF into calling it indirectly, but
2104 * Py_DECREF was already called on this object, and in
2105 * assorted non-release builds calling Py_DECREF again ends
2106 * up distorting allocation statistics.
2107 */
2108 assert(op->ob_refcnt == 0);
Guido van Rossumd724b232000-03-13 16:01:29 +00002109 ++_PyTrash_delete_nesting;
Tim Peters803526b2002-07-07 05:13:56 +00002110 (*dealloc)(op);
Guido van Rossumd724b232000-03-13 16:01:29 +00002111 --_PyTrash_delete_nesting;
2112 }
2113}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002114
2115#ifdef __cplusplus
2116}
2117#endif
2118