Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 1 | #ifndef Py_OBJECT_H |
| 2 | #define Py_OBJECT_H |
| 3 | #ifdef __cplusplus |
| 4 | extern "C" { |
| 5 | #endif |
| 6 | |
Guido van Rossum | f70e43a | 1991-02-19 12:39:46 +0000 | [diff] [blame] | 7 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 8 | /* Object and type object interface */ |
| 9 | |
| 10 | /* |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 11 | Objects are structures allocated on the heap. Special rules apply to |
| 12 | the use of objects to ensure they are properly garbage-collected. |
| 13 | Objects are never allocated statically or on the stack; they must be |
| 14 | accessed through special macros and functions only. (Type objects are |
| 15 | exceptions to the first rule; the standard types are represented by |
Tim Peters | 4be93d0 | 2002-07-07 19:59:50 +0000 | [diff] [blame] | 16 | statically initialized type objects, although work on type/class unification |
| 17 | for Python 2.2 made it possible to have heap-allocated type objects too). |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 18 | |
| 19 | An object has a 'reference count' that is increased or decreased when a |
| 20 | pointer to the object is copied or deleted; when the reference count |
| 21 | reaches zero there are no references to the object left and it can be |
| 22 | removed from the heap. |
| 23 | |
| 24 | An object has a 'type' that determines what it represents and what kind |
| 25 | of data it contains. An object's type is fixed when it is created. |
| 26 | Types themselves are represented as objects; an object contains a |
| 27 | pointer to the corresponding type object. The type itself has a type |
| 28 | pointer pointing to the object representing the type 'type', which |
| 29 | contains a pointer to itself!). |
| 30 | |
| 31 | Objects do not float around in memory; once allocated an object keeps |
| 32 | the same size and address. Objects that must hold variable-size data |
| 33 | can contain pointers to variable-size parts of the object. Not all |
| 34 | objects of the same type have the same size; but the size cannot change |
| 35 | after allocation. (These restrictions are made so a reference to an |
| 36 | object can be simply a pointer -- moving an object would require |
| 37 | updating all the pointers, and changing an object's size would require |
| 38 | moving it if there was another object right next to it.) |
| 39 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 40 | Objects are always accessed through pointers of the type 'PyObject *'. |
| 41 | The type 'PyObject' is a structure that only contains the reference count |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 42 | and the type pointer. The actual memory allocated for an object |
| 43 | contains other data that can only be accessed after casting the pointer |
| 44 | to a pointer to a longer structure type. This longer type must start |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 45 | with the reference count and type fields; the macro PyObject_HEAD should be |
Thomas Wouters | 7e47402 | 2000-07-16 12:04:32 +0000 | [diff] [blame] | 46 | used for this (to accommodate for future changes). The implementation |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 47 | of a particular object type can cast the object pointer to the proper |
| 48 | type and back. |
| 49 | |
| 50 | A standard interface exists for objects that contain an array of items |
| 51 | whose size is determined when the object is allocated. |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 52 | */ |
| 53 | |
Tim Peters | 3459251 | 2002-07-11 06:23:50 +0000 | [diff] [blame] | 54 | /* Py_DEBUG implies Py_TRACE_REFS. */ |
| 55 | #if defined(Py_DEBUG) && !defined(Py_TRACE_REFS) |
Tim Peters | 4be93d0 | 2002-07-07 19:59:50 +0000 | [diff] [blame] | 56 | #define Py_TRACE_REFS |
Tim Peters | 3459251 | 2002-07-11 06:23:50 +0000 | [diff] [blame] | 57 | #endif |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 58 | |
Tim Peters | 4be93d0 | 2002-07-07 19:59:50 +0000 | [diff] [blame] | 59 | /* Py_TRACE_REFS implies Py_REF_DEBUG. */ |
| 60 | #if defined(Py_TRACE_REFS) && !defined(Py_REF_DEBUG) |
| 61 | #define Py_REF_DEBUG |
| 62 | #endif |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 63 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 64 | #if defined(Py_LIMITED_API) && defined(Py_REF_DEBUG) |
| 65 | #error Py_LIMITED_API is incompatible with Py_DEBUG, Py_TRACE_REFS, and Py_REF_DEBUG |
| 66 | #endif |
| 67 | |
Nick Coghlan | d600951 | 2014-11-20 21:39:37 +1000 | [diff] [blame] | 68 | |
Tim Peters | 4be93d0 | 2002-07-07 19:59:50 +0000 | [diff] [blame] | 69 | #ifdef Py_TRACE_REFS |
| 70 | /* Define pointers to support a doubly-linked list of all live heap objects. */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 71 | #define _PyObject_HEAD_EXTRA \ |
| 72 | struct _object *_ob_next; \ |
| 73 | struct _object *_ob_prev; |
Tim Peters | 4be93d0 | 2002-07-07 19:59:50 +0000 | [diff] [blame] | 74 | |
| 75 | #define _PyObject_EXTRA_INIT 0, 0, |
| 76 | |
| 77 | #else |
| 78 | #define _PyObject_HEAD_EXTRA |
| 79 | #define _PyObject_EXTRA_INIT |
| 80 | #endif |
| 81 | |
| 82 | /* PyObject_HEAD defines the initial segment of every PyObject. */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 83 | #define PyObject_HEAD PyObject ob_base; |
Tim Peters | 4be93d0 | 2002-07-07 19:59:50 +0000 | [diff] [blame] | 84 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 85 | #define PyObject_HEAD_INIT(type) \ |
| 86 | { _PyObject_EXTRA_INIT \ |
| 87 | 1, type }, |
Martin v. Löwis | 9f2e346 | 2007-07-21 17:22:18 +0000 | [diff] [blame] | 88 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 89 | #define PyVarObject_HEAD_INIT(type, size) \ |
| 90 | { PyObject_HEAD_INIT(type) size }, |
Tim Peters | 4be93d0 | 2002-07-07 19:59:50 +0000 | [diff] [blame] | 91 | |
| 92 | /* PyObject_VAR_HEAD defines the initial segment of all variable-size |
| 93 | * container objects. These end with a declaration of an array with 1 |
| 94 | * element, but enough space is malloc'ed so that the array actually |
| 95 | * has room for ob_size elements. Note that ob_size is an element count, |
| 96 | * not necessarily a byte count. |
| 97 | */ |
Martin v. Löwis | 9f2e346 | 2007-07-21 17:22:18 +0000 | [diff] [blame] | 98 | #define PyObject_VAR_HEAD PyVarObject ob_base; |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 99 | #define Py_INVALID_SIZE (Py_ssize_t)-1 |
Tim Peters | 803526b | 2002-07-07 05:13:56 +0000 | [diff] [blame] | 100 | |
Tim Peters | 4be93d0 | 2002-07-07 19:59:50 +0000 | [diff] [blame] | 101 | /* Nothing is actually declared to be a PyObject, but every pointer to |
| 102 | * a Python object can be cast to a PyObject*. This is inheritance built |
| 103 | * by hand. Similarly every pointer to a variable-size Python object can, |
| 104 | * in addition, be cast to PyVarObject*. |
| 105 | */ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 106 | typedef struct _object { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 107 | _PyObject_HEAD_EXTRA |
| 108 | Py_ssize_t ob_refcnt; |
| 109 | struct _typeobject *ob_type; |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 110 | } PyObject; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 111 | |
| 112 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 113 | PyObject ob_base; |
| 114 | Py_ssize_t ob_size; /* Number of items in variable part */ |
Guido van Rossum | d0c87ee | 1997-05-15 21:31:03 +0000 | [diff] [blame] | 115 | } PyVarObject; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 116 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 117 | #define Py_REFCNT(ob) (((PyObject*)(ob))->ob_refcnt) |
| 118 | #define Py_TYPE(ob) (((PyObject*)(ob))->ob_type) |
| 119 | #define Py_SIZE(ob) (((PyVarObject*)(ob))->ob_size) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 120 | |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 121 | #ifndef Py_LIMITED_API |
Benjamin Peterson | ce79852 | 2012-01-22 11:24:29 -0500 | [diff] [blame] | 122 | /********************* String Literals ****************************************/ |
| 123 | /* This structure helps managing static strings. The basic usage goes like this: |
| 124 | Instead of doing |
| 125 | |
| 126 | r = PyObject_CallMethod(o, "foo", "args", ...); |
| 127 | |
| 128 | do |
| 129 | |
| 130 | _Py_IDENTIFIER(foo); |
| 131 | ... |
| 132 | r = _PyObject_CallMethodId(o, &PyId_foo, "args", ...); |
| 133 | |
| 134 | PyId_foo is a static variable, either on block level or file level. On first |
| 135 | usage, the string "foo" is interned, and the structures are linked. On interpreter |
| 136 | shutdown, all strings are released (through _PyUnicode_ClearStaticStrings). |
| 137 | |
Martin Panter | c04fb56 | 2016-02-10 05:44:01 +0000 | [diff] [blame] | 138 | Alternatively, _Py_static_string allows choosing the variable name. |
Benjamin Peterson | ce79852 | 2012-01-22 11:24:29 -0500 | [diff] [blame] | 139 | _PyUnicode_FromId returns a borrowed reference to the interned string. |
| 140 | _PyObject_{Get,Set,Has}AttrId are __getattr__ versions using _Py_Identifier*. |
| 141 | */ |
| 142 | typedef struct _Py_Identifier { |
| 143 | struct _Py_Identifier *next; |
| 144 | const char* string; |
| 145 | PyObject *object; |
| 146 | } _Py_Identifier; |
| 147 | |
Benjamin Peterson | 5223f08 | 2016-09-07 10:33:28 -0700 | [diff] [blame] | 148 | #define _Py_static_string_init(value) { .next = NULL, .string = value, .object = NULL } |
Victor Stinner | 0905437 | 2013-11-06 22:41:44 +0100 | [diff] [blame] | 149 | #define _Py_static_string(varname, value) static _Py_Identifier varname = _Py_static_string_init(value) |
Benjamin Peterson | ce79852 | 2012-01-22 11:24:29 -0500 | [diff] [blame] | 150 | #define _Py_IDENTIFIER(varname) _Py_static_string(PyId_##varname, #varname) |
| 151 | |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 152 | #endif /* !Py_LIMITED_API */ |
| 153 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 154 | /* |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 155 | Type objects contain a string containing the type name (to help somewhat |
Tim Peters | 4be93d0 | 2002-07-07 19:59:50 +0000 | [diff] [blame] | 156 | in debugging), the allocation parameters (see PyObject_New() and |
| 157 | PyObject_NewVar()), |
| 158 | and methods for accessing objects of the type. Methods are optional, a |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 159 | nil pointer meaning that particular kind of access is not available for |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 160 | this type. The Py_DECREF() macro uses the tp_dealloc method without |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 161 | checking for a nil pointer; it should always be implemented except if |
| 162 | the implementation can guarantee that the reference count will never |
Tim Peters | 4be93d0 | 2002-07-07 19:59:50 +0000 | [diff] [blame] | 163 | reach zero (e.g., for statically allocated type objects). |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 164 | |
| 165 | NB: the methods for certain type groups are now contained in separate |
| 166 | method blocks. |
| 167 | */ |
| 168 | |
Tim Peters | 9ace6bc | 2000-07-08 00:32:04 +0000 | [diff] [blame] | 169 | typedef PyObject * (*unaryfunc)(PyObject *); |
| 170 | typedef PyObject * (*binaryfunc)(PyObject *, PyObject *); |
| 171 | typedef PyObject * (*ternaryfunc)(PyObject *, PyObject *, PyObject *); |
| 172 | typedef int (*inquiry)(PyObject *); |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 173 | typedef Py_ssize_t (*lenfunc)(PyObject *); |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 174 | typedef PyObject *(*ssizeargfunc)(PyObject *, Py_ssize_t); |
| 175 | typedef PyObject *(*ssizessizeargfunc)(PyObject *, Py_ssize_t, Py_ssize_t); |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 176 | typedef int(*ssizeobjargproc)(PyObject *, Py_ssize_t, PyObject *); |
| 177 | typedef int(*ssizessizeobjargproc)(PyObject *, Py_ssize_t, Py_ssize_t, PyObject *); |
Tim Peters | 9ace6bc | 2000-07-08 00:32:04 +0000 | [diff] [blame] | 178 | typedef int(*objobjargproc)(PyObject *, PyObject *, PyObject *); |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 179 | |
Martin v. Löwis | c83bc3c | 2011-01-06 19:15:47 +0000 | [diff] [blame] | 180 | #ifndef Py_LIMITED_API |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 181 | /* buffer interface */ |
| 182 | typedef struct bufferinfo { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 183 | void *buf; |
| 184 | PyObject *obj; /* owned reference */ |
| 185 | Py_ssize_t len; |
| 186 | Py_ssize_t itemsize; /* This is Py_ssize_t so it can be |
| 187 | pointed to by strides in simple case.*/ |
| 188 | int readonly; |
| 189 | int ndim; |
| 190 | char *format; |
| 191 | Py_ssize_t *shape; |
| 192 | Py_ssize_t *strides; |
| 193 | Py_ssize_t *suboffsets; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 194 | void *internal; |
Travis E. Oliphant | 8ae62b6 | 2007-09-23 02:00:13 +0000 | [diff] [blame] | 195 | } Py_buffer; |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 196 | |
Travis E. Oliphant | 8ae62b6 | 2007-09-23 02:00:13 +0000 | [diff] [blame] | 197 | typedef int (*getbufferproc)(PyObject *, Py_buffer *, int); |
| 198 | typedef void (*releasebufferproc)(PyObject *, Py_buffer *); |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 199 | |
Stefan Krah | 9a2d99e | 2012-02-25 12:24:21 +0100 | [diff] [blame] | 200 | /* Maximum number of dimensions */ |
| 201 | #define PyBUF_MAX_NDIM 64 |
| 202 | |
| 203 | /* Flags for getting buffers */ |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 204 | #define PyBUF_SIMPLE 0 |
Travis E. Oliphant | ddacf96 | 2007-10-13 21:03:27 +0000 | [diff] [blame] | 205 | #define PyBUF_WRITABLE 0x0001 |
Sean Reifscheider | 54cf12b | 2007-09-17 17:55:36 +0000 | [diff] [blame] | 206 | /* we used to include an E, backwards compatible alias */ |
| 207 | #define PyBUF_WRITEABLE PyBUF_WRITABLE |
Travis E. Oliphant | ddacf96 | 2007-10-13 21:03:27 +0000 | [diff] [blame] | 208 | #define PyBUF_FORMAT 0x0004 |
| 209 | #define PyBUF_ND 0x0008 |
| 210 | #define PyBUF_STRIDES (0x0010 | PyBUF_ND) |
| 211 | #define PyBUF_C_CONTIGUOUS (0x0020 | PyBUF_STRIDES) |
| 212 | #define PyBUF_F_CONTIGUOUS (0x0040 | PyBUF_STRIDES) |
| 213 | #define PyBUF_ANY_CONTIGUOUS (0x0080 | PyBUF_STRIDES) |
| 214 | #define PyBUF_INDIRECT (0x0100 | PyBUF_STRIDES) |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 215 | |
Sean Reifscheider | 54cf12b | 2007-09-17 17:55:36 +0000 | [diff] [blame] | 216 | #define PyBUF_CONTIG (PyBUF_ND | PyBUF_WRITABLE) |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 217 | #define PyBUF_CONTIG_RO (PyBUF_ND) |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 218 | |
Sean Reifscheider | 54cf12b | 2007-09-17 17:55:36 +0000 | [diff] [blame] | 219 | #define PyBUF_STRIDED (PyBUF_STRIDES | PyBUF_WRITABLE) |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 220 | #define PyBUF_STRIDED_RO (PyBUF_STRIDES) |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 221 | |
Sean Reifscheider | 54cf12b | 2007-09-17 17:55:36 +0000 | [diff] [blame] | 222 | #define PyBUF_RECORDS (PyBUF_STRIDES | PyBUF_WRITABLE | PyBUF_FORMAT) |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 223 | #define PyBUF_RECORDS_RO (PyBUF_STRIDES | PyBUF_FORMAT) |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 224 | |
Sean Reifscheider | 54cf12b | 2007-09-17 17:55:36 +0000 | [diff] [blame] | 225 | #define PyBUF_FULL (PyBUF_INDIRECT | PyBUF_WRITABLE | PyBUF_FORMAT) |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 226 | #define PyBUF_FULL_RO (PyBUF_INDIRECT | PyBUF_FORMAT) |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 227 | |
| 228 | |
| 229 | #define PyBUF_READ 0x100 |
| 230 | #define PyBUF_WRITE 0x200 |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 231 | |
| 232 | /* End buffer interface */ |
Martin v. Löwis | c83bc3c | 2011-01-06 19:15:47 +0000 | [diff] [blame] | 233 | #endif /* Py_LIMITED_API */ |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 234 | |
Tim Peters | 9ace6bc | 2000-07-08 00:32:04 +0000 | [diff] [blame] | 235 | typedef int (*objobjproc)(PyObject *, PyObject *); |
| 236 | typedef int (*visitproc)(PyObject *, void *); |
| 237 | typedef int (*traverseproc)(PyObject *, visitproc, void *); |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 238 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 239 | #ifndef Py_LIMITED_API |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 240 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 241 | /* Number implementations must check *both* |
| 242 | arguments for proper type and implement the necessary conversions |
| 243 | in the slot functions themselves. */ |
Neil Schemenauer | a7ed694 | 2001-01-04 01:31:50 +0000 | [diff] [blame] | 244 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 245 | binaryfunc nb_add; |
| 246 | binaryfunc nb_subtract; |
| 247 | binaryfunc nb_multiply; |
| 248 | binaryfunc nb_remainder; |
| 249 | binaryfunc nb_divmod; |
| 250 | ternaryfunc nb_power; |
| 251 | unaryfunc nb_negative; |
| 252 | unaryfunc nb_positive; |
| 253 | unaryfunc nb_absolute; |
| 254 | inquiry nb_bool; |
| 255 | unaryfunc nb_invert; |
| 256 | binaryfunc nb_lshift; |
| 257 | binaryfunc nb_rshift; |
| 258 | binaryfunc nb_and; |
| 259 | binaryfunc nb_xor; |
| 260 | binaryfunc nb_or; |
| 261 | unaryfunc nb_int; |
| 262 | void *nb_reserved; /* the slot formerly known as nb_long */ |
| 263 | unaryfunc nb_float; |
Guido van Rossum | 50e9fb9 | 2006-08-17 05:42:55 +0000 | [diff] [blame] | 264 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 265 | binaryfunc nb_inplace_add; |
| 266 | binaryfunc nb_inplace_subtract; |
| 267 | binaryfunc nb_inplace_multiply; |
| 268 | binaryfunc nb_inplace_remainder; |
| 269 | ternaryfunc nb_inplace_power; |
| 270 | binaryfunc nb_inplace_lshift; |
| 271 | binaryfunc nb_inplace_rshift; |
| 272 | binaryfunc nb_inplace_and; |
| 273 | binaryfunc nb_inplace_xor; |
| 274 | binaryfunc nb_inplace_or; |
Guido van Rossum | 4668b00 | 2001-08-08 05:00:18 +0000 | [diff] [blame] | 275 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 276 | binaryfunc nb_floor_divide; |
| 277 | binaryfunc nb_true_divide; |
| 278 | binaryfunc nb_inplace_floor_divide; |
| 279 | binaryfunc nb_inplace_true_divide; |
Guido van Rossum | 38fff8c | 2006-03-07 18:50:55 +0000 | [diff] [blame] | 280 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 281 | unaryfunc nb_index; |
Benjamin Peterson | d51374e | 2014-04-09 23:55:56 -0400 | [diff] [blame] | 282 | |
| 283 | binaryfunc nb_matrix_multiply; |
| 284 | binaryfunc nb_inplace_matrix_multiply; |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 285 | } PyNumberMethods; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 286 | |
| 287 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 288 | lenfunc sq_length; |
| 289 | binaryfunc sq_concat; |
| 290 | ssizeargfunc sq_repeat; |
| 291 | ssizeargfunc sq_item; |
| 292 | void *was_sq_slice; |
| 293 | ssizeobjargproc sq_ass_item; |
| 294 | void *was_sq_ass_slice; |
| 295 | objobjproc sq_contains; |
Guido van Rossum | 50e9fb9 | 2006-08-17 05:42:55 +0000 | [diff] [blame] | 296 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 297 | binaryfunc sq_inplace_concat; |
| 298 | ssizeargfunc sq_inplace_repeat; |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 299 | } PySequenceMethods; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 300 | |
| 301 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 302 | lenfunc mp_length; |
| 303 | binaryfunc mp_subscript; |
| 304 | objobjargproc mp_ass_subscript; |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 305 | } PyMappingMethods; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 306 | |
Yury Selivanov | 7544508 | 2015-05-11 22:57:16 -0400 | [diff] [blame] | 307 | typedef struct { |
Yury Selivanov | 6ef0590 | 2015-05-28 11:21:31 -0400 | [diff] [blame] | 308 | unaryfunc am_await; |
| 309 | unaryfunc am_aiter; |
| 310 | unaryfunc am_anext; |
Yury Selivanov | 7544508 | 2015-05-11 22:57:16 -0400 | [diff] [blame] | 311 | } PyAsyncMethods; |
Tim Peters | 803526b | 2002-07-07 05:13:56 +0000 | [diff] [blame] | 312 | |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 313 | typedef struct { |
| 314 | getbufferproc bf_getbuffer; |
| 315 | releasebufferproc bf_releasebuffer; |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 316 | } PyBufferProcs; |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 317 | #endif /* Py_LIMITED_API */ |
Guido van Rossum | fdf95dd | 1997-05-05 22:15:02 +0000 | [diff] [blame] | 318 | |
Neil Schemenauer | f6d1ea1 | 2002-04-12 01:57:06 +0000 | [diff] [blame] | 319 | typedef void (*freefunc)(void *); |
Tim Peters | 9ace6bc | 2000-07-08 00:32:04 +0000 | [diff] [blame] | 320 | typedef void (*destructor)(PyObject *); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 321 | #ifndef Py_LIMITED_API |
| 322 | /* We can't provide a full compile-time check that limited-API |
| 323 | users won't implement tp_print. However, not defining printfunc |
| 324 | and making tp_print of a different function pointer type |
| 325 | should at least cause a warning in most cases. */ |
Tim Peters | 9ace6bc | 2000-07-08 00:32:04 +0000 | [diff] [blame] | 326 | typedef int (*printfunc)(PyObject *, FILE *, int); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 327 | #endif |
Martin v. Löwis | 15e6274 | 2006-02-27 16:46:16 +0000 | [diff] [blame] | 328 | typedef PyObject *(*getattrfunc)(PyObject *, char *); |
Tim Peters | 9ace6bc | 2000-07-08 00:32:04 +0000 | [diff] [blame] | 329 | typedef PyObject *(*getattrofunc)(PyObject *, PyObject *); |
Martin v. Löwis | 15e6274 | 2006-02-27 16:46:16 +0000 | [diff] [blame] | 330 | typedef int (*setattrfunc)(PyObject *, char *, PyObject *); |
Tim Peters | 9ace6bc | 2000-07-08 00:32:04 +0000 | [diff] [blame] | 331 | typedef int (*setattrofunc)(PyObject *, PyObject *, PyObject *); |
Tim Peters | 9ace6bc | 2000-07-08 00:32:04 +0000 | [diff] [blame] | 332 | typedef PyObject *(*reprfunc)(PyObject *); |
Benjamin Peterson | 8f67d08 | 2010-10-17 20:54:53 +0000 | [diff] [blame] | 333 | typedef Py_hash_t (*hashfunc)(PyObject *); |
Guido van Rossum | 5f284ce | 2001-01-17 15:20:39 +0000 | [diff] [blame] | 334 | typedef PyObject *(*richcmpfunc) (PyObject *, PyObject *, int); |
Guido van Rossum | 59d1d2b | 2001-04-20 19:13:02 +0000 | [diff] [blame] | 335 | typedef PyObject *(*getiterfunc) (PyObject *); |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 336 | typedef PyObject *(*iternextfunc) (PyObject *); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 337 | typedef PyObject *(*descrgetfunc) (PyObject *, PyObject *, PyObject *); |
| 338 | typedef int (*descrsetfunc) (PyObject *, PyObject *, PyObject *); |
| 339 | typedef int (*initproc)(PyObject *, PyObject *, PyObject *); |
| 340 | typedef PyObject *(*newfunc)(struct _typeobject *, PyObject *, PyObject *); |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 341 | typedef PyObject *(*allocfunc)(struct _typeobject *, Py_ssize_t); |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 342 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 343 | #ifdef Py_LIMITED_API |
| 344 | typedef struct _typeobject PyTypeObject; /* opaque */ |
| 345 | #else |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 346 | typedef struct _typeobject { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 347 | PyObject_VAR_HEAD |
| 348 | const char *tp_name; /* For printing, in format "<module>.<name>" */ |
| 349 | Py_ssize_t tp_basicsize, tp_itemsize; /* For allocation */ |
Tim Peters | 803526b | 2002-07-07 05:13:56 +0000 | [diff] [blame] | 350 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 351 | /* Methods to implement standard operations */ |
Tim Peters | 803526b | 2002-07-07 05:13:56 +0000 | [diff] [blame] | 352 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 353 | destructor tp_dealloc; |
| 354 | printfunc tp_print; |
| 355 | getattrfunc tp_getattr; |
| 356 | setattrfunc tp_setattr; |
Yury Selivanov | beaa509 | 2015-08-26 13:03:57 -0400 | [diff] [blame] | 357 | PyAsyncMethods *tp_as_async; /* formerly known as tp_compare (Python 2) |
| 358 | or tp_reserved (Python 3) */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 359 | reprfunc tp_repr; |
Tim Peters | 803526b | 2002-07-07 05:13:56 +0000 | [diff] [blame] | 360 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 361 | /* Method suites for standard classes */ |
Tim Peters | 803526b | 2002-07-07 05:13:56 +0000 | [diff] [blame] | 362 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 363 | PyNumberMethods *tp_as_number; |
| 364 | PySequenceMethods *tp_as_sequence; |
| 365 | PyMappingMethods *tp_as_mapping; |
Guido van Rossum | 9bfef44 | 1993-03-29 10:43:31 +0000 | [diff] [blame] | 366 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 367 | /* More standard operations (here for binary compatibility) */ |
Guido van Rossum | 9bfef44 | 1993-03-29 10:43:31 +0000 | [diff] [blame] | 368 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 369 | hashfunc tp_hash; |
| 370 | ternaryfunc tp_call; |
| 371 | reprfunc tp_str; |
| 372 | getattrofunc tp_getattro; |
| 373 | setattrofunc tp_setattro; |
Guido van Rossum | 6fde390 | 1995-01-07 10:32:04 +0000 | [diff] [blame] | 374 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 375 | /* Functions to access object as input/output buffer */ |
| 376 | PyBufferProcs *tp_as_buffer; |
Tim Peters | 803526b | 2002-07-07 05:13:56 +0000 | [diff] [blame] | 377 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 378 | /* Flags to define presence of optional/expanded features */ |
Victor Stinner | 4ca1cf3 | 2012-10-30 23:40:45 +0100 | [diff] [blame] | 379 | unsigned long tp_flags; |
Guido van Rossum | 6fde390 | 1995-01-07 10:32:04 +0000 | [diff] [blame] | 380 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 381 | const char *tp_doc; /* Documentation string */ |
Guido van Rossum | 6fde390 | 1995-01-07 10:32:04 +0000 | [diff] [blame] | 382 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 383 | /* Assigned meaning in release 2.0 */ |
| 384 | /* call function for all accessible objects */ |
| 385 | traverseproc tp_traverse; |
Tim Peters | 803526b | 2002-07-07 05:13:56 +0000 | [diff] [blame] | 386 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 387 | /* delete references to contained objects */ |
| 388 | inquiry tp_clear; |
Jeremy Hylton | 8caad49 | 2000-06-23 14:18:11 +0000 | [diff] [blame] | 389 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 390 | /* Assigned meaning in release 2.1 */ |
| 391 | /* rich comparisons */ |
| 392 | richcmpfunc tp_richcompare; |
Guido van Rossum | 5f284ce | 2001-01-17 15:20:39 +0000 | [diff] [blame] | 393 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 394 | /* weak reference enabler */ |
| 395 | Py_ssize_t tp_weaklistoffset; |
Guido van Rossum | a9c2d7a | 1998-04-23 19:16:44 +0000 | [diff] [blame] | 396 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 397 | /* Iterators */ |
| 398 | getiterfunc tp_iter; |
| 399 | iternextfunc tp_iternext; |
Guido van Rossum | 59d1d2b | 2001-04-20 19:13:02 +0000 | [diff] [blame] | 400 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 401 | /* Attribute descriptor and subclassing stuff */ |
| 402 | struct PyMethodDef *tp_methods; |
| 403 | struct PyMemberDef *tp_members; |
| 404 | struct PyGetSetDef *tp_getset; |
| 405 | struct _typeobject *tp_base; |
| 406 | PyObject *tp_dict; |
| 407 | descrgetfunc tp_descr_get; |
| 408 | descrsetfunc tp_descr_set; |
| 409 | Py_ssize_t tp_dictoffset; |
| 410 | initproc tp_init; |
| 411 | allocfunc tp_alloc; |
| 412 | newfunc tp_new; |
| 413 | freefunc tp_free; /* Low-level free-memory routine */ |
| 414 | inquiry tp_is_gc; /* For PyObject_IS_GC */ |
| 415 | PyObject *tp_bases; |
| 416 | PyObject *tp_mro; /* method resolution order */ |
| 417 | PyObject *tp_cache; |
| 418 | PyObject *tp_subclasses; |
| 419 | PyObject *tp_weaklist; |
| 420 | destructor tp_del; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 421 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 422 | /* Type attribute cache version tag. Added in version 2.6 */ |
| 423 | unsigned int tp_version_tag; |
Christian Heimes | a62da1d | 2008-01-12 19:39:10 +0000 | [diff] [blame] | 424 | |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 425 | destructor tp_finalize; |
| 426 | |
Sjoerd Mullender | a9c3c22 | 1993-10-11 12:54:31 +0000 | [diff] [blame] | 427 | #ifdef COUNT_ALLOCS |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 428 | /* these must be last and never explicitly initialized */ |
| 429 | Py_ssize_t tp_allocs; |
| 430 | Py_ssize_t tp_frees; |
| 431 | Py_ssize_t tp_maxalloc; |
| 432 | struct _typeobject *tp_prev; |
| 433 | struct _typeobject *tp_next; |
Sjoerd Mullender | a9c3c22 | 1993-10-11 12:54:31 +0000 | [diff] [blame] | 434 | #endif |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 435 | } PyTypeObject; |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 436 | #endif |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 437 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 438 | typedef struct{ |
| 439 | int slot; /* slot id, see below */ |
| 440 | void *pfunc; /* function pointer */ |
| 441 | } PyType_Slot; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 442 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 443 | typedef struct{ |
| 444 | const char* name; |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 445 | int basicsize; |
| 446 | int itemsize; |
Victor Stinner | 4ca1cf3 | 2012-10-30 23:40:45 +0100 | [diff] [blame] | 447 | unsigned int flags; |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 448 | PyType_Slot *slots; /* terminated by slot==0. */ |
| 449 | } PyType_Spec; |
| 450 | |
| 451 | PyAPI_FUNC(PyObject*) PyType_FromSpec(PyType_Spec*); |
Martin v. Löwis | 9c56409 | 2012-06-23 23:20:45 +0200 | [diff] [blame] | 452 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000 |
| 453 | PyAPI_FUNC(PyObject*) PyType_FromSpecWithBases(PyType_Spec*, PyObject*); |
| 454 | #endif |
Martin v. Löwis | ca7b046 | 2014-02-04 09:33:05 +0100 | [diff] [blame] | 455 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03040000 |
| 456 | PyAPI_FUNC(void*) PyType_GetSlot(PyTypeObject*, int); |
| 457 | #endif |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 458 | |
| 459 | #ifndef Py_LIMITED_API |
Guido van Rossum | e5c691a | 2003-03-07 15:13:17 +0000 | [diff] [blame] | 460 | /* The *real* layout of a type object when allocated on the heap */ |
| 461 | typedef struct _heaptypeobject { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 462 | /* Note: there's a dependency on the order of these members |
| 463 | in slotptr() in typeobject.c . */ |
| 464 | PyTypeObject ht_type; |
Yury Selivanov | 7544508 | 2015-05-11 22:57:16 -0400 | [diff] [blame] | 465 | PyAsyncMethods as_async; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 466 | PyNumberMethods as_number; |
| 467 | PyMappingMethods as_mapping; |
| 468 | PySequenceMethods as_sequence; /* as_sequence comes after as_mapping, |
| 469 | so that the mapping wins when both |
| 470 | the mapping and the sequence define |
| 471 | a given operator (e.g. __getitem__). |
| 472 | see add_operators() in typeobject.c . */ |
| 473 | PyBufferProcs as_buffer; |
Antoine Pitrou | 86a36b5 | 2011-11-25 18:56:07 +0100 | [diff] [blame] | 474 | PyObject *ht_name, *ht_slots, *ht_qualname; |
Benjamin Peterson | 7d95e40 | 2012-04-23 11:24:50 -0400 | [diff] [blame] | 475 | struct _dictkeysobject *ht_cached_keys; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 476 | /* here are optional user slots, followed by the members. */ |
Guido van Rossum | e5c691a | 2003-03-07 15:13:17 +0000 | [diff] [blame] | 477 | } PyHeapTypeObject; |
| 478 | |
| 479 | /* access macro to the members which are floating "behind" the object */ |
| 480 | #define PyHeapType_GET_MEMBERS(etype) \ |
Christian Heimes | 90aa764 | 2007-12-19 02:45:37 +0000 | [diff] [blame] | 481 | ((PyMemberDef *)(((char *)etype) + Py_TYPE(etype)->tp_basicsize)) |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 482 | #endif |
Guido van Rossum | e5c691a | 2003-03-07 15:13:17 +0000 | [diff] [blame] | 483 | |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 484 | /* Generic type check */ |
Mark Hammond | a290527 | 2002-07-29 13:42:14 +0000 | [diff] [blame] | 485 | PyAPI_FUNC(int) PyType_IsSubtype(PyTypeObject *, PyTypeObject *); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 486 | #define PyObject_TypeCheck(ob, tp) \ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 487 | (Py_TYPE(ob) == (tp) || PyType_IsSubtype(Py_TYPE(ob), (tp))) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 488 | |
Mark Hammond | a290527 | 2002-07-29 13:42:14 +0000 | [diff] [blame] | 489 | PyAPI_DATA(PyTypeObject) PyType_Type; /* built-in 'type' */ |
| 490 | PyAPI_DATA(PyTypeObject) PyBaseObject_Type; /* built-in 'object' */ |
| 491 | PyAPI_DATA(PyTypeObject) PySuper_Type; /* built-in 'super' */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 492 | |
Victor Stinner | 4ca1cf3 | 2012-10-30 23:40:45 +0100 | [diff] [blame] | 493 | PyAPI_FUNC(unsigned long) PyType_GetFlags(PyTypeObject*); |
Martin v. Löwis | 738236d | 2011-02-05 20:35:29 +0000 | [diff] [blame] | 494 | |
Thomas Wouters | 27d517b | 2007-02-25 20:39:11 +0000 | [diff] [blame] | 495 | #define PyType_Check(op) \ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 496 | PyType_FastSubclass(Py_TYPE(op), Py_TPFLAGS_TYPE_SUBCLASS) |
Christian Heimes | 90aa764 | 2007-12-19 02:45:37 +0000 | [diff] [blame] | 497 | #define PyType_CheckExact(op) (Py_TYPE(op) == &PyType_Type) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 498 | |
Mark Hammond | a290527 | 2002-07-29 13:42:14 +0000 | [diff] [blame] | 499 | PyAPI_FUNC(int) PyType_Ready(PyTypeObject *); |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 500 | PyAPI_FUNC(PyObject *) PyType_GenericAlloc(PyTypeObject *, Py_ssize_t); |
Mark Hammond | a290527 | 2002-07-29 13:42:14 +0000 | [diff] [blame] | 501 | PyAPI_FUNC(PyObject *) PyType_GenericNew(PyTypeObject *, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 502 | PyObject *, PyObject *); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 503 | #ifndef Py_LIMITED_API |
Serhiy Storchaka | 4ab46d7 | 2017-09-17 21:11:04 +0300 | [diff] [blame] | 504 | PyAPI_FUNC(const char *) _PyType_Name(PyTypeObject *); |
Mark Hammond | a290527 | 2002-07-29 13:42:14 +0000 | [diff] [blame] | 505 | PyAPI_FUNC(PyObject *) _PyType_Lookup(PyTypeObject *, PyObject *); |
Raymond Hettinger | 2ff2190 | 2013-10-01 00:55:43 -0700 | [diff] [blame] | 506 | PyAPI_FUNC(PyObject *) _PyType_LookupId(PyTypeObject *, _Py_Identifier *); |
Benjamin Peterson | ce79852 | 2012-01-22 11:24:29 -0500 | [diff] [blame] | 507 | PyAPI_FUNC(PyObject *) _PyObject_LookupSpecial(PyObject *, _Py_Identifier *); |
Nick Coghlan | de31b19 | 2011-10-23 22:04:16 +1000 | [diff] [blame] | 508 | PyAPI_FUNC(PyTypeObject *) _PyType_CalculateMetaclass(PyTypeObject *, PyObject *); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 509 | #endif |
Christian Heimes | 2685563 | 2008-01-27 23:50:43 +0000 | [diff] [blame] | 510 | PyAPI_FUNC(unsigned int) PyType_ClearCache(void); |
Georg Brandl | f08a9dd | 2008-06-10 16:57:31 +0000 | [diff] [blame] | 511 | PyAPI_FUNC(void) PyType_Modified(PyTypeObject *); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 512 | |
Larry Hastings | c204726 | 2014-01-25 20:43:29 -0800 | [diff] [blame] | 513 | #ifndef Py_LIMITED_API |
Larry Hastings | 2623c8c | 2014-02-08 22:15:29 -0800 | [diff] [blame] | 514 | PyAPI_FUNC(PyObject *) _PyType_GetDocFromInternalDoc(const char *, const char *); |
| 515 | PyAPI_FUNC(PyObject *) _PyType_GetTextSignatureFromInternalDoc(const char *, const char *); |
Larry Hastings | c204726 | 2014-01-25 20:43:29 -0800 | [diff] [blame] | 516 | #endif |
Larry Hastings | 5c66189 | 2014-01-24 06:17:25 -0800 | [diff] [blame] | 517 | |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 518 | /* Generic operations on objects */ |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 519 | #ifndef Py_LIMITED_API |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 520 | struct _Py_Identifier; |
Mark Hammond | a290527 | 2002-07-29 13:42:14 +0000 | [diff] [blame] | 521 | PyAPI_FUNC(int) PyObject_Print(PyObject *, FILE *, int); |
Thomas Wouters | b213704 | 2007-02-01 18:02:27 +0000 | [diff] [blame] | 522 | PyAPI_FUNC(void) _Py_BreakPoint(void); |
Mark Hammond | a290527 | 2002-07-29 13:42:14 +0000 | [diff] [blame] | 523 | PyAPI_FUNC(void) _PyObject_Dump(PyObject *); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 524 | #endif |
Mark Hammond | a290527 | 2002-07-29 13:42:14 +0000 | [diff] [blame] | 525 | PyAPI_FUNC(PyObject *) PyObject_Repr(PyObject *); |
| 526 | PyAPI_FUNC(PyObject *) PyObject_Str(PyObject *); |
Georg Brandl | 559e5d7 | 2008-06-11 18:37:52 +0000 | [diff] [blame] | 527 | PyAPI_FUNC(PyObject *) PyObject_ASCII(PyObject *); |
Benjamin Peterson | c15a073 | 2008-08-26 16:46:47 +0000 | [diff] [blame] | 528 | PyAPI_FUNC(PyObject *) PyObject_Bytes(PyObject *); |
Mark Hammond | a290527 | 2002-07-29 13:42:14 +0000 | [diff] [blame] | 529 | PyAPI_FUNC(PyObject *) PyObject_RichCompare(PyObject *, PyObject *, int); |
| 530 | PyAPI_FUNC(int) PyObject_RichCompareBool(PyObject *, PyObject *, int); |
Jeremy Hylton | af68c87 | 2005-12-10 18:50:16 +0000 | [diff] [blame] | 531 | PyAPI_FUNC(PyObject *) PyObject_GetAttrString(PyObject *, const char *); |
| 532 | PyAPI_FUNC(int) PyObject_SetAttrString(PyObject *, const char *, PyObject *); |
| 533 | PyAPI_FUNC(int) PyObject_HasAttrString(PyObject *, const char *); |
Mark Hammond | a290527 | 2002-07-29 13:42:14 +0000 | [diff] [blame] | 534 | PyAPI_FUNC(PyObject *) PyObject_GetAttr(PyObject *, PyObject *); |
| 535 | PyAPI_FUNC(int) PyObject_SetAttr(PyObject *, PyObject *, PyObject *); |
| 536 | PyAPI_FUNC(int) PyObject_HasAttr(PyObject *, PyObject *); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 537 | #ifndef Py_LIMITED_API |
Benjamin Peterson | bfebb7b | 2011-12-15 15:34:02 -0500 | [diff] [blame] | 538 | PyAPI_FUNC(int) _PyObject_IsAbstract(PyObject *); |
Martin v. Löwis | afe55bb | 2011-10-09 10:38:36 +0200 | [diff] [blame] | 539 | PyAPI_FUNC(PyObject *) _PyObject_GetAttrId(PyObject *, struct _Py_Identifier *); |
| 540 | PyAPI_FUNC(int) _PyObject_SetAttrId(PyObject *, struct _Py_Identifier *, PyObject *); |
| 541 | PyAPI_FUNC(int) _PyObject_HasAttrId(PyObject *, struct _Py_Identifier *); |
Serhiy Storchaka | f320be7 | 2018-01-25 10:49:40 +0200 | [diff] [blame^] | 542 | /* Replacements of PyObject_GetAttr() and _PyObject_GetAttrId() which |
| 543 | don't raise AttributeError. |
| 544 | |
| 545 | Return 1 and set *result != NULL if an attribute is found. |
| 546 | Return 0 and set *result == NULL if an attribute is not found; |
| 547 | an AttributeError is silenced. |
| 548 | Return -1 and set *result == NULL if an error other than AttributeError |
| 549 | is raised. |
| 550 | */ |
| 551 | PyAPI_FUNC(int) _PyObject_LookupAttr(PyObject *, PyObject *, PyObject **); |
| 552 | PyAPI_FUNC(int) _PyObject_LookupAttrId(PyObject *, struct _Py_Identifier *, PyObject **); |
Mark Hammond | a290527 | 2002-07-29 13:42:14 +0000 | [diff] [blame] | 553 | PyAPI_FUNC(PyObject **) _PyObject_GetDictPtr(PyObject *); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 554 | #endif |
Raymond Hettinger | 1da1dbf | 2003-03-17 19:46:11 +0000 | [diff] [blame] | 555 | PyAPI_FUNC(PyObject *) PyObject_SelfIter(PyObject *); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 556 | #ifndef Py_LIMITED_API |
Amaury Forgeot d'Arc | f343e01 | 2009-01-12 23:58:21 +0000 | [diff] [blame] | 557 | PyAPI_FUNC(PyObject *) _PyObject_NextNotImplemented(PyObject *); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 558 | #endif |
Mark Hammond | a290527 | 2002-07-29 13:42:14 +0000 | [diff] [blame] | 559 | PyAPI_FUNC(PyObject *) PyObject_GenericGetAttr(PyObject *, PyObject *); |
| 560 | PyAPI_FUNC(int) PyObject_GenericSetAttr(PyObject *, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 561 | PyObject *, PyObject *); |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 562 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000 |
Benjamin Peterson | 8eb1269 | 2012-02-19 19:59:10 -0500 | [diff] [blame] | 563 | PyAPI_FUNC(int) PyObject_GenericSetDict(PyObject *, PyObject *, void *); |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 564 | #endif |
Benjamin Peterson | 8f67d08 | 2010-10-17 20:54:53 +0000 | [diff] [blame] | 565 | PyAPI_FUNC(Py_hash_t) PyObject_Hash(PyObject *); |
| 566 | PyAPI_FUNC(Py_hash_t) PyObject_HashNotImplemented(PyObject *); |
Mark Hammond | a290527 | 2002-07-29 13:42:14 +0000 | [diff] [blame] | 567 | PyAPI_FUNC(int) PyObject_IsTrue(PyObject *); |
| 568 | PyAPI_FUNC(int) PyObject_Not(PyObject *); |
| 569 | PyAPI_FUNC(int) PyCallable_Check(PyObject *); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 570 | |
Mark Hammond | a290527 | 2002-07-29 13:42:14 +0000 | [diff] [blame] | 571 | PyAPI_FUNC(void) PyObject_ClearWeakRefs(PyObject *); |
Martin v. Löwis | 1c0689c | 2014-01-03 21:36:49 +0100 | [diff] [blame] | 572 | #ifndef Py_LIMITED_API |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 573 | PyAPI_FUNC(void) PyObject_CallFinalizer(PyObject *); |
| 574 | PyAPI_FUNC(int) PyObject_CallFinalizerFromDealloc(PyObject *); |
Martin v. Löwis | 1c0689c | 2014-01-03 21:36:49 +0100 | [diff] [blame] | 575 | #endif |
Fred Drake | 41deb1e | 2001-02-01 05:27:45 +0000 | [diff] [blame] | 576 | |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 577 | #ifndef Py_LIMITED_API |
Antoine Pitrou | 1a9a9d5 | 2010-08-28 18:17:03 +0000 | [diff] [blame] | 578 | /* Same as PyObject_Generic{Get,Set}Attr, but passing the attributes |
| 579 | dict as the last parameter. */ |
| 580 | PyAPI_FUNC(PyObject *) |
INADA Naoki | 378edee | 2018-01-16 20:52:41 +0900 | [diff] [blame] | 581 | _PyObject_GenericGetAttrWithDict(PyObject *, PyObject *, PyObject *, int); |
Antoine Pitrou | 1a9a9d5 | 2010-08-28 18:17:03 +0000 | [diff] [blame] | 582 | PyAPI_FUNC(int) |
| 583 | _PyObject_GenericSetAttrWithDict(PyObject *, PyObject *, |
| 584 | PyObject *, PyObject *); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 585 | #endif /* !Py_LIMITED_API */ |
Antoine Pitrou | 1a9a9d5 | 2010-08-28 18:17:03 +0000 | [diff] [blame] | 586 | |
Antoine Pitrou | a701388 | 2012-04-05 00:04:20 +0200 | [diff] [blame] | 587 | /* Helper to look up a builtin object */ |
| 588 | #ifndef Py_LIMITED_API |
| 589 | PyAPI_FUNC(PyObject *) |
| 590 | _PyObject_GetBuiltin(const char *name); |
| 591 | #endif |
Guido van Rossum | ab3b034 | 2001-09-18 20:38:53 +0000 | [diff] [blame] | 592 | |
Georg Brandl | 1a3284e | 2007-12-02 09:40:06 +0000 | [diff] [blame] | 593 | /* PyObject_Dir(obj) acts like Python builtins.dir(obj), returning a |
| 594 | list of strings. PyObject_Dir(NULL) is like builtins.dir(), |
Tim Peters | 7eea37e | 2001-09-04 22:08:56 +0000 | [diff] [blame] | 595 | returning the names of the current locals. In this case, if there are |
| 596 | no current locals, NULL is returned, and PyErr_Occurred() is false. |
| 597 | */ |
Mark Hammond | a290527 | 2002-07-29 13:42:14 +0000 | [diff] [blame] | 598 | PyAPI_FUNC(PyObject *) PyObject_Dir(PyObject *); |
Tim Peters | 7eea37e | 2001-09-04 22:08:56 +0000 | [diff] [blame] | 599 | |
| 600 | |
Guido van Rossum | 26d4ac3 | 1998-04-10 22:32:24 +0000 | [diff] [blame] | 601 | /* Helpers for printing recursive container types */ |
Mark Hammond | a290527 | 2002-07-29 13:42:14 +0000 | [diff] [blame] | 602 | PyAPI_FUNC(int) Py_ReprEnter(PyObject *); |
| 603 | PyAPI_FUNC(void) Py_ReprLeave(PyObject *); |
Guido van Rossum | 26d4ac3 | 1998-04-10 22:32:24 +0000 | [diff] [blame] | 604 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 605 | /* Flag bits for printing: */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 606 | #define Py_PRINT_RAW 1 /* No string quotes etc. */ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 607 | |
| 608 | /* |
Tim Peters | 4be93d0 | 2002-07-07 19:59:50 +0000 | [diff] [blame] | 609 | `Type flags (tp_flags) |
Guido van Rossum | 36eef3c | 1998-10-08 02:10:56 +0000 | [diff] [blame] | 610 | |
| 611 | These flags are used to extend the type structure in a backwards-compatible |
| 612 | fashion. Extensions can use the flags to indicate (and test) when a given |
| 613 | type structure contains a new feature. The Python core will use these when |
| 614 | introducing new functionality between major revisions (to avoid mid-version |
| 615 | changes in the PYTHON_API_VERSION). |
| 616 | |
| 617 | Arbitration of the flag bit positions will need to be coordinated among |
luzpaz | a5293b4 | 2017-11-05 07:37:50 -0600 | [diff] [blame] | 618 | all extension writers who publicly release their extensions (this will |
Guido van Rossum | 36eef3c | 1998-10-08 02:10:56 +0000 | [diff] [blame] | 619 | be fewer than you might expect!).. |
| 620 | |
Guido van Rossum | 3cf5b1e | 2006-07-27 21:53:35 +0000 | [diff] [blame] | 621 | Most flags were removed as of Python 3.0 to make room for new flags. (Some |
| 622 | flags are not for backwards compatibility but to indicate the presence of an |
| 623 | optional feature; these flags remain of course.) |
Guido van Rossum | 36eef3c | 1998-10-08 02:10:56 +0000 | [diff] [blame] | 624 | |
| 625 | Type definitions should use Py_TPFLAGS_DEFAULT for their tp_flags value. |
| 626 | |
| 627 | Code can use PyType_HasFeature(type_ob, flag_value) to test whether the |
| 628 | given type object has a specified feature. |
Guido van Rossum | 36eef3c | 1998-10-08 02:10:56 +0000 | [diff] [blame] | 629 | */ |
| 630 | |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 631 | /* Set if the type object is dynamically allocated */ |
Victor Stinner | 4ca1cf3 | 2012-10-30 23:40:45 +0100 | [diff] [blame] | 632 | #define Py_TPFLAGS_HEAPTYPE (1UL << 9) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 633 | |
| 634 | /* Set if the type allows subclassing */ |
Victor Stinner | 4ca1cf3 | 2012-10-30 23:40:45 +0100 | [diff] [blame] | 635 | #define Py_TPFLAGS_BASETYPE (1UL << 10) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 636 | |
Guido van Rossum | 9b9c972 | 2001-08-10 17:37:02 +0000 | [diff] [blame] | 637 | /* Set if the type is 'ready' -- fully initialized */ |
Victor Stinner | 4ca1cf3 | 2012-10-30 23:40:45 +0100 | [diff] [blame] | 638 | #define Py_TPFLAGS_READY (1UL << 12) |
Guido van Rossum | 9b9c972 | 2001-08-10 17:37:02 +0000 | [diff] [blame] | 639 | |
| 640 | /* Set while the type is being 'readied', to prevent recursive ready calls */ |
Victor Stinner | 4ca1cf3 | 2012-10-30 23:40:45 +0100 | [diff] [blame] | 641 | #define Py_TPFLAGS_READYING (1UL << 13) |
Guido van Rossum | 9b9c972 | 2001-08-10 17:37:02 +0000 | [diff] [blame] | 642 | |
Neil Schemenauer | 31ec142 | 2001-08-29 23:46:35 +0000 | [diff] [blame] | 643 | /* Objects support garbage collection (see objimp.h) */ |
Victor Stinner | 4ca1cf3 | 2012-10-30 23:40:45 +0100 | [diff] [blame] | 644 | #define Py_TPFLAGS_HAVE_GC (1UL << 14) |
Neil Schemenauer | 31ec142 | 2001-08-29 23:46:35 +0000 | [diff] [blame] | 645 | |
Guido van Rossum | 38fff8c | 2006-03-07 18:50:55 +0000 | [diff] [blame] | 646 | /* These two bits are preserved for Stackless Python, next after this is 17 */ |
Christian Tismer | 6695ba8 | 2003-05-20 15:14:31 +0000 | [diff] [blame] | 647 | #ifdef STACKLESS |
Victor Stinner | 4ca1cf3 | 2012-10-30 23:40:45 +0100 | [diff] [blame] | 648 | #define Py_TPFLAGS_HAVE_STACKLESS_EXTENSION (3UL << 15) |
Christian Tismer | 6695ba8 | 2003-05-20 15:14:31 +0000 | [diff] [blame] | 649 | #else |
Christian Tismer | c26ff41 | 2003-05-23 03:33:35 +0000 | [diff] [blame] | 650 | #define Py_TPFLAGS_HAVE_STACKLESS_EXTENSION 0 |
Christian Tismer | 6695ba8 | 2003-05-20 15:14:31 +0000 | [diff] [blame] | 651 | #endif |
| 652 | |
Christian Heimes | a62da1d | 2008-01-12 19:39:10 +0000 | [diff] [blame] | 653 | /* Objects support type attribute cache */ |
Victor Stinner | 4ca1cf3 | 2012-10-30 23:40:45 +0100 | [diff] [blame] | 654 | #define Py_TPFLAGS_HAVE_VERSION_TAG (1UL << 18) |
| 655 | #define Py_TPFLAGS_VALID_VERSION_TAG (1UL << 19) |
Christian Heimes | a62da1d | 2008-01-12 19:39:10 +0000 | [diff] [blame] | 656 | |
Christian Heimes | 9e7f1d2 | 2008-02-28 12:27:11 +0000 | [diff] [blame] | 657 | /* Type is abstract and cannot be instantiated */ |
Victor Stinner | 4ca1cf3 | 2012-10-30 23:40:45 +0100 | [diff] [blame] | 658 | #define Py_TPFLAGS_IS_ABSTRACT (1UL << 20) |
Christian Heimes | 9e7f1d2 | 2008-02-28 12:27:11 +0000 | [diff] [blame] | 659 | |
Thomas Wouters | 27d517b | 2007-02-25 20:39:11 +0000 | [diff] [blame] | 660 | /* These flags are used to determine if a type is a subclass. */ |
Victor Stinner | 4ca1cf3 | 2012-10-30 23:40:45 +0100 | [diff] [blame] | 661 | #define Py_TPFLAGS_LONG_SUBCLASS (1UL << 24) |
| 662 | #define Py_TPFLAGS_LIST_SUBCLASS (1UL << 25) |
| 663 | #define Py_TPFLAGS_TUPLE_SUBCLASS (1UL << 26) |
| 664 | #define Py_TPFLAGS_BYTES_SUBCLASS (1UL << 27) |
| 665 | #define Py_TPFLAGS_UNICODE_SUBCLASS (1UL << 28) |
| 666 | #define Py_TPFLAGS_DICT_SUBCLASS (1UL << 29) |
| 667 | #define Py_TPFLAGS_BASE_EXC_SUBCLASS (1UL << 30) |
| 668 | #define Py_TPFLAGS_TYPE_SUBCLASS (1UL << 31) |
Thomas Wouters | 27d517b | 2007-02-25 20:39:11 +0000 | [diff] [blame] | 669 | |
Guido van Rossum | bacca54 | 2001-01-24 22:13:48 +0000 | [diff] [blame] | 670 | #define Py_TPFLAGS_DEFAULT ( \ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 671 | Py_TPFLAGS_HAVE_STACKLESS_EXTENSION | \ |
| 672 | Py_TPFLAGS_HAVE_VERSION_TAG | \ |
| 673 | 0) |
Guido van Rossum | 36eef3c | 1998-10-08 02:10:56 +0000 | [diff] [blame] | 674 | |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 675 | /* NOTE: The following flags reuse lower bits (removed as part of the |
| 676 | * Python 3.0 transition). */ |
| 677 | |
| 678 | /* Type structure has tp_finalize member (3.4) */ |
| 679 | #define Py_TPFLAGS_HAVE_FINALIZE (1UL << 0) |
| 680 | |
Martin v. Löwis | 738236d | 2011-02-05 20:35:29 +0000 | [diff] [blame] | 681 | #ifdef Py_LIMITED_API |
| 682 | #define PyType_HasFeature(t,f) ((PyType_GetFlags(t) & (f)) != 0) |
| 683 | #else |
Guido van Rossum | 36eef3c | 1998-10-08 02:10:56 +0000 | [diff] [blame] | 684 | #define PyType_HasFeature(t,f) (((t)->tp_flags & (f)) != 0) |
Martin v. Löwis | 738236d | 2011-02-05 20:35:29 +0000 | [diff] [blame] | 685 | #endif |
Thomas Wouters | 27d517b | 2007-02-25 20:39:11 +0000 | [diff] [blame] | 686 | #define PyType_FastSubclass(t,f) PyType_HasFeature(t,f) |
Guido van Rossum | 36eef3c | 1998-10-08 02:10:56 +0000 | [diff] [blame] | 687 | |
| 688 | |
| 689 | /* |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 690 | The macros Py_INCREF(op) and Py_DECREF(op) are used to increment or decrement |
Tim Peters | 4be93d0 | 2002-07-07 19:59:50 +0000 | [diff] [blame] | 691 | reference counts. Py_DECREF calls the object's deallocator function when |
| 692 | the refcount falls to 0; for |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 693 | objects that don't contain references to other objects or heap memory |
| 694 | this can be the standard function free(). Both macros can be used |
Tim Peters | 4be93d0 | 2002-07-07 19:59:50 +0000 | [diff] [blame] | 695 | wherever a void expression is allowed. The argument must not be a |
Benjamin Peterson | 2a691a8 | 2008-03-31 01:51:45 +0000 | [diff] [blame] | 696 | NULL pointer. If it may be NULL, use Py_XINCREF/Py_XDECREF instead. |
Tim Peters | 4be93d0 | 2002-07-07 19:59:50 +0000 | [diff] [blame] | 697 | The macro _Py_NewReference(op) initialize reference counts to 1, and |
| 698 | in special builds (Py_REF_DEBUG, Py_TRACE_REFS) performs additional |
| 699 | bookkeeping appropriate to the special build. |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 700 | |
| 701 | We assume that the reference count field can never overflow; this can |
Tim Peters | 4be93d0 | 2002-07-07 19:59:50 +0000 | [diff] [blame] | 702 | be proven when the size of the field is the same as the pointer size, so |
| 703 | we ignore the possibility. Provided a C int is at least 32 bits (which |
| 704 | is implicitly assumed in many parts of this code), that's enough for |
| 705 | about 2**31 references to an object. |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 706 | |
Tim Peters | 4be93d0 | 2002-07-07 19:59:50 +0000 | [diff] [blame] | 707 | XXX The following became out of date in Python 2.2, but I'm not sure |
| 708 | XXX what the full truth is now. Certainly, heap-allocated type objects |
| 709 | XXX can and should be deallocated. |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 710 | Type objects should never be deallocated; the type pointer in an object |
| 711 | is not considered to be a reference to the type object, to save |
| 712 | complications in the deallocation function. (This is actually a |
| 713 | decision that's up to the implementer of each new type so if you want, |
| 714 | you can count such references to the type object.) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 715 | */ |
| 716 | |
Tim Peters | 3459251 | 2002-07-11 06:23:50 +0000 | [diff] [blame] | 717 | /* First define a pile of simple helper macros, one set per special |
| 718 | * build symbol. These either expand to the obvious things, or to |
| 719 | * nothing at all when the special mode isn't in effect. The main |
| 720 | * macros can later be defined just once then, yet expand to different |
| 721 | * things depending on which special build options are and aren't in effect. |
| 722 | * Trust me <wink>: while painful, this is 20x easier to understand than, |
| 723 | * e.g, defining _Py_NewReference five different times in a maze of nested |
| 724 | * #ifdefs (we used to do that -- it was impenetrable). |
| 725 | */ |
Tim Peters | 4be93d0 | 2002-07-07 19:59:50 +0000 | [diff] [blame] | 726 | #ifdef Py_REF_DEBUG |
Neal Norwitz | 4281cef | 2006-03-04 19:58:13 +0000 | [diff] [blame] | 727 | PyAPI_DATA(Py_ssize_t) _Py_RefTotal; |
Mark Hammond | a290527 | 2002-07-29 13:42:14 +0000 | [diff] [blame] | 728 | PyAPI_FUNC(void) _Py_NegativeRefcount(const char *fname, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 729 | int lineno, PyObject *op); |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 730 | PyAPI_FUNC(Py_ssize_t) _Py_GetRefTotal(void); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 731 | #define _Py_INC_REFTOTAL _Py_RefTotal++ |
| 732 | #define _Py_DEC_REFTOTAL _Py_RefTotal-- |
| 733 | #define _Py_REF_DEBUG_COMMA , |
| 734 | #define _Py_CHECK_REFCNT(OP) \ |
| 735 | { if (((PyObject*)OP)->ob_refcnt < 0) \ |
| 736 | _Py_NegativeRefcount(__FILE__, __LINE__, \ |
| 737 | (PyObject *)(OP)); \ |
Tim Peters | 7c321a8 | 2002-07-09 02:57:01 +0000 | [diff] [blame] | 738 | } |
Nick Coghlan | d600951 | 2014-11-20 21:39:37 +1000 | [diff] [blame] | 739 | /* Py_REF_DEBUG also controls the display of refcounts and memory block |
| 740 | * allocations at the interactive prompt and at interpreter shutdown |
| 741 | */ |
| 742 | PyAPI_FUNC(void) _PyDebug_PrintTotalRefs(void); |
Tim Peters | 4be93d0 | 2002-07-07 19:59:50 +0000 | [diff] [blame] | 743 | #else |
Tim Peters | 3459251 | 2002-07-11 06:23:50 +0000 | [diff] [blame] | 744 | #define _Py_INC_REFTOTAL |
| 745 | #define _Py_DEC_REFTOTAL |
| 746 | #define _Py_REF_DEBUG_COMMA |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 747 | #define _Py_CHECK_REFCNT(OP) /* a semicolon */; |
Tim Peters | 57f4ddd | 2002-07-10 06:34:15 +0000 | [diff] [blame] | 748 | #endif /* Py_REF_DEBUG */ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 749 | |
Sjoerd Mullender | a9c3c22 | 1993-10-11 12:54:31 +0000 | [diff] [blame] | 750 | #ifdef COUNT_ALLOCS |
Mark Hammond | a290527 | 2002-07-29 13:42:14 +0000 | [diff] [blame] | 751 | PyAPI_FUNC(void) inc_count(PyTypeObject *); |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 752 | PyAPI_FUNC(void) dec_count(PyTypeObject *); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 753 | #define _Py_INC_TPALLOCS(OP) inc_count(Py_TYPE(OP)) |
| 754 | #define _Py_INC_TPFREES(OP) dec_count(Py_TYPE(OP)) |
| 755 | #define _Py_DEC_TPFREES(OP) Py_TYPE(OP)->tp_frees-- |
| 756 | #define _Py_COUNT_ALLOCS_COMMA , |
Sjoerd Mullender | a9c3c22 | 1993-10-11 12:54:31 +0000 | [diff] [blame] | 757 | #else |
Tim Peters | 3459251 | 2002-07-11 06:23:50 +0000 | [diff] [blame] | 758 | #define _Py_INC_TPALLOCS(OP) |
| 759 | #define _Py_INC_TPFREES(OP) |
| 760 | #define _Py_DEC_TPFREES(OP) |
| 761 | #define _Py_COUNT_ALLOCS_COMMA |
Tim Peters | 57f4ddd | 2002-07-10 06:34:15 +0000 | [diff] [blame] | 762 | #endif /* COUNT_ALLOCS */ |
Tim Peters | 4be93d0 | 2002-07-07 19:59:50 +0000 | [diff] [blame] | 763 | |
| 764 | #ifdef Py_TRACE_REFS |
| 765 | /* Py_TRACE_REFS is such major surgery that we call external routines. */ |
Mark Hammond | a290527 | 2002-07-29 13:42:14 +0000 | [diff] [blame] | 766 | PyAPI_FUNC(void) _Py_NewReference(PyObject *); |
| 767 | PyAPI_FUNC(void) _Py_ForgetReference(PyObject *); |
| 768 | PyAPI_FUNC(void) _Py_Dealloc(PyObject *); |
| 769 | PyAPI_FUNC(void) _Py_PrintReferences(FILE *); |
Tim Peters | 269b2a6 | 2003-04-17 19:52:29 +0000 | [diff] [blame] | 770 | PyAPI_FUNC(void) _Py_PrintReferenceAddresses(FILE *); |
Tim Peters | 7571a0f | 2003-03-23 17:52:28 +0000 | [diff] [blame] | 771 | PyAPI_FUNC(void) _Py_AddToAllObjects(PyObject *, int force); |
Tim Peters | 4be93d0 | 2002-07-07 19:59:50 +0000 | [diff] [blame] | 772 | |
| 773 | #else |
| 774 | /* Without Py_TRACE_REFS, there's little enough to do that we expand code |
| 775 | * inline. |
| 776 | */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 777 | #define _Py_NewReference(op) ( \ |
| 778 | _Py_INC_TPALLOCS(op) _Py_COUNT_ALLOCS_COMMA \ |
| 779 | _Py_INC_REFTOTAL _Py_REF_DEBUG_COMMA \ |
| 780 | Py_REFCNT(op) = 1) |
Tim Peters | 4be93d0 | 2002-07-07 19:59:50 +0000 | [diff] [blame] | 781 | |
Tim Peters | 3459251 | 2002-07-11 06:23:50 +0000 | [diff] [blame] | 782 | #define _Py_ForgetReference(op) _Py_INC_TPFREES(op) |
Tim Peters | 4be93d0 | 2002-07-07 19:59:50 +0000 | [diff] [blame] | 783 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 784 | #ifdef Py_LIMITED_API |
| 785 | PyAPI_FUNC(void) _Py_Dealloc(PyObject *); |
| 786 | #else |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 787 | #define _Py_Dealloc(op) ( \ |
| 788 | _Py_INC_TPFREES(op) _Py_COUNT_ALLOCS_COMMA \ |
| 789 | (*Py_TYPE(op)->tp_dealloc)((PyObject *)(op))) |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 790 | #endif |
Guido van Rossum | 60be1db | 1996-05-22 16:33:22 +0000 | [diff] [blame] | 791 | #endif /* !Py_TRACE_REFS */ |
| 792 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 793 | #define Py_INCREF(op) ( \ |
| 794 | _Py_INC_REFTOTAL _Py_REF_DEBUG_COMMA \ |
Benjamin Peterson | da5eb5a | 2013-05-27 14:46:14 -0700 | [diff] [blame] | 795 | ((PyObject *)(op))->ob_refcnt++) |
Tim Peters | 4be93d0 | 2002-07-07 19:59:50 +0000 | [diff] [blame] | 796 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 797 | #define Py_DECREF(op) \ |
| 798 | do { \ |
Benjamin Peterson | da5eb5a | 2013-05-27 14:46:14 -0700 | [diff] [blame] | 799 | PyObject *_py_decref_tmp = (PyObject *)(op); \ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 800 | if (_Py_DEC_REFTOTAL _Py_REF_DEBUG_COMMA \ |
Benjamin Peterson | da5eb5a | 2013-05-27 14:46:14 -0700 | [diff] [blame] | 801 | --(_py_decref_tmp)->ob_refcnt != 0) \ |
| 802 | _Py_CHECK_REFCNT(_py_decref_tmp) \ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 803 | else \ |
Victor Stinner | af4a1f2 | 2016-03-19 10:33:50 +0100 | [diff] [blame] | 804 | _Py_Dealloc(_py_decref_tmp); \ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 805 | } while (0) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 806 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 807 | /* Safely decref `op` and set `op` to NULL, especially useful in tp_clear |
Berker Peksag | 4882cac | 2015-04-14 09:30:01 +0300 | [diff] [blame] | 808 | * and tp_dealloc implementations. |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 809 | * |
| 810 | * Note that "the obvious" code can be deadly: |
| 811 | * |
| 812 | * Py_XDECREF(op); |
| 813 | * op = NULL; |
| 814 | * |
| 815 | * Typically, `op` is something like self->containee, and `self` is done |
| 816 | * using its `containee` member. In the code sequence above, suppose |
| 817 | * `containee` is non-NULL with a refcount of 1. Its refcount falls to |
| 818 | * 0 on the first line, which can trigger an arbitrary amount of code, |
| 819 | * possibly including finalizers (like __del__ methods or weakref callbacks) |
| 820 | * coded in Python, which in turn can release the GIL and allow other threads |
| 821 | * to run, etc. Such code may even invoke methods of `self` again, or cause |
| 822 | * cyclic gc to trigger, but-- oops! --self->containee still points to the |
| 823 | * object being torn down, and it may be in an insane state while being torn |
| 824 | * down. This has in fact been a rich historic source of miserable (rare & |
| 825 | * hard-to-diagnose) segfaulting (and other) bugs. |
| 826 | * |
| 827 | * The safe way is: |
| 828 | * |
| 829 | * Py_CLEAR(op); |
| 830 | * |
| 831 | * That arranges to set `op` to NULL _before_ decref'ing, so that any code |
| 832 | * triggered as a side-effect of `op` getting torn down no longer believes |
| 833 | * `op` points to a valid object. |
| 834 | * |
| 835 | * There are cases where it's safe to use the naive code, but they're brittle. |
| 836 | * For example, if `op` points to a Python integer, you know that destroying |
| 837 | * one of those can't cause problems -- but in part that relies on that |
| 838 | * Python integers aren't currently weakly referencable. Best practice is |
| 839 | * to use Py_CLEAR() even if you can't think of a reason for why you need to. |
| 840 | */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 841 | #define Py_CLEAR(op) \ |
| 842 | do { \ |
Benjamin Peterson | da5eb5a | 2013-05-27 14:46:14 -0700 | [diff] [blame] | 843 | PyObject *_py_tmp = (PyObject *)(op); \ |
| 844 | if (_py_tmp != NULL) { \ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 845 | (op) = NULL; \ |
| 846 | Py_DECREF(_py_tmp); \ |
| 847 | } \ |
| 848 | } while (0) |
Jim Fulton | 8c5aeaa | 2004-07-14 19:07:35 +0000 | [diff] [blame] | 849 | |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 850 | /* Macros to use in case the object pointer may be NULL: */ |
Benjamin Peterson | da5eb5a | 2013-05-27 14:46:14 -0700 | [diff] [blame] | 851 | #define Py_XINCREF(op) \ |
| 852 | do { \ |
| 853 | PyObject *_py_xincref_tmp = (PyObject *)(op); \ |
| 854 | if (_py_xincref_tmp != NULL) \ |
| 855 | Py_INCREF(_py_xincref_tmp); \ |
Victor Stinner | 0905437 | 2013-11-06 22:41:44 +0100 | [diff] [blame] | 856 | } while (0) |
Benjamin Peterson | da5eb5a | 2013-05-27 14:46:14 -0700 | [diff] [blame] | 857 | |
| 858 | #define Py_XDECREF(op) \ |
| 859 | do { \ |
| 860 | PyObject *_py_xdecref_tmp = (PyObject *)(op); \ |
| 861 | if (_py_xdecref_tmp != NULL) \ |
| 862 | Py_DECREF(_py_xdecref_tmp); \ |
| 863 | } while (0) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 864 | |
Serhiy Storchaka | 5a57ade | 2015-12-24 10:35:59 +0200 | [diff] [blame] | 865 | #ifndef Py_LIMITED_API |
| 866 | /* Safely decref `op` and set `op` to `op2`. |
| 867 | * |
| 868 | * As in case of Py_CLEAR "the obvious" code can be deadly: |
| 869 | * |
Serhiy Storchaka | 57a01d3 | 2016-04-10 18:05:40 +0300 | [diff] [blame] | 870 | * Py_DECREF(op); |
Serhiy Storchaka | 5a57ade | 2015-12-24 10:35:59 +0200 | [diff] [blame] | 871 | * op = op2; |
| 872 | * |
| 873 | * The safe way is: |
| 874 | * |
Serhiy Storchaka | 57a01d3 | 2016-04-10 18:05:40 +0300 | [diff] [blame] | 875 | * Py_SETREF(op, op2); |
Serhiy Storchaka | 5a57ade | 2015-12-24 10:35:59 +0200 | [diff] [blame] | 876 | * |
| 877 | * That arranges to set `op` to `op2` _before_ decref'ing, so that any code |
| 878 | * triggered as a side-effect of `op` getting torn down no longer believes |
| 879 | * `op` points to a valid object. |
Serhiy Storchaka | 57a01d3 | 2016-04-10 18:05:40 +0300 | [diff] [blame] | 880 | * |
| 881 | * Py_XSETREF is a variant of Py_SETREF that uses Py_XDECREF instead of |
| 882 | * Py_DECREF. |
Serhiy Storchaka | 5a57ade | 2015-12-24 10:35:59 +0200 | [diff] [blame] | 883 | */ |
| 884 | |
Serhiy Storchaka | 57a01d3 | 2016-04-10 18:05:40 +0300 | [diff] [blame] | 885 | #define Py_SETREF(op, op2) \ |
| 886 | do { \ |
| 887 | PyObject *_py_tmp = (PyObject *)(op); \ |
| 888 | (op) = (op2); \ |
| 889 | Py_DECREF(_py_tmp); \ |
| 890 | } while (0) |
| 891 | |
Serhiy Storchaka | 4884271 | 2016-04-06 09:45:48 +0300 | [diff] [blame] | 892 | #define Py_XSETREF(op, op2) \ |
Serhiy Storchaka | 5a57ade | 2015-12-24 10:35:59 +0200 | [diff] [blame] | 893 | do { \ |
| 894 | PyObject *_py_tmp = (PyObject *)(op); \ |
| 895 | (op) = (op2); \ |
| 896 | Py_XDECREF(_py_tmp); \ |
| 897 | } while (0) |
| 898 | |
| 899 | #endif /* ifndef Py_LIMITED_API */ |
| 900 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 901 | /* |
Thomas Heller | 1328b52 | 2004-04-22 17:23:49 +0000 | [diff] [blame] | 902 | These are provided as conveniences to Python runtime embedders, so that |
| 903 | they can have object code that is not dependent on Python compilation flags. |
| 904 | */ |
| 905 | PyAPI_FUNC(void) Py_IncRef(PyObject *); |
| 906 | PyAPI_FUNC(void) Py_DecRef(PyObject *); |
| 907 | |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 908 | #ifndef Py_LIMITED_API |
Alexandre Vassalotti | 65846c6 | 2013-11-30 17:55:48 -0800 | [diff] [blame] | 909 | PyAPI_DATA(PyTypeObject) _PyNone_Type; |
| 910 | PyAPI_DATA(PyTypeObject) _PyNotImplemented_Type; |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 911 | #endif /* !Py_LIMITED_API */ |
Alexandre Vassalotti | 19b6fa6 | 2013-11-30 16:06:39 -0800 | [diff] [blame] | 912 | |
Thomas Heller | 1328b52 | 2004-04-22 17:23:49 +0000 | [diff] [blame] | 913 | /* |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 914 | _Py_NoneStruct is an object of undefined type which can be used in contexts |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 915 | where NULL (nil) is not suitable (since NULL often means 'error'). |
| 916 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 917 | Don't forget to apply Py_INCREF() when returning this value!!! |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 918 | */ |
Mark Hammond | a290527 | 2002-07-29 13:42:14 +0000 | [diff] [blame] | 919 | PyAPI_DATA(PyObject) _Py_NoneStruct; /* Don't use this directly */ |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 920 | #define Py_None (&_Py_NoneStruct) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 921 | |
Brett Cannon | d05235e | 2003-10-19 21:19:40 +0000 | [diff] [blame] | 922 | /* Macro for returning Py_None from a function */ |
Tim Peters | 5980ff2 | 2004-07-22 01:46:43 +0000 | [diff] [blame] | 923 | #define Py_RETURN_NONE return Py_INCREF(Py_None), Py_None |
Brett Cannon | d05235e | 2003-10-19 21:19:40 +0000 | [diff] [blame] | 924 | |
Neil Schemenauer | a7ed694 | 2001-01-04 01:31:50 +0000 | [diff] [blame] | 925 | /* |
| 926 | Py_NotImplemented is a singleton used to signal that an operation is |
| 927 | not implemented for a given type combination. |
| 928 | */ |
Mark Hammond | a290527 | 2002-07-29 13:42:14 +0000 | [diff] [blame] | 929 | PyAPI_DATA(PyObject) _Py_NotImplementedStruct; /* Don't use this directly */ |
Neil Schemenauer | a7ed694 | 2001-01-04 01:31:50 +0000 | [diff] [blame] | 930 | #define Py_NotImplemented (&_Py_NotImplementedStruct) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 931 | |
Brian Curtin | 7d2f9e1 | 2011-08-10 20:05:21 -0500 | [diff] [blame] | 932 | /* Macro for returning Py_NotImplemented from a function */ |
| 933 | #define Py_RETURN_NOTIMPLEMENTED \ |
| 934 | return Py_INCREF(Py_NotImplemented), Py_NotImplemented |
| 935 | |
Guido van Rossum | 5f284ce | 2001-01-17 15:20:39 +0000 | [diff] [blame] | 936 | /* Rich comparison opcodes */ |
| 937 | #define Py_LT 0 |
| 938 | #define Py_LE 1 |
| 939 | #define Py_EQ 2 |
| 940 | #define Py_NE 3 |
| 941 | #define Py_GT 4 |
| 942 | #define Py_GE 5 |
| 943 | |
stratakis | e8b1965 | 2017-11-02 11:32:54 +0100 | [diff] [blame] | 944 | /* |
| 945 | * Macro for implementing rich comparisons |
| 946 | * |
| 947 | * Needs to be a macro because any C-comparable type can be used. |
| 948 | */ |
| 949 | #define Py_RETURN_RICHCOMPARE(val1, val2, op) \ |
| 950 | do { \ |
| 951 | switch (op) { \ |
| 952 | case Py_EQ: if ((val1) == (val2)) Py_RETURN_TRUE; Py_RETURN_FALSE; \ |
| 953 | case Py_NE: if ((val1) != (val2)) Py_RETURN_TRUE; Py_RETURN_FALSE; \ |
| 954 | case Py_LT: if ((val1) < (val2)) Py_RETURN_TRUE; Py_RETURN_FALSE; \ |
| 955 | case Py_GT: if ((val1) > (val2)) Py_RETURN_TRUE; Py_RETURN_FALSE; \ |
| 956 | case Py_LE: if ((val1) <= (val2)) Py_RETURN_TRUE; Py_RETURN_FALSE; \ |
| 957 | case Py_GE: if ((val1) >= (val2)) Py_RETURN_TRUE; Py_RETURN_FALSE; \ |
| 958 | default: \ |
| 959 | Py_UNREACHABLE(); \ |
| 960 | } \ |
| 961 | } while (0) |
| 962 | |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 963 | #ifndef Py_LIMITED_API |
Tim Peters | f4aca75 | 2004-09-23 02:39:37 +0000 | [diff] [blame] | 964 | /* Maps Py_LT to Py_GT, ..., Py_GE to Py_LE. |
| 965 | * Defined in object.c. |
| 966 | */ |
| 967 | PyAPI_DATA(int) _Py_SwappedOp[]; |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 968 | #endif /* !Py_LIMITED_API */ |
Tim Peters | f4aca75 | 2004-09-23 02:39:37 +0000 | [diff] [blame] | 969 | |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 970 | |
| 971 | /* |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 972 | More conventions |
| 973 | ================ |
| 974 | |
| 975 | Argument Checking |
| 976 | ----------------- |
| 977 | |
| 978 | Functions that take objects as arguments normally don't check for nil |
| 979 | arguments, but they do check the type of the argument, and return an |
| 980 | error if the function doesn't apply to the type. |
| 981 | |
| 982 | Failure Modes |
| 983 | ------------- |
| 984 | |
| 985 | Functions may fail for a variety of reasons, including running out of |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 986 | memory. This is communicated to the caller in two ways: an error string |
| 987 | is set (see errors.h), and the function result differs: functions that |
| 988 | normally return a pointer return NULL for failure, functions returning |
| 989 | an integer return -1 (which could be a legal return value too!), and |
| 990 | other functions return 0 for success and -1 for failure. |
Tim Peters | 4be93d0 | 2002-07-07 19:59:50 +0000 | [diff] [blame] | 991 | Callers should always check for errors before using the result. If |
| 992 | an error was set, the caller must either explicitly clear it, or pass |
| 993 | the error on to its caller. |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 994 | |
| 995 | Reference Counts |
| 996 | ---------------- |
| 997 | |
| 998 | It takes a while to get used to the proper usage of reference counts. |
| 999 | |
| 1000 | Functions that create an object set the reference count to 1; such new |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 1001 | objects must be stored somewhere or destroyed again with Py_DECREF(). |
Alex Martelli | 721b776 | 2003-11-09 16:38:39 +0000 | [diff] [blame] | 1002 | Some functions that 'store' objects, such as PyTuple_SetItem() and |
| 1003 | PyList_SetItem(), |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1004 | don't increment the reference count of the object, since the most |
| 1005 | frequent use is to store a fresh object. Functions that 'retrieve' |
Alex Martelli | 721b776 | 2003-11-09 16:38:39 +0000 | [diff] [blame] | 1006 | objects, such as PyTuple_GetItem() and PyDict_GetItemString(), also |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 1007 | don't increment |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1008 | the reference count, since most frequently the object is only looked at |
| 1009 | quickly. Thus, to retrieve an object and store it again, the caller |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 1010 | must call Py_INCREF() explicitly. |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1011 | |
Alex Martelli | 721b776 | 2003-11-09 16:38:39 +0000 | [diff] [blame] | 1012 | NOTE: functions that 'consume' a reference count, like |
| 1013 | PyList_SetItem(), consume the reference even if the object wasn't |
| 1014 | successfully stored, to simplify error handling. |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1015 | |
| 1016 | It seems attractive to make other functions that take an object as |
Alex Martelli | 721b776 | 2003-11-09 16:38:39 +0000 | [diff] [blame] | 1017 | argument consume a reference count; however, this may quickly get |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1018 | confusing (even the current practice is already confusing). Consider |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 1019 | it carefully, it may save lots of calls to Py_INCREF() and Py_DECREF() at |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1020 | times. |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1021 | */ |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 1022 | |
Guido van Rossum | d724b23 | 2000-03-13 16:01:29 +0000 | [diff] [blame] | 1023 | |
Tim Peters | 803526b | 2002-07-07 05:13:56 +0000 | [diff] [blame] | 1024 | /* Trashcan mechanism, thanks to Christian Tismer. |
Guido van Rossum | d724b23 | 2000-03-13 16:01:29 +0000 | [diff] [blame] | 1025 | |
Tim Peters | 803526b | 2002-07-07 05:13:56 +0000 | [diff] [blame] | 1026 | When deallocating a container object, it's possible to trigger an unbounded |
| 1027 | chain of deallocations, as each Py_DECREF in turn drops the refcount on "the |
| 1028 | next" object in the chain to 0. This can easily lead to stack faults, and |
| 1029 | especially in threads (which typically have less stack space to work with). |
Guido van Rossum | d724b23 | 2000-03-13 16:01:29 +0000 | [diff] [blame] | 1030 | |
Tim Peters | 803526b | 2002-07-07 05:13:56 +0000 | [diff] [blame] | 1031 | A container object that participates in cyclic gc can avoid this by |
| 1032 | bracketing the body of its tp_dealloc function with a pair of macros: |
Guido van Rossum | e92e610 | 2000-04-24 15:40:53 +0000 | [diff] [blame] | 1033 | |
Tim Peters | 803526b | 2002-07-07 05:13:56 +0000 | [diff] [blame] | 1034 | static void |
| 1035 | mytype_dealloc(mytype *p) |
| 1036 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1037 | ... declarations go here ... |
Tim Peters | 803526b | 2002-07-07 05:13:56 +0000 | [diff] [blame] | 1038 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1039 | PyObject_GC_UnTrack(p); // must untrack first |
| 1040 | Py_TRASHCAN_SAFE_BEGIN(p) |
| 1041 | ... The body of the deallocator goes here, including all calls ... |
| 1042 | ... to Py_DECREF on contained objects. ... |
| 1043 | Py_TRASHCAN_SAFE_END(p) |
Tim Peters | 803526b | 2002-07-07 05:13:56 +0000 | [diff] [blame] | 1044 | } |
| 1045 | |
Tim Peters | 808eb59 | 2002-08-07 20:53:05 +0000 | [diff] [blame] | 1046 | CAUTION: Never return from the middle of the body! If the body needs to |
| 1047 | "get out early", put a label immediately before the Py_TRASHCAN_SAFE_END |
| 1048 | call, and goto it. Else the call-depth counter (see below) will stay |
| 1049 | above 0 forever, and the trashcan will never get emptied. |
| 1050 | |
Tim Peters | 803526b | 2002-07-07 05:13:56 +0000 | [diff] [blame] | 1051 | How it works: The BEGIN macro increments a call-depth counter. So long |
| 1052 | as this counter is small, the body of the deallocator is run directly without |
| 1053 | further ado. But if the counter gets large, it instead adds p to a list of |
| 1054 | objects to be deallocated later, skips the body of the deallocator, and |
| 1055 | resumes execution after the END macro. The tp_dealloc routine then returns |
| 1056 | without deallocating anything (and so unbounded call-stack depth is avoided). |
| 1057 | |
| 1058 | When the call stack finishes unwinding again, code generated by the END macro |
| 1059 | notices this, and calls another routine to deallocate all the objects that |
| 1060 | may have been added to the list of deferred deallocations. In effect, a |
Xiang Zhang | a66f9c6 | 2017-05-13 13:36:14 +0800 | [diff] [blame] | 1061 | chain of N deallocations is broken into (N-1)/(PyTrash_UNWIND_LEVEL-1) pieces, |
Tim Peters | 803526b | 2002-07-07 05:13:56 +0000 | [diff] [blame] | 1062 | with the call stack never exceeding a depth of PyTrash_UNWIND_LEVEL. |
Guido van Rossum | d724b23 | 2000-03-13 16:01:29 +0000 | [diff] [blame] | 1063 | */ |
| 1064 | |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 1065 | #ifndef Py_LIMITED_API |
Antoine Pitrou | 56cd62c | 2012-09-06 00:59:49 +0200 | [diff] [blame] | 1066 | /* This is the old private API, invoked by the macros before 3.2.4. |
Antoine Pitrou | 5b4faae | 2012-09-06 01:17:42 +0200 | [diff] [blame] | 1067 | Kept for binary compatibility of extensions using the stable ABI. */ |
Mark Hammond | a290527 | 2002-07-29 13:42:14 +0000 | [diff] [blame] | 1068 | PyAPI_FUNC(void) _PyTrash_deposit_object(PyObject*); |
| 1069 | PyAPI_FUNC(void) _PyTrash_destroy_chain(void); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 1070 | #endif /* !Py_LIMITED_API */ |
Tim Peters | 803526b | 2002-07-07 05:13:56 +0000 | [diff] [blame] | 1071 | |
Antoine Pitrou | 56cd62c | 2012-09-06 00:59:49 +0200 | [diff] [blame] | 1072 | /* The new thread-safe private API, invoked by the macros below. */ |
| 1073 | PyAPI_FUNC(void) _PyTrash_thread_deposit_object(PyObject*); |
| 1074 | PyAPI_FUNC(void) _PyTrash_thread_destroy_chain(void); |
| 1075 | |
Guido van Rossum | d724b23 | 2000-03-13 16:01:29 +0000 | [diff] [blame] | 1076 | #define PyTrash_UNWIND_LEVEL 50 |
| 1077 | |
| 1078 | #define Py_TRASHCAN_SAFE_BEGIN(op) \ |
Antoine Pitrou | 56cd62c | 2012-09-06 00:59:49 +0200 | [diff] [blame] | 1079 | do { \ |
| 1080 | PyThreadState *_tstate = PyThreadState_GET(); \ |
| 1081 | if (_tstate->trash_delete_nesting < PyTrash_UNWIND_LEVEL) { \ |
| 1082 | ++_tstate->trash_delete_nesting; |
| 1083 | /* The body of the deallocator is here. */ |
Guido van Rossum | d724b23 | 2000-03-13 16:01:29 +0000 | [diff] [blame] | 1084 | #define Py_TRASHCAN_SAFE_END(op) \ |
Antoine Pitrou | 56cd62c | 2012-09-06 00:59:49 +0200 | [diff] [blame] | 1085 | --_tstate->trash_delete_nesting; \ |
| 1086 | if (_tstate->trash_delete_later && _tstate->trash_delete_nesting <= 0) \ |
| 1087 | _PyTrash_thread_destroy_chain(); \ |
| 1088 | } \ |
| 1089 | else \ |
| 1090 | _PyTrash_thread_deposit_object((PyObject*)op); \ |
| 1091 | } while (0); |
Guido van Rossum | e92e610 | 2000-04-24 15:40:53 +0000 | [diff] [blame] | 1092 | |
David Malcolm | 49526f4 | 2012-06-22 14:55:41 -0400 | [diff] [blame] | 1093 | #ifndef Py_LIMITED_API |
| 1094 | PyAPI_FUNC(void) |
| 1095 | _PyDebugAllocatorStats(FILE *out, const char *block_name, int num_blocks, |
| 1096 | size_t sizeof_block); |
| 1097 | PyAPI_FUNC(void) |
| 1098 | _PyObject_DebugTypeStats(FILE *out); |
| 1099 | #endif /* ifndef Py_LIMITED_API */ |
| 1100 | |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 1101 | #ifdef __cplusplus |
| 1102 | } |
| 1103 | #endif |
| 1104 | #endif /* !Py_OBJECT_H */ |