cpython-lru_cache-weakref: Include/object.h annotate

annotate Include/object.h @ 64166:d0e9febfa00a 3.1

Merged revisions 84172 via svnmerge from svn+ssh://pythondev@svn.python.org/python/branches/py3k ........ r84172 | martin.v.loewis | 2010-08-18 18:12:23 +0200 (Mi, 18 Aug 2010) | 2 lines Restore GIL in nis_cat in case of error. ........

author	Martin v. Löwis <martin@v.loewis.de>
date	Thu, 19 Aug 2010 09:03:03 +0000
parents	f197407bdba2
children	0265d5f7bd07

rev	line source
1329 519c25039c6a * Added support for X11 modules. Guido van Rossum <guido@python.org> parents: 1324 diff changeset	1 #ifndef Py_OBJECT_H
519c25039c6a * Added support for X11 modules. Guido van Rossum <guido@python.org> parents: 1324 diff changeset	2 #define Py_OBJECT_H
519c25039c6a * Added support for X11 modules. Guido van Rossum <guido@python.org> parents: 1324 diff changeset	3 #ifdef __cplusplus
519c25039c6a * Added support for X11 modules. Guido van Rossum <guido@python.org> parents: 1324 diff changeset	4 extern "C" {
519c25039c6a * Added support for X11 modules. Guido van Rossum <guido@python.org> parents: 1324 diff changeset	5 #endif
519c25039c6a * Added support for X11 modules. Guido van Rossum <guido@python.org> parents: 1324 diff changeset	6
145 853b736a6a9e Added copyright notice. Guido van Rossum <guido@python.org> parents: 86 diff changeset	7
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	8 /* Object and type object interface */
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	9
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	10 /*
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	11 Objects are structures allocated on the heap. Special rules apply to
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	12 the use of objects to ensure they are properly garbage-collected.
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	13 Objects are never allocated statically or on the stack; they must be
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	14 accessed through special macros and functions only. (Type objects are
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	15 exceptions to the first rule; the standard types are represented by
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	16 statically initialized type objects, although work on type/class unification
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	17 for Python 2.2 made it possible to have heap-allocated type objects too).
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	18
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	19 An object has a 'reference count' that is increased or decreased when a
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	20 pointer to the object is copied or deleted; when the reference count
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	21 reaches zero there are no references to the object left and it can be
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	22 removed from the heap.
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	23
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	24 An object has a 'type' that determines what it represents and what kind
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	25 of data it contains. An object's type is fixed when it is created.
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	26 Types themselves are represented as objects; an object contains a
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	27 pointer to the corresponding type object. The type itself has a type
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	28 pointer pointing to the object representing the type 'type', which
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	29 contains a pointer to itself!).
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	30
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	31 Objects do not float around in memory; once allocated an object keeps
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	32 the same size and address. Objects that must hold variable-size data
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	33 can contain pointers to variable-size parts of the object. Not all
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	34 objects of the same type have the same size; but the size cannot change
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	35 after allocation. (These restrictions are made so a reference to an
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	36 object can be simply a pointer -- moving an object would require
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	37 updating all the pointers, and changing an object's size would require
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	38 moving it if there was another object right next to it.)
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	39
2129 05360cd616ae The great renaming, phase two: all header files have been updated to Guido van Rossum <guido@python.org> parents: 2071 diff changeset	40 Objects are always accessed through pointers of the type 'PyObject *'.
05360cd616ae The great renaming, phase two: all header files have been updated to Guido van Rossum <guido@python.org> parents: 2071 diff changeset	41 The type 'PyObject' is a structure that only contains the reference count
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	42 and the type pointer. The actual memory allocated for an object
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	43 contains other data that can only be accessed after casting the pointer
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	44 to a pointer to a longer structure type. This longer type must start
2129 05360cd616ae The great renaming, phase two: all header files have been updated to Guido van Rossum <guido@python.org> parents: 2071 diff changeset	45 with the reference count and type fields; the macro PyObject_HEAD should be
13620 5b727ab37092 Spelling fixes supplied by Rob W. W. Hooft. All these are fixes in either Thomas Wouters <thomas@python.org> parents: 13464 diff changeset	46 used for this (to accommodate for future changes). The implementation
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	47 of a particular object type can cast the object pointer to the proper
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	48 type and back.
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	49
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	50 A standard interface exists for objects that contain an array of items
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	51 whose size is determined when the object is allocated.
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	52 */
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	53
24184 c4dcb80f48ea object.h special-build macro minefield: renamed all the new lexical Tim Peters <tim.peters@gmail.com> parents: 24171 diff changeset	54 /* Py_DEBUG implies Py_TRACE_REFS. */
c4dcb80f48ea object.h special-build macro minefield: renamed all the new lexical Tim Peters <tim.peters@gmail.com> parents: 24171 diff changeset	55 #if defined(Py_DEBUG) && !defined(Py_TRACE_REFS)
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	56 #define Py_TRACE_REFS
24184 c4dcb80f48ea object.h special-build macro minefield: renamed all the new lexical Tim Peters <tim.peters@gmail.com> parents: 24171 diff changeset	57 #endif
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	58
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	59 /* Py_TRACE_REFS implies Py_REF_DEBUG. */
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	60 #if defined(Py_TRACE_REFS) && !defined(Py_REF_DEBUG)
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	61 #define Py_REF_DEBUG
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	62 #endif
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	63
2129 05360cd616ae The great renaming, phase two: all header files have been updated to Guido van Rossum <guido@python.org> parents: 2071 diff changeset	64 #ifdef Py_TRACE_REFS
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	65 /* Define pointers to support a doubly-linked list of all live heap objects. */
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	66 #define _PyObject_HEAD_EXTRA \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	67 struct _object *_ob_next; \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	68 struct _object *_ob_prev;
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	69
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	70 #define _PyObject_EXTRA_INIT 0, 0,
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	71
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	72 #else
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	73 #define _PyObject_HEAD_EXTRA
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	74 #define _PyObject_EXTRA_INIT
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	75 #endif
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	76
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	77 /* PyObject_HEAD defines the initial segment of every PyObject. */
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	78 #define PyObject_HEAD PyObject ob_base;
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	79
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	80 #define PyObject_HEAD_INIT(type) \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	81 { _PyObject_EXTRA_INIT \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	82 1, type },
42334 e70cdce0e8b2 Merged revisions 56467-56482 via svnmerge from Martin v. Löwis <martin@v.loewis.de> parents: 42084 diff changeset	83
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	84 #define PyVarObject_HEAD_INIT(type, size) \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	85 { PyObject_HEAD_INIT(type) size },
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	86
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	87 /* PyObject_VAR_HEAD defines the initial segment of all variable-size
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	88 * container objects. These end with a declaration of an array with 1
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	89 * element, but enough space is malloc'ed so that the array actually
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	90 * has room for ob_size elements. Note that ob_size is an element count,
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	91 * not necessarily a byte count.
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	92 */
42334 e70cdce0e8b2 Merged revisions 56467-56482 via svnmerge from Martin v. Löwis <martin@v.loewis.de> parents: 42084 diff changeset	93 #define PyObject_VAR_HEAD PyVarObject ob_base;
36501 7fdc639bc5b4 Merge ssize_t branch. Martin v. Löwis <martin@v.loewis.de> parents: 35999 diff changeset	94 #define Py_INVALID_SIZE (Py_ssize_t)-1
24122 d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	95
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	96 /* Nothing is actually declared to be a PyObject, but every pointer to
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	97 * a Python object can be cast to a PyObject*. This is inheritance built
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	98 * by hand. Similarly every pointer to a variable-size Python object can,
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	99 * in addition, be cast to PyVarObject*.
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	100 */
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	101 typedef struct _object {
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	102 _PyObject_HEAD_EXTRA
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	103 Py_ssize_t ob_refcnt;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	104 struct _typeobject *ob_type;
2129 05360cd616ae The great renaming, phase two: all header files have been updated to Guido van Rossum <guido@python.org> parents: 2071 diff changeset	105 } PyObject;
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	106
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	107 typedef struct {
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	108 PyObject ob_base;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	109 Py_ssize_t ob_size; /* Number of items in variable part */
5535 20c2b715188e Oops, another forgotten renaming: varobject -> PyVarObject. Guido van Rossum <guido@python.org> parents: 5410 diff changeset	110 } PyVarObject;
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	111
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	112 #define Py_REFCNT(ob) (((PyObject*)(ob))->ob_refcnt)
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	113 #define Py_TYPE(ob) (((PyObject*)(ob))->ob_type)
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	114 #define Py_SIZE(ob) (((PyVarObject*)(ob))->ob_size)
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	115
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	116 /*
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	117 Type objects contain a string containing the type name (to help somewhat
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	118 in debugging), the allocation parameters (see PyObject_New() and
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	119 PyObject_NewVar()),
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	120 and methods for accessing objects of the type. Methods are optional, a
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	121 nil pointer meaning that particular kind of access is not available for
2129 05360cd616ae The great renaming, phase two: all header files have been updated to Guido van Rossum <guido@python.org> parents: 2071 diff changeset	122 this type. The Py_DECREF() macro uses the tp_dealloc method without
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	123 checking for a nil pointer; it should always be implemented except if
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	124 the implementation can guarantee that the reference count will never
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	125 reach zero (e.g., for statically allocated type objects).
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	126
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	127 NB: the methods for certain type groups are now contained in separate
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	128 method blocks.
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	129 */
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	130
13418 85520c220067 Got RID of redundant coercions in longobject.c (as spotted by Greg Tim Peters <tim.peters@gmail.com> parents: 13256 diff changeset	131 typedef PyObject * (unaryfunc)(PyObject );
85520c220067 Got RID of redundant coercions in longobject.c (as spotted by Greg Tim Peters <tim.peters@gmail.com> parents: 13256 diff changeset	132 typedef PyObject * (binaryfunc)(PyObject , PyObject *);
85520c220067 Got RID of redundant coercions in longobject.c (as spotted by Greg Tim Peters <tim.peters@gmail.com> parents: 13256 diff changeset	133 typedef PyObject * (ternaryfunc)(PyObject , PyObject , PyObject );
85520c220067 Got RID of redundant coercions in longobject.c (as spotted by Greg Tim Peters <tim.peters@gmail.com> parents: 13256 diff changeset	134 typedef int (inquiry)(PyObject );
36501 7fdc639bc5b4 Merge ssize_t branch. Martin v. Löwis <martin@v.loewis.de> parents: 35999 diff changeset	135 typedef Py_ssize_t (lenfunc)(PyObject );
7fdc639bc5b4 Merge ssize_t branch. Martin v. Löwis <martin@v.loewis.de> parents: 35999 diff changeset	136 typedef PyObject (ssizeargfunc)(PyObject *, Py_ssize_t);
7fdc639bc5b4 Merge ssize_t branch. Martin v. Löwis <martin@v.loewis.de> parents: 35999 diff changeset	137 typedef PyObject (ssizessizeargfunc)(PyObject *, Py_ssize_t, Py_ssize_t);
7fdc639bc5b4 Merge ssize_t branch. Martin v. Löwis <martin@v.loewis.de> parents: 35999 diff changeset	138 typedef int(ssizeobjargproc)(PyObject , Py_ssize_t, PyObject *);
7fdc639bc5b4 Merge ssize_t branch. Martin v. Löwis <martin@v.loewis.de> parents: 35999 diff changeset	139 typedef int(ssizessizeobjargproc)(PyObject , Py_ssize_t, Py_ssize_t, PyObject *);
13418 85520c220067 Got RID of redundant coercions in longobject.c (as spotted by Greg Tim Peters <tim.peters@gmail.com> parents: 13256 diff changeset	140 typedef int(objobjargproc)(PyObject , PyObject , PyObject );
36501 7fdc639bc5b4 Merge ssize_t branch. Martin v. Löwis <martin@v.loewis.de> parents: 35999 diff changeset	141
42665 85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: 42334 diff changeset	142
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: 42334 diff changeset	143 /* buffer interface */
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: 42334 diff changeset	144 typedef struct bufferinfo {
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	145 void *buf;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	146 PyObject obj; / owned reference */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	147 Py_ssize_t len;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	148 Py_ssize_t itemsize; /* This is Py_ssize_t so it can be
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	149 pointed to by strides in simple case.*/
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	150 int readonly;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	151 int ndim;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	152 char *format;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	153 Py_ssize_t *shape;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	154 Py_ssize_t *strides;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	155 Py_ssize_t *suboffsets;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	156 Py_ssize_t smalltable[2]; /* static store for shape and strides of
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	157 mono-dimensional buffers. */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	158 void *internal;
43423 0476a2cc5658 Change PyBuffer to Py_buffer to be consistent with other non-object structures like Py_complex. Add some more functionality to the memoryview object. Travis E. Oliphant <oliphant@enthought.com> parents: 43420 diff changeset	159 } Py_buffer;
42665 85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: 42334 diff changeset	160
43423 0476a2cc5658 Change PyBuffer to Py_buffer to be consistent with other non-object structures like Py_complex. Add some more functionality to the memoryview object. Travis E. Oliphant <oliphant@enthought.com> parents: 43420 diff changeset	161 typedef int (getbufferproc)(PyObject , Py_buffer *, int);
0476a2cc5658 Change PyBuffer to Py_buffer to be consistent with other non-object structures like Py_complex. Add some more functionality to the memoryview object. Travis E. Oliphant <oliphant@enthought.com> parents: 43420 diff changeset	162 typedef void (releasebufferproc)(PyObject , Py_buffer *);
42665 85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: 42334 diff changeset	163
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	164 /* Flags for getting buffers */
42665 85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: 42334 diff changeset	165 #define PyBUF_SIMPLE 0
43555 8e72dacf7f3a Eliminate use of PyBUF_CHARACTER flag which is no longer part of the buffer interface. Fix up array module to export the correct format for wide-builds. Travis E. Oliphant <oliphant@enthought.com> parents: 43550 diff changeset	166 #define PyBUF_WRITABLE 0x0001
43384 4e57c36f6d2e Fixing the spelling of "writeable" to "writable", particularly PyBUF_WRITEABLE. Sean Reifscheider <jafo@tummy.com> parents: 43100 diff changeset	167 /* we used to include an E, backwards compatible alias */
4e57c36f6d2e Fixing the spelling of "writeable" to "writable", particularly PyBUF_WRITEABLE. Sean Reifscheider <jafo@tummy.com> parents: 43100 diff changeset	168 #define PyBUF_WRITEABLE PyBUF_WRITABLE
43555 8e72dacf7f3a Eliminate use of PyBUF_CHARACTER flag which is no longer part of the buffer interface. Fix up array module to export the correct format for wide-builds. Travis E. Oliphant <oliphant@enthought.com> parents: 43550 diff changeset	169 #define PyBUF_FORMAT 0x0004
8e72dacf7f3a Eliminate use of PyBUF_CHARACTER flag which is no longer part of the buffer interface. Fix up array module to export the correct format for wide-builds. Travis E. Oliphant <oliphant@enthought.com> parents: 43550 diff changeset	170 #define PyBUF_ND 0x0008
8e72dacf7f3a Eliminate use of PyBUF_CHARACTER flag which is no longer part of the buffer interface. Fix up array module to export the correct format for wide-builds. Travis E. Oliphant <oliphant@enthought.com> parents: 43550 diff changeset	171 #define PyBUF_STRIDES (0x0010 \| PyBUF_ND)
8e72dacf7f3a Eliminate use of PyBUF_CHARACTER flag which is no longer part of the buffer interface. Fix up array module to export the correct format for wide-builds. Travis E. Oliphant <oliphant@enthought.com> parents: 43550 diff changeset	172 #define PyBUF_C_CONTIGUOUS (0x0020 \| PyBUF_STRIDES)
8e72dacf7f3a Eliminate use of PyBUF_CHARACTER flag which is no longer part of the buffer interface. Fix up array module to export the correct format for wide-builds. Travis E. Oliphant <oliphant@enthought.com> parents: 43550 diff changeset	173 #define PyBUF_F_CONTIGUOUS (0x0040 \| PyBUF_STRIDES)
8e72dacf7f3a Eliminate use of PyBUF_CHARACTER flag which is no longer part of the buffer interface. Fix up array module to export the correct format for wide-builds. Travis E. Oliphant <oliphant@enthought.com> parents: 43550 diff changeset	174 #define PyBUF_ANY_CONTIGUOUS (0x0080 \| PyBUF_STRIDES)
8e72dacf7f3a Eliminate use of PyBUF_CHARACTER flag which is no longer part of the buffer interface. Fix up array module to export the correct format for wide-builds. Travis E. Oliphant <oliphant@enthought.com> parents: 43550 diff changeset	175 #define PyBUF_INDIRECT (0x0100 \| PyBUF_STRIDES)
42665 85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: 42334 diff changeset	176
43384 4e57c36f6d2e Fixing the spelling of "writeable" to "writable", particularly PyBUF_WRITEABLE. Sean Reifscheider <jafo@tummy.com> parents: 43100 diff changeset	177 #define PyBUF_CONTIG (PyBUF_ND \| PyBUF_WRITABLE)
42665 85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: 42334 diff changeset	178 #define PyBUF_CONTIG_RO (PyBUF_ND)
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: 42334 diff changeset	179
43384 4e57c36f6d2e Fixing the spelling of "writeable" to "writable", particularly PyBUF_WRITEABLE. Sean Reifscheider <jafo@tummy.com> parents: 43100 diff changeset	180 #define PyBUF_STRIDED (PyBUF_STRIDES \| PyBUF_WRITABLE)
42665 85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: 42334 diff changeset	181 #define PyBUF_STRIDED_RO (PyBUF_STRIDES)
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: 42334 diff changeset	182
43384 4e57c36f6d2e Fixing the spelling of "writeable" to "writable", particularly PyBUF_WRITEABLE. Sean Reifscheider <jafo@tummy.com> parents: 43100 diff changeset	183 #define PyBUF_RECORDS (PyBUF_STRIDES \| PyBUF_WRITABLE \| PyBUF_FORMAT)
42665 85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: 42334 diff changeset	184 #define PyBUF_RECORDS_RO (PyBUF_STRIDES \| PyBUF_FORMAT)
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: 42334 diff changeset	185
43384 4e57c36f6d2e Fixing the spelling of "writeable" to "writable", particularly PyBUF_WRITEABLE. Sean Reifscheider <jafo@tummy.com> parents: 43100 diff changeset	186 #define PyBUF_FULL (PyBUF_INDIRECT \| PyBUF_WRITABLE \| PyBUF_FORMAT)
42665 85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: 42334 diff changeset	187 #define PyBUF_FULL_RO (PyBUF_INDIRECT \| PyBUF_FORMAT)
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: 42334 diff changeset	188
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: 42334 diff changeset	189
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: 42334 diff changeset	190 #define PyBUF_READ 0x100
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: 42334 diff changeset	191 #define PyBUF_WRITE 0x200
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: 42334 diff changeset	192 #define PyBUF_SHADOW 0x400
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: 42334 diff changeset	193
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: 42334 diff changeset	194 /* End buffer interface */
36501 7fdc639bc5b4 Merge ssize_t branch. Martin v. Löwis <martin@v.loewis.de> parents: 35999 diff changeset	195
13418 85520c220067 Got RID of redundant coercions in longobject.c (as spotted by Greg Tim Peters <tim.peters@gmail.com> parents: 13256 diff changeset	196 typedef int (objobjproc)(PyObject , PyObject *);
85520c220067 Got RID of redundant coercions in longobject.c (as spotted by Greg Tim Peters <tim.peters@gmail.com> parents: 13256 diff changeset	197 typedef int (visitproc)(PyObject , void *);
85520c220067 Got RID of redundant coercions in longobject.c (as spotted by Greg Tim Peters <tim.peters@gmail.com> parents: 13256 diff changeset	198 typedef int (traverseproc)(PyObject , visitproc, void *);
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1400 diff changeset	199
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	200 typedef struct {
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	201 /* Number implementations must check both
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	202 arguments for proper type and implement the necessary conversions
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	203 in the slot functions themselves. */
15716 362e53f43dd2 - Add nb_cmp slot for new style nubmers. Neil Schemenauer <nascheme@enme.ucalgary.ca> parents: 14497 diff changeset	204
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	205 binaryfunc nb_add;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	206 binaryfunc nb_subtract;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	207 binaryfunc nb_multiply;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	208 binaryfunc nb_remainder;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	209 binaryfunc nb_divmod;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	210 ternaryfunc nb_power;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	211 unaryfunc nb_negative;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	212 unaryfunc nb_positive;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	213 unaryfunc nb_absolute;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	214 inquiry nb_bool;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	215 unaryfunc nb_invert;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	216 binaryfunc nb_lshift;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	217 binaryfunc nb_rshift;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	218 binaryfunc nb_and;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	219 binaryfunc nb_xor;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	220 binaryfunc nb_or;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	221 unaryfunc nb_int;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	222 void nb_reserved; / the slot formerly known as nb_long */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	223 unaryfunc nb_float;
39536 8f5b9982beba Completely get rid of PyClass and PyInstance. Guido van Rossum <guido@python.org> parents: 39222 diff changeset	224
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	225 binaryfunc nb_inplace_add;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	226 binaryfunc nb_inplace_subtract;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	227 binaryfunc nb_inplace_multiply;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	228 binaryfunc nb_inplace_remainder;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	229 ternaryfunc nb_inplace_power;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	230 binaryfunc nb_inplace_lshift;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	231 binaryfunc nb_inplace_rshift;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	232 binaryfunc nb_inplace_and;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	233 binaryfunc nb_inplace_xor;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	234 binaryfunc nb_inplace_or;
19051 f20727cc3d0f Implement PEP 238 in its (almost) full glory. Guido van Rossum <guido@python.org> parents: 19040 diff changeset	235
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	236 binaryfunc nb_floor_divide;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	237 binaryfunc nb_true_divide;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	238 binaryfunc nb_inplace_floor_divide;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	239 binaryfunc nb_inplace_true_divide;
36882 6a9c7165b17b Checking in the code for PEP 357. Guido van Rossum <guido@python.org> parents: 36837 diff changeset	240
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	241 unaryfunc nb_index;
2129 05360cd616ae The great renaming, phase two: all header files have been updated to Guido van Rossum <guido@python.org> parents: 2071 diff changeset	242 } PyNumberMethods;
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	243
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	244 typedef struct {
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	245 lenfunc sq_length;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	246 binaryfunc sq_concat;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	247 ssizeargfunc sq_repeat;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	248 ssizeargfunc sq_item;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	249 void *was_sq_slice;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	250 ssizeobjargproc sq_ass_item;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	251 void *was_sq_ass_slice;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	252 objobjproc sq_contains;
39536 8f5b9982beba Completely get rid of PyClass and PyInstance. Guido van Rossum <guido@python.org> parents: 39222 diff changeset	253
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	254 binaryfunc sq_inplace_concat;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	255 ssizeargfunc sq_inplace_repeat;
2129 05360cd616ae The great renaming, phase two: all header files have been updated to Guido van Rossum <guido@python.org> parents: 2071 diff changeset	256 } PySequenceMethods;
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	257
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	258 typedef struct {
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	259 lenfunc mp_length;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	260 binaryfunc mp_subscript;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	261 objobjargproc mp_ass_subscript;
2129 05360cd616ae The great renaming, phase two: all header files have been updated to Guido van Rossum <guido@python.org> parents: 2071 diff changeset	262 } PyMappingMethods;
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	263
42665 85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: 42334 diff changeset	264
5410 3b2fda31bf1b Checkin of Jack's buffer mods. Guido van Rossum <guido@python.org> parents: 4839 diff changeset	265 typedef struct {
42665 85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: 42334 diff changeset	266 getbufferproc bf_getbuffer;
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118. Travis E. Oliphant <oliphant@enthought.com> parents: 42334 diff changeset	267 releasebufferproc bf_releasebuffer;
5410 3b2fda31bf1b Checkin of Jack's buffer mods. Guido van Rossum <guido@python.org> parents: 4839 diff changeset	268 } PyBufferProcs;
24122 d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	269
22969 3100ba26913c Change the type of the tp_free from 'destructor' to 'freefunc'. Neil Schemenauer <nascheme@enme.ucalgary.ca> parents: 22785 diff changeset	270 typedef void (freefunc)(void );
13418 85520c220067 Got RID of redundant coercions in longobject.c (as spotted by Greg Tim Peters <tim.peters@gmail.com> parents: 13256 diff changeset	271 typedef void (destructor)(PyObject );
85520c220067 Got RID of redundant coercions in longobject.c (as spotted by Greg Tim Peters <tim.peters@gmail.com> parents: 13256 diff changeset	272 typedef int (printfunc)(PyObject , FILE *, int);
36675 dba6494735d0 Revert backwards-incompatible const changes. Martin v. Löwis <martin@v.loewis.de> parents: 36631 diff changeset	273 typedef PyObject (getattrfunc)(PyObject , char );
13418 85520c220067 Got RID of redundant coercions in longobject.c (as spotted by Greg Tim Peters <tim.peters@gmail.com> parents: 13256 diff changeset	274 typedef PyObject (getattrofunc)(PyObject , PyObject );
36675 dba6494735d0 Revert backwards-incompatible const changes. Martin v. Löwis <martin@v.loewis.de> parents: 36631 diff changeset	275 typedef int (setattrfunc)(PyObject , char , PyObject );
13418 85520c220067 Got RID of redundant coercions in longobject.c (as spotted by Greg Tim Peters <tim.peters@gmail.com> parents: 13256 diff changeset	276 typedef int (setattrofunc)(PyObject , PyObject , PyObject );
85520c220067 Got RID of redundant coercions in longobject.c (as spotted by Greg Tim Peters <tim.peters@gmail.com> parents: 13256 diff changeset	277 typedef PyObject (reprfunc)(PyObject *);
85520c220067 Got RID of redundant coercions in longobject.c (as spotted by Greg Tim Peters <tim.peters@gmail.com> parents: 13256 diff changeset	278 typedef long (hashfunc)(PyObject );
15938 8fd221aed357 Introduction to rich comparisons: Guido van Rossum <guido@python.org> parents: 15716 diff changeset	279 typedef PyObject (richcmpfunc) (PyObject , PyObject , int);
17597 32e7d0898eab Iterators phase 1. This comprises: Guido van Rossum <guido@python.org> parents: 16768 diff changeset	280 typedef PyObject (getiterfunc) (PyObject *);
17617 aac65f50df6f Mondo changes to the iterator stuff, without changing how Python code Guido van Rossum <guido@python.org> parents: 17597 diff changeset	281 typedef PyObject (iternextfunc) (PyObject *);
18933 09df3254b49d Merge of descr-branch back into trunk. Tim Peters <tim.peters@gmail.com> parents: 17617 diff changeset	282 typedef PyObject (descrgetfunc) (PyObject , PyObject , PyObject *);
09df3254b49d Merge of descr-branch back into trunk. Tim Peters <tim.peters@gmail.com> parents: 17617 diff changeset	283 typedef int (descrsetfunc) (PyObject , PyObject , PyObject );
09df3254b49d Merge of descr-branch back into trunk. Tim Peters <tim.peters@gmail.com> parents: 17617 diff changeset	284 typedef int (initproc)(PyObject , PyObject , PyObject );
09df3254b49d Merge of descr-branch back into trunk. Tim Peters <tim.peters@gmail.com> parents: 17617 diff changeset	285 typedef PyObject (newfunc)(struct _typeobject , PyObject , PyObject *);
36501 7fdc639bc5b4 Merge ssize_t branch. Martin v. Löwis <martin@v.loewis.de> parents: 35999 diff changeset	286 typedef PyObject (allocfunc)(struct _typeobject *, Py_ssize_t);
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1400 diff changeset	287
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	288 typedef struct _typeobject {
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	289 PyObject_VAR_HEAD
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	290 const char tp_name; / For printing, in format "<module>.<name>" */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	291 Py_ssize_t tp_basicsize, tp_itemsize; /* For allocation */
24122 d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	292
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	293 /* Methods to implement standard operations */
24122 d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	294
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	295 destructor tp_dealloc;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	296 printfunc tp_print;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	297 getattrfunc tp_getattr;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	298 setattrfunc tp_setattr;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	299 void tp_reserved; / formerly known as tp_compare */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	300 reprfunc tp_repr;
24122 d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	301
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	302 /* Method suites for standard classes */
24122 d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	303
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	304 PyNumberMethods *tp_as_number;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	305 PySequenceMethods *tp_as_sequence;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	306 PyMappingMethods *tp_as_mapping;
1257 1cabc2b6c970 * Changed all copyright messages to include 1993. Guido van Rossum <guido@python.org> parents: 1049 diff changeset	307
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	308 /* More standard operations (here for binary compatibility) */
1257 1cabc2b6c970 * Changed all copyright messages to include 1993. Guido van Rossum <guido@python.org> parents: 1049 diff changeset	309
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	310 hashfunc tp_hash;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	311 ternaryfunc tp_call;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	312 reprfunc tp_str;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	313 getattrofunc tp_getattro;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	314 setattrofunc tp_setattro;
2071 048e91a59c75 new tp_str and tp_doc members in type object Guido van Rossum <guido@python.org> parents: 2058 diff changeset	315
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	316 /* Functions to access object as input/output buffer */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	317 PyBufferProcs *tp_as_buffer;
24122 d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	318
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	319 /* Flags to define presence of optional/expanded features */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	320 long tp_flags;
2071 048e91a59c75 new tp_str and tp_doc members in type object Guido van Rossum <guido@python.org> parents: 2058 diff changeset	321
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	322 const char tp_doc; / Documentation string */
2071 048e91a59c75 new tp_str and tp_doc members in type object Guido van Rossum <guido@python.org> parents: 2058 diff changeset	323
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	324 /* Assigned meaning in release 2.0 */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	325 /* call function for all accessible objects */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	326 traverseproc tp_traverse;
24122 d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	327
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	328 /* delete references to contained objects */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	329 inquiry tp_clear;
12990 e615596c5c47 Round 1 of Neil Schemenauer's GC patches: Jeremy Hylton <jeremy@alum.mit.edu> parents: 12481 diff changeset	330
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	331 /* Assigned meaning in release 2.1 */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	332 /* rich comparisons */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	333 richcmpfunc tp_richcompare;
15938 8fd221aed357 Introduction to rich comparisons: Guido van Rossum <guido@python.org> parents: 15716 diff changeset	334
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	335 /* weak reference enabler */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	336 Py_ssize_t tp_weaklistoffset;
8124 bd744af6845f Add new spares to the end of the type object struct. Guido van Rossum <guido@python.org> parents: 7983 diff changeset	337
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	338 /* Iterators */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	339 getiterfunc tp_iter;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	340 iternextfunc tp_iternext;
17597 32e7d0898eab Iterators phase 1. This comprises: Guido van Rossum <guido@python.org> parents: 16768 diff changeset	341
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	342 /* Attribute descriptor and subclassing stuff */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	343 struct PyMethodDef *tp_methods;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	344 struct PyMemberDef *tp_members;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	345 struct PyGetSetDef *tp_getset;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	346 struct _typeobject *tp_base;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	347 PyObject *tp_dict;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	348 descrgetfunc tp_descr_get;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	349 descrsetfunc tp_descr_set;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	350 Py_ssize_t tp_dictoffset;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	351 initproc tp_init;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	352 allocfunc tp_alloc;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	353 newfunc tp_new;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	354 freefunc tp_free; /* Low-level free-memory routine */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	355 inquiry tp_is_gc; /* For PyObject_IS_GC */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	356 PyObject *tp_bases;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	357 PyObject tp_mro; / method resolution order */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	358 PyObject *tp_cache;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	359 PyObject *tp_subclasses;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	360 PyObject *tp_weaklist;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	361 destructor tp_del;
18933 09df3254b49d Merge of descr-branch back into trunk. Tim Peters <tim.peters@gmail.com> parents: 17617 diff changeset	362
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	363 /* Type attribute cache version tag. Added in version 2.6 */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	364 unsigned int tp_version_tag;
44654 5a71dcc71eff Merged revisions 59921-59932 via svnmerge from Christian Heimes <christian@cheimes.de> parents: 44351 diff changeset	365
1347 a22a350d3a5d * Extended X interface: pixmap objects, colormap objects visual objects, Sjoerd Mullender <sjoerd@acm.org> parents: 1329 diff changeset	366 #ifdef COUNT_ALLOCS
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	367 /* these must be last and never explicitly initialized */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	368 Py_ssize_t tp_allocs;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	369 Py_ssize_t tp_frees;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	370 Py_ssize_t tp_maxalloc;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	371 struct _typeobject *tp_prev;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	372 struct _typeobject *tp_next;
1347 a22a350d3a5d * Extended X interface: pixmap objects, colormap objects visual objects, Sjoerd Mullender <sjoerd@acm.org> parents: 1329 diff changeset	373 #endif
2129 05360cd616ae The great renaming, phase two: all header files have been updated to Guido van Rossum <guido@python.org> parents: 2071 diff changeset	374 } PyTypeObject;
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	375
18933 09df3254b49d Merge of descr-branch back into trunk. Tim Peters <tim.peters@gmail.com> parents: 17617 diff changeset	376
28219 7c8e8807aed2 - The extended type structure used for heap types (new-style Guido van Rossum <guido@python.org> parents: 26263 diff changeset	377 /* The real layout of a type object when allocated on the heap */
7c8e8807aed2 - The extended type structure used for heap types (new-style Guido van Rossum <guido@python.org> parents: 26263 diff changeset	378 typedef struct _heaptypeobject {
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	379 /* Note: there's a dependency on the order of these members
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	380 in slotptr() in typeobject.c . */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	381 PyTypeObject ht_type;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	382 PyNumberMethods as_number;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	383 PyMappingMethods as_mapping;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	384 PySequenceMethods as_sequence; /* as_sequence comes after as_mapping,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	385 so that the mapping wins when both
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	386 the mapping and the sequence define
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	387 a given operator (e.g. __getitem__).
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	388 see add_operators() in typeobject.c . */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	389 PyBufferProcs as_buffer;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	390 PyObject ht_name, ht_slots;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	391 /* here are optional user slots, followed by the members. */
28219 7c8e8807aed2 - The extended type structure used for heap types (new-style Guido van Rossum <guido@python.org> parents: 26263 diff changeset	392 } PyHeapTypeObject;
7c8e8807aed2 - The extended type structure used for heap types (new-style Guido van Rossum <guido@python.org> parents: 26263 diff changeset	393
7c8e8807aed2 - The extended type structure used for heap types (new-style Guido van Rossum <guido@python.org> parents: 26263 diff changeset	394 /* access macro to the members which are floating "behind" the object */
7c8e8807aed2 - The extended type structure used for heap types (new-style Guido van Rossum <guido@python.org> parents: 26263 diff changeset	395 #define PyHeapType_GET_MEMBERS(etype) \
44351 86a2679dca46 #1629: Renamed Py_Size, Py_Type and Py_Refcnt to Py_SIZE, Py_TYPE and Py_REFCNT. Christian Heimes <christian@cheimes.de> parents: 44098 diff changeset	396 ((PyMemberDef )(((char )etype) + Py_TYPE(etype)->tp_basicsize))
28219 7c8e8807aed2 - The extended type structure used for heap types (new-style Guido van Rossum <guido@python.org> parents: 26263 diff changeset	397
7c8e8807aed2 - The extended type structure used for heap types (new-style Guido van Rossum <guido@python.org> parents: 26263 diff changeset	398
18933 09df3254b49d Merge of descr-branch back into trunk. Tim Peters <tim.peters@gmail.com> parents: 17617 diff changeset	399 /* Generic type check */
24420 36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	400 PyAPI_FUNC(int) PyType_IsSubtype(PyTypeObject , PyTypeObject );
18933 09df3254b49d Merge of descr-branch back into trunk. Tim Peters <tim.peters@gmail.com> parents: 17617 diff changeset	401 #define PyObject_TypeCheck(ob, tp) \
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	402 (Py_TYPE(ob) == (tp) \|\| PyType_IsSubtype(Py_TYPE(ob), (tp)))
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	403
24420 36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	404 PyAPI_DATA(PyTypeObject) PyType_Type; /* built-in 'type' */
36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	405 PyAPI_DATA(PyTypeObject) PyBaseObject_Type; /* built-in 'object' */
36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	406 PyAPI_DATA(PyTypeObject) PySuper_Type; /* built-in 'super' */
18933 09df3254b49d Merge of descr-branch back into trunk. Tim Peters <tim.peters@gmail.com> parents: 17617 diff changeset	407
40909 f2f0b41f270d Merged revisions 53875-53911 via svnmerge from Thomas Wouters <thomas@python.org> parents: 40737 diff changeset	408 #define PyType_Check(op) \
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	409 PyType_FastSubclass(Py_TYPE(op), Py_TPFLAGS_TYPE_SUBCLASS)
44351 86a2679dca46 #1629: Renamed Py_Size, Py_Type and Py_Refcnt to Py_SIZE, Py_TYPE and Py_REFCNT. Christian Heimes <christian@cheimes.de> parents: 44098 diff changeset	410 #define PyType_CheckExact(op) (Py_TYPE(op) == &PyType_Type)
18933 09df3254b49d Merge of descr-branch back into trunk. Tim Peters <tim.peters@gmail.com> parents: 17617 diff changeset	411
24420 36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	412 PyAPI_FUNC(int) PyType_Ready(PyTypeObject *);
36501 7fdc639bc5b4 Merge ssize_t branch. Martin v. Löwis <martin@v.loewis.de> parents: 35999 diff changeset	413 PyAPI_FUNC(PyObject ) PyType_GenericAlloc(PyTypeObject , Py_ssize_t);
24420 36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	414 PyAPI_FUNC(PyObject ) PyType_GenericNew(PyTypeObject ,
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	415 PyObject , PyObject );
24420 36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	416 PyAPI_FUNC(PyObject ) _PyType_Lookup(PyTypeObject , PyObject *);
53905 2993f049e2c9 Merged revisions 72461 via svnmerge from Benjamin Peterson <benjamin@python.org> parents: 52951 diff changeset	417 PyAPI_FUNC(PyObject ) _PyObject_LookupSpecial(PyObject , char , PyObject *);
45026 ebfbaa1051e2 Merged revisions 60364-60378 via svnmerge from Christian Heimes <christian@cheimes.de> parents: 44654 diff changeset	418 PyAPI_FUNC(unsigned int) PyType_ClearCache(void);
47557 98827a21e352 Merged revisions 63724,63726,63732,63744,63754-63755,63757-63758,63760,63775,63781-63782,63787,63805-63808,63818-63819,63823-63824 via svnmerge from Georg Brandl <georg@python.org> parents: 47500 diff changeset	419 PyAPI_FUNC(void) PyType_Modified(PyTypeObject *);
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	420
86 a6934380c6e7 "Compiling" version Guido van Rossum <guido@python.org> parents: 68 diff changeset	421 /* Generic operations on objects */
24420 36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	422 PyAPI_FUNC(int) PyObject_Print(PyObject , FILE , int);
40737 6ebad2a6b990 Merged revisions 53451-53537 via svnmerge from Thomas Wouters <thomas@python.org> parents: 40401 diff changeset	423 PyAPI_FUNC(void) _Py_BreakPoint(void);
24420 36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	424 PyAPI_FUNC(void) _PyObject_Dump(PyObject *);
36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	425 PyAPI_FUNC(PyObject ) PyObject_Repr(PyObject );
36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	426 PyAPI_FUNC(PyObject ) PyObject_Str(PyObject );
47611 da47e7e135ae #2630: Implement PEP 3138. Georg Brandl <georg@python.org> parents: 47557 diff changeset	427 PyAPI_FUNC(PyObject ) PyObject_ASCII(PyObject );
48871 548dccc4008e make bytes(o) respect __bytes__ #2415 Benjamin Peterson <benjamin@python.org> parents: 48683 diff changeset	428 PyAPI_FUNC(PyObject ) PyObject_Bytes(PyObject );
24420 36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	429 PyAPI_FUNC(PyObject ) PyObject_RichCompare(PyObject , PyObject *, int);
36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	430 PyAPI_FUNC(int) PyObject_RichCompareBool(PyObject , PyObject , int);
35999 9541369b0dca Add const to several API functions that take char . Jeremy Hylton <jeremy@alum.mit.edu>* parents: 35331 diff changeset	431 PyAPI_FUNC(PyObject ) PyObject_GetAttrString(PyObject , const char *);
9541369b0dca Add const to several API functions that take char . Jeremy Hylton <jeremy@alum.mit.edu>* parents: 35331 diff changeset	432 PyAPI_FUNC(int) PyObject_SetAttrString(PyObject , const char , PyObject *);
9541369b0dca Add const to several API functions that take char . Jeremy Hylton <jeremy@alum.mit.edu>* parents: 35331 diff changeset	433 PyAPI_FUNC(int) PyObject_HasAttrString(PyObject , const char );
24420 36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	434 PyAPI_FUNC(PyObject ) PyObject_GetAttr(PyObject , PyObject *);
36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	435 PyAPI_FUNC(int) PyObject_SetAttr(PyObject , PyObject , PyObject *);
36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	436 PyAPI_FUNC(int) PyObject_HasAttr(PyObject , PyObject );
36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	437 PyAPI_FUNC(PyObject *) _PyObject_GetDictPtr(PyObject );
28320 fd5ef7003469 Renamed PyObject_GenericGetIter to PyObject_SelfIter Raymond Hettinger <python@rcn.com> parents: 28308 diff changeset	438 PyAPI_FUNC(PyObject ) PyObject_SelfIter(PyObject );
50755 c99ce0164699 Merged revisions 68560 via svnmerge from Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 50490 diff changeset	439 PyAPI_FUNC(PyObject ) _PyObject_NextNotImplemented(PyObject );
24420 36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	440 PyAPI_FUNC(PyObject ) PyObject_GenericGetAttr(PyObject , PyObject *);
36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	441 PyAPI_FUNC(int) PyObject_GenericSetAttr(PyObject *,
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	442 PyObject , PyObject );
24420 36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	443 PyAPI_FUNC(long) PyObject_Hash(PyObject *);
48475 f4e7ef4329a9 Manual forward port of 64962 - use PyObject_HashNotImplemented as a tp_hash level indicator that the default hash implementation has not been inherited Nick Coghlan <ncoghlan@gmail.com> parents: 47620 diff changeset	444 PyAPI_FUNC(long) PyObject_HashNotImplemented(PyObject *);
24420 36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	445 PyAPI_FUNC(int) PyObject_IsTrue(PyObject *);
36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	446 PyAPI_FUNC(int) PyObject_Not(PyObject *);
36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	447 PyAPI_FUNC(int) PyCallable_Check(PyObject *);
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	448
24420 36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	449 PyAPI_FUNC(void) PyObject_ClearWeakRefs(PyObject *);
16385 1fb6672b20ef PEP 205, Weak References -- initial checkin. Fred Drake <fdrake@acm.org> parents: 16235 diff changeset	450
19970 f761cab28c1c Hopefully fix 3-way comparisons. This unfortunately adds yet another Guido van Rossum <guido@python.org> parents: 19705 diff changeset	451
44098 0889daf6d0d9 #1535: rename __builtin__ module to builtins. Georg Brandl <georg@python.org> parents: 43866 diff changeset	452 /* PyObject_Dir(obj) acts like Python builtins.dir(obj), returning a
0889daf6d0d9 #1535: rename __builtin__ module to builtins. Georg Brandl <georg@python.org> parents: 43866 diff changeset	453 list of strings. PyObject_Dir(NULL) is like builtins.dir(),
19705 b7f6fbc087a7 At Guido's suggestion, here's a new C API function, PyObject_Dir(), like Tim Peters <tim.peters@gmail.com> parents: 19576 diff changeset	454 returning the names of the current locals. In this case, if there are
b7f6fbc087a7 At Guido's suggestion, here's a new C API function, PyObject_Dir(), like Tim Peters <tim.peters@gmail.com> parents: 19576 diff changeset	455 no current locals, NULL is returned, and PyErr_Occurred() is false.
b7f6fbc087a7 At Guido's suggestion, here's a new C API function, PyObject_Dir(), like Tim Peters <tim.peters@gmail.com> parents: 19576 diff changeset	456 */
24420 36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	457 PyAPI_FUNC(PyObject ) PyObject_Dir(PyObject );
19705 b7f6fbc087a7 At Guido's suggestion, here's a new C API function, PyObject_Dir(), like Tim Peters <tim.peters@gmail.com> parents: 19576 diff changeset	458
b7f6fbc087a7 At Guido's suggestion, here's a new C API function, PyObject_Dir(), like Tim Peters <tim.peters@gmail.com> parents: 19576 diff changeset	459
7983 068303f925ea Add prototypes for Py_Repr{Enter,Leave}. Guido van Rossum <guido@python.org> parents: 7935 diff changeset	460 /* Helpers for printing recursive container types */
24420 36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	461 PyAPI_FUNC(int) Py_ReprEnter(PyObject *);
36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	462 PyAPI_FUNC(void) Py_ReprLeave(PyObject *);
7983 068303f925ea Add prototypes for Py_Repr{Enter,Leave}. Guido van Rossum <guido@python.org> parents: 7935 diff changeset	463
13141 cca84745da3e This patch addresses two main issues: (1) There exist some non-fatal Fred Drake <fdrake@acm.org> parents: 12993 diff changeset	464 /* Helpers for hash functions */
24420 36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	465 PyAPI_FUNC(long) _Py_HashDouble(double);
36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	466 PyAPI_FUNC(long) _Py_HashPointer(void*);
13141 cca84745da3e This patch addresses two main issues: (1) There exist some non-fatal Fred Drake <fdrake@acm.org> parents: 12993 diff changeset	467
16394 f700e6b8de1f Undo recent change that banned using import to bind a global, as per Jeremy Hylton <jeremy@alum.mit.edu> parents: 16385 diff changeset	468 /* Helper for passing objects to printf and the like */
48660 85b67fb5672b Rename PyUnicode_AsString -> _PyUnicode_AsString and Marc-André Lemburg <mal@egenix.com> parents: 48499 diff changeset	469 #define PyObject_REPR(obj) _PyUnicode_AsString(PyObject_Repr(obj))
16394 f700e6b8de1f Undo recent change that banned using import to bind a global, as per Jeremy Hylton <jeremy@alum.mit.edu> parents: 16385 diff changeset	470
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	471 /* Flag bits for printing: */
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	472 #define Py_PRINT_RAW 1 /* No string quotes etc. */
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	473
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	474 /*
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	475 `Type flags (tp_flags)
9304 cc3e14837379 Changes by Greg Stein (code) and GvR (design). Guido van Rossum <guido@python.org> parents: 8124 diff changeset	476
cc3e14837379 Changes by Greg Stein (code) and GvR (design). Guido van Rossum <guido@python.org> parents: 8124 diff changeset	477 These flags are used to extend the type structure in a backwards-compatible
cc3e14837379 Changes by Greg Stein (code) and GvR (design). Guido van Rossum <guido@python.org> parents: 8124 diff changeset	478 fashion. Extensions can use the flags to indicate (and test) when a given
cc3e14837379 Changes by Greg Stein (code) and GvR (design). Guido van Rossum <guido@python.org> parents: 8124 diff changeset	479 type structure contains a new feature. The Python core will use these when
cc3e14837379 Changes by Greg Stein (code) and GvR (design). Guido van Rossum <guido@python.org> parents: 8124 diff changeset	480 introducing new functionality between major revisions (to avoid mid-version
cc3e14837379 Changes by Greg Stein (code) and GvR (design). Guido van Rossum <guido@python.org> parents: 8124 diff changeset	481 changes in the PYTHON_API_VERSION).
cc3e14837379 Changes by Greg Stein (code) and GvR (design). Guido van Rossum <guido@python.org> parents: 8124 diff changeset	482
cc3e14837379 Changes by Greg Stein (code) and GvR (design). Guido van Rossum <guido@python.org> parents: 8124 diff changeset	483 Arbitration of the flag bit positions will need to be coordinated among
cc3e14837379 Changes by Greg Stein (code) and GvR (design). Guido van Rossum <guido@python.org> parents: 8124 diff changeset	484 all extension writers who publically release their extensions (this will
cc3e14837379 Changes by Greg Stein (code) and GvR (design). Guido van Rossum <guido@python.org> parents: 8124 diff changeset	485 be fewer than you might expect!)..
cc3e14837379 Changes by Greg Stein (code) and GvR (design). Guido van Rossum <guido@python.org> parents: 8124 diff changeset	486
39222 b0cdcbcc5f45 Get rid of most of the flags (in tp_flags) that keep track of various Guido van Rossum <guido@python.org> parents: 37879 diff changeset	487 Most flags were removed as of Python 3.0 to make room for new flags. (Some
b0cdcbcc5f45 Get rid of most of the flags (in tp_flags) that keep track of various Guido van Rossum <guido@python.org> parents: 37879 diff changeset	488 flags are not for backwards compatibility but to indicate the presence of an
b0cdcbcc5f45 Get rid of most of the flags (in tp_flags) that keep track of various Guido van Rossum <guido@python.org> parents: 37879 diff changeset	489 optional feature; these flags remain of course.)
9304 cc3e14837379 Changes by Greg Stein (code) and GvR (design). Guido van Rossum <guido@python.org> parents: 8124 diff changeset	490
cc3e14837379 Changes by Greg Stein (code) and GvR (design). Guido van Rossum <guido@python.org> parents: 8124 diff changeset	491 Type definitions should use Py_TPFLAGS_DEFAULT for their tp_flags value.
cc3e14837379 Changes by Greg Stein (code) and GvR (design). Guido van Rossum <guido@python.org> parents: 8124 diff changeset	492
cc3e14837379 Changes by Greg Stein (code) and GvR (design). Guido van Rossum <guido@python.org> parents: 8124 diff changeset	493 Code can use PyType_HasFeature(type_ob, flag_value) to test whether the
cc3e14837379 Changes by Greg Stein (code) and GvR (design). Guido van Rossum <guido@python.org> parents: 8124 diff changeset	494 given type object has a specified feature.
cc3e14837379 Changes by Greg Stein (code) and GvR (design). Guido van Rossum <guido@python.org> parents: 8124 diff changeset	495 */
cc3e14837379 Changes by Greg Stein (code) and GvR (design). Guido van Rossum <guido@python.org> parents: 8124 diff changeset	496
18933 09df3254b49d Merge of descr-branch back into trunk. Tim Peters <tim.peters@gmail.com> parents: 17617 diff changeset	497 /* Set if the type object is dynamically allocated */
09df3254b49d Merge of descr-branch back into trunk. Tim Peters <tim.peters@gmail.com> parents: 17617 diff changeset	498 #define Py_TPFLAGS_HEAPTYPE (1L<<9)
09df3254b49d Merge of descr-branch back into trunk. Tim Peters <tim.peters@gmail.com> parents: 17617 diff changeset	499
09df3254b49d Merge of descr-branch back into trunk. Tim Peters <tim.peters@gmail.com> parents: 17617 diff changeset	500 /* Set if the type allows subclassing */
09df3254b49d Merge of descr-branch back into trunk. Tim Peters <tim.peters@gmail.com> parents: 17617 diff changeset	501 #define Py_TPFLAGS_BASETYPE (1L<<10)
09df3254b49d Merge of descr-branch back into trunk. Tim Peters <tim.peters@gmail.com> parents: 17617 diff changeset	502
19134 d98121930e70 Add new flags for PyType_Ready(): READY to explicitly indicate the Guido van Rossum <guido@python.org> parents: 19051 diff changeset	503 /* Set if the type is 'ready' -- fully initialized */
d98121930e70 Add new flags for PyType_Ready(): READY to explicitly indicate the Guido van Rossum <guido@python.org> parents: 19051 diff changeset	504 #define Py_TPFLAGS_READY (1L<<12)
d98121930e70 Add new flags for PyType_Ready(): READY to explicitly indicate the Guido van Rossum <guido@python.org> parents: 19051 diff changeset	505
d98121930e70 Add new flags for PyType_Ready(): READY to explicitly indicate the Guido van Rossum <guido@python.org> parents: 19051 diff changeset	506 /* Set while the type is being 'readied', to prevent recursive ready calls */
d98121930e70 Add new flags for PyType_Ready(): READY to explicitly indicate the Guido van Rossum <guido@python.org> parents: 19051 diff changeset	507 #define Py_TPFLAGS_READYING (1L<<13)
d98121930e70 Add new flags for PyType_Ready(): READY to explicitly indicate the Guido van Rossum <guido@python.org> parents: 19051 diff changeset	508
19576 b67309407cfc Change the GC type flag since the API has changed. Allow types using Neil Schemenauer <nascheme@enme.ucalgary.ca> parents: 19470 diff changeset	509 /* Objects support garbage collection (see objimp.h) */
b67309407cfc Change the GC type flag since the API has changed. Allow types using Neil Schemenauer <nascheme@enme.ucalgary.ca> parents: 19470 diff changeset	510 #define Py_TPFLAGS_HAVE_GC (1L<<14)
b67309407cfc Change the GC type flag since the API has changed. Allow types using Neil Schemenauer <nascheme@enme.ucalgary.ca> parents: 19470 diff changeset	511
36882 6a9c7165b17b Checking in the code for PEP 357. Guido van Rossum <guido@python.org> parents: 36837 diff changeset	512 /* These two bits are preserved for Stackless Python, next after this is 17 */
29184 9aa06cbd9cc1 Preserved one bit in type objects for Stackless. Christian Tismer <tismer@stackless.com> parents: 28653 diff changeset	513 #ifdef STACKLESS
29245 ca0c8137de84 After Raymond's remark, I changed the Stackless bits to Christian Tismer <tismer@stackless.com> parents: 29240 diff changeset	514 #define Py_TPFLAGS_HAVE_STACKLESS_EXTENSION (3L<<15)
29184 9aa06cbd9cc1 Preserved one bit in type objects for Stackless. Christian Tismer <tismer@stackless.com> parents: 28653 diff changeset	515 #else
29240 e721025cca09 Generalized my type flags structure extension without being specific about Christian Tismer <tismer@stackless.com> parents: 29184 diff changeset	516 #define Py_TPFLAGS_HAVE_STACKLESS_EXTENSION 0
29184 9aa06cbd9cc1 Preserved one bit in type objects for Stackless. Christian Tismer <tismer@stackless.com> parents: 28653 diff changeset	517 #endif
9aa06cbd9cc1 Preserved one bit in type objects for Stackless. Christian Tismer <tismer@stackless.com> parents: 28653 diff changeset	518
44654 5a71dcc71eff Merged revisions 59921-59932 via svnmerge from Christian Heimes <christian@cheimes.de> parents: 44351 diff changeset	519 /* Objects support type attribute cache */
5a71dcc71eff Merged revisions 59921-59932 via svnmerge from Christian Heimes <christian@cheimes.de> parents: 44351 diff changeset	520 #define Py_TPFLAGS_HAVE_VERSION_TAG (1L<<18)
5a71dcc71eff Merged revisions 59921-59932 via svnmerge from Christian Heimes <christian@cheimes.de> parents: 44351 diff changeset	521 #define Py_TPFLAGS_VALID_VERSION_TAG (1L<<19)
5a71dcc71eff Merged revisions 59921-59932 via svnmerge from Christian Heimes <christian@cheimes.de> parents: 44351 diff changeset	522
45549 8dd30fe11a4b Merged revisions 61038,61042-61045,61047,61050,61053,61055-61056,61061-61062,61066,61068,61070,61083,61085,61092-61103 via svnmerge from Christian Heimes <christian@cheimes.de> parents: 45401 diff changeset	523 /* Type is abstract and cannot be instantiated */
8dd30fe11a4b Merged revisions 61038,61042-61045,61047,61050,61053,61055-61056,61061-61062,61066,61068,61070,61083,61085,61092-61103 via svnmerge from Christian Heimes <christian@cheimes.de> parents: 45401 diff changeset	524 #define Py_TPFLAGS_IS_ABSTRACT (1L<<20)
8dd30fe11a4b Merged revisions 61038,61042-61045,61047,61050,61053,61055-61056,61061-61062,61066,61068,61070,61083,61085,61092-61103 via svnmerge from Christian Heimes <christian@cheimes.de> parents: 45401 diff changeset	525
40909 f2f0b41f270d Merged revisions 53875-53911 via svnmerge from Thomas Wouters <thomas@python.org> parents: 40737 diff changeset	526 /* These flags are used to determine if a type is a subclass. */
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	527 #define Py_TPFLAGS_INT_SUBCLASS (1L<<23)
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	528 #define Py_TPFLAGS_LONG_SUBCLASS (1L<<24)
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	529 #define Py_TPFLAGS_LIST_SUBCLASS (1L<<25)
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	530 #define Py_TPFLAGS_TUPLE_SUBCLASS (1L<<26)
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	531 #define Py_TPFLAGS_BYTES_SUBCLASS (1L<<27)
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	532 #define Py_TPFLAGS_UNICODE_SUBCLASS (1L<<28)
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	533 #define Py_TPFLAGS_DICT_SUBCLASS (1L<<29)
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	534 #define Py_TPFLAGS_BASE_EXC_SUBCLASS (1L<<30)
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	535 #define Py_TPFLAGS_TYPE_SUBCLASS (1L<<31)
40909 f2f0b41f270d Merged revisions 53875-53911 via svnmerge from Thomas Wouters <thomas@python.org> parents: 40737 diff changeset	536
16235 5c60184f7f52 Add a flag to indicate the presence of the tp_richcompare field, and Guido van Rossum <guido@python.org> parents: 16195 diff changeset	537 #define Py_TPFLAGS_DEFAULT ( \
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	538 Py_TPFLAGS_HAVE_STACKLESS_EXTENSION \| \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	539 Py_TPFLAGS_HAVE_VERSION_TAG \| \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	540 0)
9304 cc3e14837379 Changes by Greg Stein (code) and GvR (design). Guido van Rossum <guido@python.org> parents: 8124 diff changeset	541
cc3e14837379 Changes by Greg Stein (code) and GvR (design). Guido van Rossum <guido@python.org> parents: 8124 diff changeset	542 #define PyType_HasFeature(t,f) (((t)->tp_flags & (f)) != 0)
40909 f2f0b41f270d Merged revisions 53875-53911 via svnmerge from Thomas Wouters <thomas@python.org> parents: 40737 diff changeset	543 #define PyType_FastSubclass(t,f) PyType_HasFeature(t,f)
9304 cc3e14837379 Changes by Greg Stein (code) and GvR (design). Guido van Rossum <guido@python.org> parents: 8124 diff changeset	544
cc3e14837379 Changes by Greg Stein (code) and GvR (design). Guido van Rossum <guido@python.org> parents: 8124 diff changeset	545
cc3e14837379 Changes by Greg Stein (code) and GvR (design). Guido van Rossum <guido@python.org> parents: 8124 diff changeset	546 /*
2129 05360cd616ae The great renaming, phase two: all header files have been updated to Guido van Rossum <guido@python.org> parents: 2071 diff changeset	547 The macros Py_INCREF(op) and Py_DECREF(op) are used to increment or decrement
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	548 reference counts. Py_DECREF calls the object's deallocator function when
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	549 the refcount falls to 0; for
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	550 objects that don't contain references to other objects or heap memory
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	551 this can be the standard function free(). Both macros can be used
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	552 wherever a void expression is allowed. The argument must not be a
46222 aed698c8647b Merged revisions 62021,62029,62035-62038,62043-62044,62052-62053 via svnmerge from Benjamin Peterson <benjamin@python.org> parents: 45549 diff changeset	553 NULL pointer. If it may be NULL, use Py_XINCREF/Py_XDECREF instead.
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	554 The macro _Py_NewReference(op) initialize reference counts to 1, and
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	555 in special builds (Py_REF_DEBUG, Py_TRACE_REFS) performs additional
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	556 bookkeeping appropriate to the special build.
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	557
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	558 We assume that the reference count field can never overflow; this can
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	559 be proven when the size of the field is the same as the pointer size, so
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	560 we ignore the possibility. Provided a C int is at least 32 bits (which
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	561 is implicitly assumed in many parts of this code), that's enough for
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	562 about 2**31 references to an object.
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	563
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	564 XXX The following became out of date in Python 2.2, but I'm not sure
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	565 XXX what the full truth is now. Certainly, heap-allocated type objects
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	566 XXX can and should be deallocated.
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	567 Type objects should never be deallocated; the type pointer in an object
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	568 is not considered to be a reference to the type object, to save
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	569 complications in the deallocation function. (This is actually a
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	570 decision that's up to the implementer of each new type so if you want,
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	571 you can count such references to the type object.)
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	572
2129 05360cd616ae The great renaming, phase two: all header files have been updated to Guido van Rossum <guido@python.org> parents: 2071 diff changeset	573 * WARNING* The Py_DECREF macro must have a side-effect-free argument
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	574 since it may evaluate its argument multiple times. (The alternative
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	575 would be to mace it a proper function or assign it to a global temporary
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	576 variable first, both of which are slower; and in a multi-threaded
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	577 environment the global variable trick is not safe.)
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	578 */
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	579
24184 c4dcb80f48ea object.h special-build macro minefield: renamed all the new lexical Tim Peters <tim.peters@gmail.com> parents: 24171 diff changeset	580 /* First define a pile of simple helper macros, one set per special
c4dcb80f48ea object.h special-build macro minefield: renamed all the new lexical Tim Peters <tim.peters@gmail.com> parents: 24171 diff changeset	581 * build symbol. These either expand to the obvious things, or to
c4dcb80f48ea object.h special-build macro minefield: renamed all the new lexical Tim Peters <tim.peters@gmail.com> parents: 24171 diff changeset	582 * nothing at all when the special mode isn't in effect. The main
c4dcb80f48ea object.h special-build macro minefield: renamed all the new lexical Tim Peters <tim.peters@gmail.com> parents: 24171 diff changeset	583 * macros can later be defined just once then, yet expand to different
c4dcb80f48ea object.h special-build macro minefield: renamed all the new lexical Tim Peters <tim.peters@gmail.com> parents: 24171 diff changeset	584 * things depending on which special build options are and aren't in effect.
c4dcb80f48ea object.h special-build macro minefield: renamed all the new lexical Tim Peters <tim.peters@gmail.com> parents: 24171 diff changeset	585 * Trust me <wink>: while painful, this is 20x easier to understand than,
c4dcb80f48ea object.h special-build macro minefield: renamed all the new lexical Tim Peters <tim.peters@gmail.com> parents: 24171 diff changeset	586 * e.g, defining _Py_NewReference five different times in a maze of nested
c4dcb80f48ea object.h special-build macro minefield: renamed all the new lexical Tim Peters <tim.peters@gmail.com> parents: 24171 diff changeset	587 * #ifdefs (we used to do that -- it was impenetrable).
c4dcb80f48ea object.h special-build macro minefield: renamed all the new lexical Tim Peters <tim.peters@gmail.com> parents: 24171 diff changeset	588 */
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	589 #ifdef Py_REF_DEBUG
36837 3a3aed49b245 Use Py_ssize_t for _Py_RefTotal. Neal Norwitz <nnorwitz@gmail.com> parents: 36748 diff changeset	590 PyAPI_DATA(Py_ssize_t) _Py_RefTotal;
24420 36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	591 PyAPI_FUNC(void) _Py_NegativeRefcount(const char *fname,
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	592 int lineno, PyObject *op);
37879 f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	593 PyAPI_FUNC(PyObject *) _PyDict_Dummy(void);
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	594 PyAPI_FUNC(PyObject *) _PySet_Dummy(void);
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	595 PyAPI_FUNC(Py_ssize_t) _Py_GetRefTotal(void);
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	596 #define _Py_INC_REFTOTAL _Py_RefTotal++
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	597 #define _Py_DEC_REFTOTAL _Py_RefTotal--
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	598 #define _Py_REF_DEBUG_COMMA ,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	599 #define _Py_CHECK_REFCNT(OP) \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	600 { if (((PyObject*)OP)->ob_refcnt < 0) \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	601 _Py_NegativeRefcount(__FILE__, __LINE__, \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	602 (PyObject *)(OP)); \
24155 9456a2ccda61 The Py_REF_DEBUG/COUNT_ALLOCS/Py_TRACE_REFS macro minefield: added Tim Peters <tim.peters@gmail.com> parents: 24126 diff changeset	603 }
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	604 #else
24184 c4dcb80f48ea object.h special-build macro minefield: renamed all the new lexical Tim Peters <tim.peters@gmail.com> parents: 24171 diff changeset	605 #define _Py_INC_REFTOTAL
c4dcb80f48ea object.h special-build macro minefield: renamed all the new lexical Tim Peters <tim.peters@gmail.com> parents: 24171 diff changeset	606 #define _Py_DEC_REFTOTAL
c4dcb80f48ea object.h special-build macro minefield: renamed all the new lexical Tim Peters <tim.peters@gmail.com> parents: 24171 diff changeset	607 #define _Py_REF_DEBUG_COMMA
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	608 #define _Py_CHECK_REFCNT(OP) /* a semicolon */;
24171 5e4b8d1e9fd6 Uglified the new Py_REF_DEBUG (etc) lexical helper macro definitions so Tim Peters <tim.peters@gmail.com> parents: 24155 diff changeset	609 #endif /* Py_REF_DEBUG */
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	610
1347 a22a350d3a5d * Extended X interface: pixmap objects, colormap objects visual objects, Sjoerd Mullender <sjoerd@acm.org> parents: 1329 diff changeset	611 #ifdef COUNT_ALLOCS
24420 36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	612 PyAPI_FUNC(void) inc_count(PyTypeObject *);
37879 f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	613 PyAPI_FUNC(void) dec_count(PyTypeObject *);
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	614 #define _Py_INC_TPALLOCS(OP) inc_count(Py_TYPE(OP))
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	615 #define _Py_INC_TPFREES(OP) dec_count(Py_TYPE(OP))
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	616 #define _Py_DEC_TPFREES(OP) Py_TYPE(OP)->tp_frees--
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	617 #define _Py_COUNT_ALLOCS_COMMA ,
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	618 #else
24184 c4dcb80f48ea object.h special-build macro minefield: renamed all the new lexical Tim Peters <tim.peters@gmail.com> parents: 24171 diff changeset	619 #define _Py_INC_TPALLOCS(OP)
c4dcb80f48ea object.h special-build macro minefield: renamed all the new lexical Tim Peters <tim.peters@gmail.com> parents: 24171 diff changeset	620 #define _Py_INC_TPFREES(OP)
c4dcb80f48ea object.h special-build macro minefield: renamed all the new lexical Tim Peters <tim.peters@gmail.com> parents: 24171 diff changeset	621 #define _Py_DEC_TPFREES(OP)
c4dcb80f48ea object.h special-build macro minefield: renamed all the new lexical Tim Peters <tim.peters@gmail.com> parents: 24171 diff changeset	622 #define _Py_COUNT_ALLOCS_COMMA
24171 5e4b8d1e9fd6 Uglified the new Py_REF_DEBUG (etc) lexical helper macro definitions so Tim Peters <tim.peters@gmail.com> parents: 24155 diff changeset	623 #endif /* COUNT_ALLOCS */
1347 a22a350d3a5d * Extended X interface: pixmap objects, colormap objects visual objects, Sjoerd Mullender <sjoerd@acm.org> parents: 1329 diff changeset	624
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	625 #ifdef Py_TRACE_REFS
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	626 /* Py_TRACE_REFS is such major surgery that we call external routines. */
24420 36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	627 PyAPI_FUNC(void) _Py_NewReference(PyObject *);
36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	628 PyAPI_FUNC(void) _Py_ForgetReference(PyObject *);
36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	629 PyAPI_FUNC(void) _Py_Dealloc(PyObject *);
36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	630 PyAPI_FUNC(void) _Py_PrintReferences(FILE *);
28653 56006d97bcef _Py_PrintReferences(): Changed to print object address at start of each Tim Peters <tim.peters@gmail.com> parents: 28396 diff changeset	631 PyAPI_FUNC(void) _Py_PrintReferenceAddresses(FILE *);
28396 d56282c28a1e Improved new Py_TRACE_REFS gimmicks. Tim Peters <tim.peters@gmail.com> parents: 28389 diff changeset	632 PyAPI_FUNC(void) _Py_AddToAllObjects(PyObject *, int force);
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	633
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	634 #else
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	635 /* Without Py_TRACE_REFS, there's little enough to do that we expand code
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	636 * inline.
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	637 */
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	638 #define _Py_NewReference(op) ( \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	639 _Py_INC_TPALLOCS(op) _Py_COUNT_ALLOCS_COMMA \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	640 _Py_INC_REFTOTAL _Py_REF_DEBUG_COMMA \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	641 Py_REFCNT(op) = 1)
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	642
24184 c4dcb80f48ea object.h special-build macro minefield: renamed all the new lexical Tim Peters <tim.peters@gmail.com> parents: 24171 diff changeset	643 #define _Py_ForgetReference(op) _Py_INC_TPFREES(op)
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	644
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	645 #define _Py_Dealloc(op) ( \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	646 _Py_INC_TPFREES(op) _Py_COUNT_ALLOCS_COMMA \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	647 (Py_TYPE(op)->tp_dealloc)((PyObject )(op)))
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	648 #endif /* !Py_TRACE_REFS */
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	649
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	650 #define Py_INCREF(op) ( \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	651 _Py_INC_REFTOTAL _Py_REF_DEBUG_COMMA \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	652 ((PyObject*)(op))->ob_refcnt++)
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	653
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	654 #define Py_DECREF(op) \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	655 do { \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	656 if (_Py_DEC_REFTOTAL _Py_REF_DEBUG_COMMA \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	657 --((PyObject*)(op))->ob_refcnt != 0) \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	658 _Py_CHECK_REFCNT(op) \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	659 else \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	660 _Py_Dealloc((PyObject *)(op)); \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	661 } while (0)
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	662
37879 f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	663 /* Safely decref `op` and set `op` to NULL, especially useful in tp_clear
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	664 * and tp_dealloc implementatons.
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	665 *
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	666 * Note that "the obvious" code can be deadly:
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	667 *
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	668 * Py_XDECREF(op);
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	669 * op = NULL;
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	670 *
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	671 * Typically, `op` is something like self->containee, and `self` is done
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	672 * using its `containee` member. In the code sequence above, suppose
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	673 * `containee` is non-NULL with a refcount of 1. Its refcount falls to
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	674 * 0 on the first line, which can trigger an arbitrary amount of code,
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	675 * possibly including finalizers (like __del__ methods or weakref callbacks)
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	676 * coded in Python, which in turn can release the GIL and allow other threads
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	677 * to run, etc. Such code may even invoke methods of `self` again, or cause
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	678 * cyclic gc to trigger, but-- oops! --self->containee still points to the
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	679 * object being torn down, and it may be in an insane state while being torn
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	680 * down. This has in fact been a rich historic source of miserable (rare &
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	681 * hard-to-diagnose) segfaulting (and other) bugs.
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	682 *
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	683 * The safe way is:
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	684 *
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	685 * Py_CLEAR(op);
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	686 *
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	687 * That arranges to set `op` to NULL _before_ decref'ing, so that any code
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	688 * triggered as a side-effect of `op` getting torn down no longer believes
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	689 * `op` points to a valid object.
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	690 *
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	691 * There are cases where it's safe to use the naive code, but they're brittle.
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	692 * For example, if `op` points to a Python integer, you know that destroying
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	693 * one of those can't cause problems -- but in part that relies on that
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	694 * Python integers aren't currently weakly referencable. Best practice is
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	695 * to use Py_CLEAR() even if you can't think of a reason for why you need to.
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair Thomas Wouters <thomas@python.org> parents: 37191 diff changeset	696 */
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	697 #define Py_CLEAR(op) \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	698 do { \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	699 if (op) { \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	700 PyObject _py_tmp = (PyObject )(op); \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	701 (op) = NULL; \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	702 Py_DECREF(_py_tmp); \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	703 } \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	704 } while (0)
32670 a1a9776fab53 Implemented a new Py_CLEAR macro. This macro should be used when Jim Fulton <jim@zope.com> parents: 31940 diff changeset	705
86 a6934380c6e7 "Compiling" version Guido van Rossum <guido@python.org> parents: 68 diff changeset	706 /* Macros to use in case the object pointer may be NULL: */
52951 f92533925ea6 Merged revisions 71229,71271 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 52828 diff changeset	707 #define Py_XINCREF(op) do { if ((op) == NULL) ; else Py_INCREF(op); } while (0)
f92533925ea6 Merged revisions 71229,71271 via svnmerge from Matthias Klose <doko@ubuntu.com> parents: 52828 diff changeset	708 #define Py_XDECREF(op) do { if ((op) == NULL) ; else Py_DECREF(op); } while (0)
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	709
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	710 /*
31940 059740d52ae5 Two new public API functions, Py_IncRef and Py_DecRef. Useful for Thomas Heller <theller@ctypes.org> parents: 30887 diff changeset	711 These are provided as conveniences to Python runtime embedders, so that
059740d52ae5 Two new public API functions, Py_IncRef and Py_DecRef. Useful for Thomas Heller <theller@ctypes.org> parents: 30887 diff changeset	712 they can have object code that is not dependent on Python compilation flags.
059740d52ae5 Two new public API functions, Py_IncRef and Py_DecRef. Useful for Thomas Heller <theller@ctypes.org> parents: 30887 diff changeset	713 */
059740d52ae5 Two new public API functions, Py_IncRef and Py_DecRef. Useful for Thomas Heller <theller@ctypes.org> parents: 30887 diff changeset	714 PyAPI_FUNC(void) Py_IncRef(PyObject *);
059740d52ae5 Two new public API functions, Py_IncRef and Py_DecRef. Useful for Thomas Heller <theller@ctypes.org> parents: 30887 diff changeset	715 PyAPI_FUNC(void) Py_DecRef(PyObject *);
059740d52ae5 Two new public API functions, Py_IncRef and Py_DecRef. Useful for Thomas Heller <theller@ctypes.org> parents: 30887 diff changeset	716
059740d52ae5 Two new public API functions, Py_IncRef and Py_DecRef. Useful for Thomas Heller <theller@ctypes.org> parents: 30887 diff changeset	717 /*
2129 05360cd616ae The great renaming, phase two: all header files have been updated to Guido van Rossum <guido@python.org> parents: 2071 diff changeset	718 _Py_NoneStruct is an object of undefined type which can be used in contexts
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	719 where NULL (nil) is not suitable (since NULL often means 'error').
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	720
2129 05360cd616ae The great renaming, phase two: all header files have been updated to Guido van Rossum <guido@python.org> parents: 2071 diff changeset	721 Don't forget to apply Py_INCREF() when returning this value!!!
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	722 */
24420 36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	723 PyAPI_DATA(PyObject) _Py_NoneStruct; /* Don't use this directly */
2129 05360cd616ae The great renaming, phase two: all header files have been updated to Guido van Rossum <guido@python.org> parents: 2071 diff changeset	724 #define Py_None (&_Py_NoneStruct)
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	725
30719 7dfdf9e8d95d Defined macros Py_RETURN_(TRUE\|FALSE\|NONE) as helper functions for returning Brett Cannon <bcannon@gmail.com> parents: 29245 diff changeset	726 /* Macro for returning Py_None from a function */
32793 1e2187f50631 SF bug 994255: Py_RETURN_NONE causes too much warnings Tim Peters <tim.peters@gmail.com> parents: 32670 diff changeset	727 #define Py_RETURN_NONE return Py_INCREF(Py_None), Py_None
30719 7dfdf9e8d95d Defined macros Py_RETURN_(TRUE\|FALSE\|NONE) as helper functions for returning Brett Cannon <bcannon@gmail.com> parents: 29245 diff changeset	728
15716 362e53f43dd2 - Add nb_cmp slot for new style nubmers. Neil Schemenauer <nascheme@enme.ucalgary.ca> parents: 14497 diff changeset	729 /*
362e53f43dd2 - Add nb_cmp slot for new style nubmers. Neil Schemenauer <nascheme@enme.ucalgary.ca> parents: 14497 diff changeset	730 Py_NotImplemented is a singleton used to signal that an operation is
362e53f43dd2 - Add nb_cmp slot for new style nubmers. Neil Schemenauer <nascheme@enme.ucalgary.ca> parents: 14497 diff changeset	731 not implemented for a given type combination.
362e53f43dd2 - Add nb_cmp slot for new style nubmers. Neil Schemenauer <nascheme@enme.ucalgary.ca> parents: 14497 diff changeset	732 */
24420 36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	733 PyAPI_DATA(PyObject) _Py_NotImplementedStruct; /* Don't use this directly */
15716 362e53f43dd2 - Add nb_cmp slot for new style nubmers. Neil Schemenauer <nascheme@enme.ucalgary.ca> parents: 14497 diff changeset	734 #define Py_NotImplemented (&_Py_NotImplementedStruct)
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	735
15938 8fd221aed357 Introduction to rich comparisons: Guido van Rossum <guido@python.org> parents: 15716 diff changeset	736 /* Rich comparison opcodes */
8fd221aed357 Introduction to rich comparisons: Guido van Rossum <guido@python.org> parents: 15716 diff changeset	737 #define Py_LT 0
8fd221aed357 Introduction to rich comparisons: Guido van Rossum <guido@python.org> parents: 15716 diff changeset	738 #define Py_LE 1
8fd221aed357 Introduction to rich comparisons: Guido van Rossum <guido@python.org> parents: 15716 diff changeset	739 #define Py_EQ 2
8fd221aed357 Introduction to rich comparisons: Guido van Rossum <guido@python.org> parents: 15716 diff changeset	740 #define Py_NE 3
8fd221aed357 Introduction to rich comparisons: Guido van Rossum <guido@python.org> parents: 15716 diff changeset	741 #define Py_GT 4
8fd221aed357 Introduction to rich comparisons: Guido van Rossum <guido@python.org> parents: 15716 diff changeset	742 #define Py_GE 5
8fd221aed357 Introduction to rich comparisons: Guido van Rossum <guido@python.org> parents: 15716 diff changeset	743
33541 781aef974463 A static swapped_op[] array was defined in 3 different C files, & I think Tim Peters <tim.peters@gmail.com> parents: 33386 diff changeset	744 /* Maps Py_LT to Py_GT, ..., Py_GE to Py_LE.
781aef974463 A static swapped_op[] array was defined in 3 different C files, & I think Tim Peters <tim.peters@gmail.com> parents: 33386 diff changeset	745 * Defined in object.c.
781aef974463 A static swapped_op[] array was defined in 3 different C files, & I think Tim Peters <tim.peters@gmail.com> parents: 33386 diff changeset	746 */
781aef974463 A static swapped_op[] array was defined in 3 different C files, & I think Tim Peters <tim.peters@gmail.com> parents: 33386 diff changeset	747 PyAPI_DATA(int) _Py_SwappedOp[];
781aef974463 A static swapped_op[] array was defined in 3 different C files, & I think Tim Peters <tim.peters@gmail.com> parents: 33386 diff changeset	748
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1400 diff changeset	749
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1400 diff changeset	750 /*
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	751 More conventions
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	752 ================
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	753
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	754 Argument Checking
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	755 -----------------
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	756
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	757 Functions that take objects as arguments normally don't check for nil
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	758 arguments, but they do check the type of the argument, and return an
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	759 error if the function doesn't apply to the type.
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	760
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	761 Failure Modes
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	762 -------------
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	763
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	764 Functions may fail for a variety of reasons, including running out of
86 a6934380c6e7 "Compiling" version Guido van Rossum <guido@python.org> parents: 68 diff changeset	765 memory. This is communicated to the caller in two ways: an error string
a6934380c6e7 "Compiling" version Guido van Rossum <guido@python.org> parents: 68 diff changeset	766 is set (see errors.h), and the function result differs: functions that
a6934380c6e7 "Compiling" version Guido van Rossum <guido@python.org> parents: 68 diff changeset	767 normally return a pointer return NULL for failure, functions returning
a6934380c6e7 "Compiling" version Guido van Rossum <guido@python.org> parents: 68 diff changeset	768 an integer return -1 (which could be a legal return value too!), and
a6934380c6e7 "Compiling" version Guido van Rossum <guido@python.org> parents: 68 diff changeset	769 other functions return 0 for success and -1 for failure.
24126 fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	770 Callers should always check for errors before using the result. If
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	771 an error was set, the caller must either explicitly clear it, or pass
fdf80e04e4bb Rearranged and added comments to object.h, to clarify many things Tim Peters <tim.peters@gmail.com> parents: 24122 diff changeset	772 the error on to its caller.
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	773
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	774 Reference Counts
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	775 ----------------
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	776
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	777 It takes a while to get used to the proper usage of reference counts.
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	778
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	779 Functions that create an object set the reference count to 1; such new
2129 05360cd616ae The great renaming, phase two: all header files have been updated to Guido van Rossum <guido@python.org> parents: 2071 diff changeset	780 objects must be stored somewhere or destroyed again with Py_DECREF().
30887 3ae82928b113 fixed buggy comment as per SF bug #827856 Alex Martelli <aleaxit@gmail.com> parents: 30721 diff changeset	781 Some functions that 'store' objects, such as PyTuple_SetItem() and
3ae82928b113 fixed buggy comment as per SF bug #827856 Alex Martelli <aleaxit@gmail.com> parents: 30721 diff changeset	782 PyList_SetItem(),
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	783 don't increment the reference count of the object, since the most
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	784 frequent use is to store a fresh object. Functions that 'retrieve'
30887 3ae82928b113 fixed buggy comment as per SF bug #827856 Alex Martelli <aleaxit@gmail.com> parents: 30721 diff changeset	785 objects, such as PyTuple_GetItem() and PyDict_GetItemString(), also
2129 05360cd616ae The great renaming, phase two: all header files have been updated to Guido van Rossum <guido@python.org> parents: 2071 diff changeset	786 don't increment
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	787 the reference count, since most frequently the object is only looked at
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	788 quickly. Thus, to retrieve an object and store it again, the caller
2129 05360cd616ae The great renaming, phase two: all header files have been updated to Guido van Rossum <guido@python.org> parents: 2071 diff changeset	789 must call Py_INCREF() explicitly.
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	790
30887 3ae82928b113 fixed buggy comment as per SF bug #827856 Alex Martelli <aleaxit@gmail.com> parents: 30721 diff changeset	791 NOTE: functions that 'consume' a reference count, like
3ae82928b113 fixed buggy comment as per SF bug #827856 Alex Martelli <aleaxit@gmail.com> parents: 30721 diff changeset	792 PyList_SetItem(), consume the reference even if the object wasn't
3ae82928b113 fixed buggy comment as per SF bug #827856 Alex Martelli <aleaxit@gmail.com> parents: 30721 diff changeset	793 successfully stored, to simplify error handling.
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	794
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	795 It seems attractive to make other functions that take an object as
30887 3ae82928b113 fixed buggy comment as per SF bug #827856 Alex Martelli <aleaxit@gmail.com> parents: 30721 diff changeset	796 argument consume a reference count; however, this may quickly get
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	797 confusing (even the current practice is already confusing). Consider
2129 05360cd616ae The great renaming, phase two: all header files have been updated to Guido van Rossum <guido@python.org> parents: 2071 diff changeset	798 it carefully, it may save lots of calls to Py_INCREF() and Py_DECREF() at
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	799 times.
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	800 */
1329 519c25039c6a * Added support for X11 modules. Guido van Rossum <guido@python.org> parents: 1324 diff changeset	801
24122 d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	802
d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	803 /* Trashcan mechanism, thanks to Christian Tismer.
d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	804
d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	805 When deallocating a container object, it's possible to trigger an unbounded
d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	806 chain of deallocations, as each Py_DECREF in turn drops the refcount on "the
d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	807 next" object in the chain to 0. This can easily lead to stack faults, and
d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	808 especially in threads (which typically have less stack space to work with).
11999 c94247b5c355 Christian Tismer's "trashcan" patch: Guido van Rossum <guido@python.org> parents: 11891 diff changeset	809
24122 d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	810 A container object that participates in cyclic gc can avoid this by
d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	811 bracketing the body of its tp_dealloc function with a pair of macros:
d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	812
d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	813 static void
d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	814 mytype_dealloc(mytype *p)
d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	815 {
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	816 ... declarations go here ...
11999 c94247b5c355 Christian Tismer's "trashcan" patch: Guido van Rossum <guido@python.org> parents: 11891 diff changeset	817
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	818 PyObject_GC_UnTrack(p); // must untrack first
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	819 Py_TRASHCAN_SAFE_BEGIN(p)
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	820 ... The body of the deallocator goes here, including all calls ...
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	821 ... to Py_DECREF on contained objects. ...
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	822 Py_TRASHCAN_SAFE_END(p)
24122 d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	823 }
11999 c94247b5c355 Christian Tismer's "trashcan" patch: Guido van Rossum <guido@python.org> parents: 11891 diff changeset	824
24654 f672e1dbad92 Added info about the right way to leave the body of a trashcan-protected Tim Peters <tim.peters@gmail.com> parents: 24420 diff changeset	825 CAUTION: Never return from the middle of the body! If the body needs to
f672e1dbad92 Added info about the right way to leave the body of a trashcan-protected Tim Peters <tim.peters@gmail.com> parents: 24420 diff changeset	826 "get out early", put a label immediately before the Py_TRASHCAN_SAFE_END
f672e1dbad92 Added info about the right way to leave the body of a trashcan-protected Tim Peters <tim.peters@gmail.com> parents: 24420 diff changeset	827 call, and goto it. Else the call-depth counter (see below) will stay
f672e1dbad92 Added info about the right way to leave the body of a trashcan-protected Tim Peters <tim.peters@gmail.com> parents: 24420 diff changeset	828 above 0 forever, and the trashcan will never get emptied.
f672e1dbad92 Added info about the right way to leave the body of a trashcan-protected Tim Peters <tim.peters@gmail.com> parents: 24420 diff changeset	829
24122 d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	830 How it works: The BEGIN macro increments a call-depth counter. So long
d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	831 as this counter is small, the body of the deallocator is run directly without
d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	832 further ado. But if the counter gets large, it instead adds p to a list of
d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	833 objects to be deallocated later, skips the body of the deallocator, and
d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	834 resumes execution after the END macro. The tp_dealloc routine then returns
d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	835 without deallocating anything (and so unbounded call-stack depth is avoided).
12481 a8898a172fe2 Christian Tismer -- total rewrite on trashcan code. Guido van Rossum <guido@python.org> parents: 12406 diff changeset	836
24122 d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	837 When the call stack finishes unwinding again, code generated by the END macro
d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	838 notices this, and calls another routine to deallocate all the objects that
d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	839 may have been added to the list of deferred deallocations. In effect, a
d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	840 chain of N deallocations is broken into N / PyTrash_UNWIND_LEVEL pieces,
d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	841 with the call stack never exceeding a depth of PyTrash_UNWIND_LEVEL.
11999 c94247b5c355 Christian Tismer's "trashcan" patch: Guido van Rossum <guido@python.org> parents: 11891 diff changeset	842 */
c94247b5c355 Christian Tismer's "trashcan" patch: Guido van Rossum <guido@python.org> parents: 11891 diff changeset	843
24420 36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	844 PyAPI_FUNC(void) _PyTrash_deposit_object(PyObject*);
36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	845 PyAPI_FUNC(void) _PyTrash_destroy_chain(void);
36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	846 PyAPI_DATA(int) _PyTrash_delete_nesting;
36e2fd3f08f7 Excise DL_IMPORT/EXPORT from object.h, and related files. This patch Mark Hammond <mhammond@skippinet.com.au> parents: 24280 diff changeset	847 PyAPI_DATA(PyObject *) _PyTrash_delete_later;
24122 d332484e394a Trashcan cleanup: Now that cyclic gc is always there, the trashcan Tim Peters <tim.peters@gmail.com> parents: 24121 diff changeset	848
11999 c94247b5c355 Christian Tismer's "trashcan" patch: Guido van Rossum <guido@python.org> parents: 11891 diff changeset	849 #define PyTrash_UNWIND_LEVEL 50
c94247b5c355 Christian Tismer's "trashcan" patch: Guido van Rossum <guido@python.org> parents: 11891 diff changeset	850
c94247b5c355 Christian Tismer's "trashcan" patch: Guido van Rossum <guido@python.org> parents: 11891 diff changeset	851 #define Py_TRASHCAN_SAFE_BEGIN(op) \
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	852 if (_PyTrash_delete_nesting < PyTrash_UNWIND_LEVEL) { \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	853 ++_PyTrash_delete_nesting;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	854 /* The body of the deallocator is here. */
11999 c94247b5c355 Christian Tismer's "trashcan" patch: Guido van Rossum <guido@python.org> parents: 11891 diff changeset	855 #define Py_TRASHCAN_SAFE_END(op) \
61467 f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	856 --_PyTrash_delete_nesting; \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	857 if (_PyTrash_delete_later && _PyTrash_delete_nesting <= 0) \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	858 _PyTrash_destroy_chain(); \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	859 } \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	860 else \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 53905 diff changeset	861 _PyTrash_deposit_object((PyObject*)op);
12481 a8898a172fe2 Christian Tismer -- total rewrite on trashcan code. Guido van Rossum <guido@python.org> parents: 12406 diff changeset	862
1329 519c25039c6a * Added support for X11 modules. Guido van Rossum <guido@python.org> parents: 1324 diff changeset	863 #ifdef __cplusplus
519c25039c6a * Added support for X11 modules. Guido van Rossum <guido@python.org> parents: 1324 diff changeset	864 }
519c25039c6a * Added support for X11 modules. Guido van Rossum <guido@python.org> parents: 1324 diff changeset	865 #endif
519c25039c6a * Added support for X11 modules. Guido van Rossum <guido@python.org> parents: 1324 diff changeset	866 #endif /* !Py_OBJECT_H */

Mercurial > cpython-lru_cache-weakref

annotate Include/object.h @ 64166:d0e9febfa00a 3.1