Mercurial > cpython-lru_cache-weakref
annotate Include/object.h @ 14984:ece6c19edcc1 legacy-trunk
Remove some debugging prints.
| author | Greg Ward <gward@python.net> |
|---|---|
| date | Tue, 03 Oct 2000 03:32:37 +0000 |
| parents | d327fc47f8fd |
| children | 362e53f43dd2 |
| 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 | 7 |
| 6 | 8 /* Object and type object interface */ |
| 9 | |
| 10 /* | |
| 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 | |
| 16 statically initialized type objects.) | |
| 17 | |
| 18 An object has a 'reference count' that is increased or decreased when a | |
| 19 pointer to the object is copied or deleted; when the reference count | |
| 20 reaches zero there are no references to the object left and it can be | |
| 21 removed from the heap. | |
| 22 | |
| 23 An object has a 'type' that determines what it represents and what kind | |
| 24 of data it contains. An object's type is fixed when it is created. | |
| 25 Types themselves are represented as objects; an object contains a | |
| 26 pointer to the corresponding type object. The type itself has a type | |
| 27 pointer pointing to the object representing the type 'type', which | |
| 28 contains a pointer to itself!). | |
| 29 | |
| 30 Objects do not float around in memory; once allocated an object keeps | |
| 31 the same size and address. Objects that must hold variable-size data | |
| 32 can contain pointers to variable-size parts of the object. Not all | |
| 33 objects of the same type have the same size; but the size cannot change | |
| 34 after allocation. (These restrictions are made so a reference to an | |
| 35 object can be simply a pointer -- moving an object would require | |
| 36 updating all the pointers, and changing an object's size would require | |
| 37 moving it if there was another object right next to it.) | |
| 38 | |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
39 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
|
40 The type 'PyObject' is a structure that only contains the reference count |
| 6 | 41 and the type pointer. The actual memory allocated for an object |
| 42 contains other data that can only be accessed after casting the pointer | |
| 43 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
|
44 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
|
45 used for this (to accommodate for future changes). The implementation |
| 6 | 46 of a particular object type can cast the object pointer to the proper |
| 47 type and back. | |
| 48 | |
| 49 A standard interface exists for objects that contain an array of items | |
| 50 whose size is determined when the object is allocated. | |
| 51 */ | |
| 52 | |
|
4839
4567e158d20c
Rename DEBUG macro to Py_DEBUG
Guido van Rossum <guido@python.org>
parents:
4503
diff
changeset
|
53 #ifdef Py_DEBUG |
| 86 | 54 |
| 55 /* Turn on heavy reference debugging */ | |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
56 #define Py_TRACE_REFS |
| 86 | 57 |
| 58 /* Turn on reference counting */ | |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
59 #define Py_REF_DEBUG |
| 86 | 60 |
|
4839
4567e158d20c
Rename DEBUG macro to Py_DEBUG
Guido van Rossum <guido@python.org>
parents:
4503
diff
changeset
|
61 #endif /* Py_DEBUG */ |
| 6 | 62 |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
63 #ifdef Py_TRACE_REFS |
|
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
64 #define PyObject_HEAD \ |
| 6 | 65 struct _object *_ob_next, *_ob_prev; \ |
|
62
fffd1286c882
Be more careful with negative reference counts.
Guido van Rossum <guido@python.org>
parents:
6
diff
changeset
|
66 int ob_refcnt; \ |
| 6 | 67 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
|
68 #define PyObject_HEAD_INIT(type) 0, 0, 1, type, |
|
3573
4c7bab4cdca6
Added some visual enhancements of debugging ifdefs.
Guido van Rossum <guido@python.org>
parents:
2862
diff
changeset
|
69 #else /* !Py_TRACE_REFS */ |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
70 #define PyObject_HEAD \ |
| 2058 | 71 int ob_refcnt; \ |
| 6 | 72 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
|
73 #define PyObject_HEAD_INIT(type) 1, type, |
|
3573
4c7bab4cdca6
Added some visual enhancements of debugging ifdefs.
Guido van Rossum <guido@python.org>
parents:
2862
diff
changeset
|
74 #endif /* !Py_TRACE_REFS */ |
| 6 | 75 |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
76 #define PyObject_VAR_HEAD \ |
|
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
77 PyObject_HEAD \ |
| 2058 | 78 int ob_size; /* Number of items in variable part */ |
| 6 | 79 |
| 80 typedef struct _object { | |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
81 PyObject_HEAD |
|
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
82 } PyObject; |
| 6 | 83 |
| 84 typedef struct { | |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
85 PyObject_VAR_HEAD |
|
5535
20c2b715188e
Oops, another forgotten renaming: varobject -> PyVarObject.
Guido van Rossum <guido@python.org>
parents:
5410
diff
changeset
|
86 } PyVarObject; |
| 6 | 87 |
| 88 | |
| 89 /* | |
| 90 Type objects contain a string containing the type name (to help somewhat | |
| 91 in debugging), the allocation parameters (see newobj() and newvarobj()), | |
| 92 and methods for accessing objects of the type. Methods are optional,a | |
| 93 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
|
94 this type. The Py_DECREF() macro uses the tp_dealloc method without |
| 6 | 95 checking for a nil pointer; it should always be implemented except if |
| 96 the implementation can guarantee that the reference count will never | |
| 97 reach zero (e.g., for type objects). | |
| 98 | |
| 99 NB: the methods for certain type groups are now contained in separate | |
| 100 method blocks. | |
| 101 */ | |
| 102 | |
|
13418
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
103 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
|
104 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
|
105 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
|
106 typedef int (*inquiry)(PyObject *); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
107 typedef int (*coercion)(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
|
108 typedef PyObject *(*intargfunc)(PyObject *, int); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
109 typedef PyObject *(*intintargfunc)(PyObject *, int, int); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
110 typedef int(*intobjargproc)(PyObject *, int, PyObject *); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
111 typedef int(*intintobjargproc)(PyObject *, int, int, PyObject *); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
112 typedef int(*objobjargproc)(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
|
113 typedef int (*getreadbufferproc)(PyObject *, int, void **); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
114 typedef int (*getwritebufferproc)(PyObject *, int, void **); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
115 typedef int (*getsegcountproc)(PyObject *, int *); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
116 typedef int (*getcharbufferproc)(PyObject *, int, const char **); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
117 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
|
118 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
|
119 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
|
120 |
| 6 | 121 typedef struct { |
|
1746
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
122 binaryfunc nb_add; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
123 binaryfunc nb_subtract; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
124 binaryfunc nb_multiply; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
125 binaryfunc nb_divide; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
126 binaryfunc nb_remainder; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
127 binaryfunc nb_divmod; |
|
1770
b0dca2972b2b
* Objects/{int,long,float}object.c, Include/object.h,
Guido van Rossum <guido@python.org>
parents:
1746
diff
changeset
|
128 ternaryfunc nb_power; |
|
1746
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
129 unaryfunc nb_negative; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
130 unaryfunc nb_positive; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
131 unaryfunc nb_absolute; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
132 inquiry nb_nonzero; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
133 unaryfunc nb_invert; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
134 binaryfunc nb_lshift; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
135 binaryfunc nb_rshift; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
136 binaryfunc nb_and; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
137 binaryfunc nb_xor; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
138 binaryfunc nb_or; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
139 coercion nb_coerce; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
140 unaryfunc nb_int; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
141 unaryfunc nb_long; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
142 unaryfunc nb_float; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
143 unaryfunc nb_oct; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
144 unaryfunc nb_hex; |
|
14162
27d7d89c774b
The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents:
13620
diff
changeset
|
145 binaryfunc nb_inplace_add; |
|
27d7d89c774b
The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents:
13620
diff
changeset
|
146 binaryfunc nb_inplace_subtract; |
|
27d7d89c774b
The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents:
13620
diff
changeset
|
147 binaryfunc nb_inplace_multiply; |
|
27d7d89c774b
The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents:
13620
diff
changeset
|
148 binaryfunc nb_inplace_divide; |
|
27d7d89c774b
The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents:
13620
diff
changeset
|
149 binaryfunc nb_inplace_remainder; |
|
27d7d89c774b
The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents:
13620
diff
changeset
|
150 ternaryfunc nb_inplace_power; |
|
27d7d89c774b
The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents:
13620
diff
changeset
|
151 binaryfunc nb_inplace_lshift; |
|
27d7d89c774b
The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents:
13620
diff
changeset
|
152 binaryfunc nb_inplace_rshift; |
|
27d7d89c774b
The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents:
13620
diff
changeset
|
153 binaryfunc nb_inplace_and; |
|
27d7d89c774b
The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents:
13620
diff
changeset
|
154 binaryfunc nb_inplace_xor; |
|
27d7d89c774b
The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents:
13620
diff
changeset
|
155 binaryfunc nb_inplace_or; |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
156 } PyNumberMethods; |
| 6 | 157 |
| 158 typedef struct { | |
|
1746
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
159 inquiry sq_length; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
160 binaryfunc sq_concat; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
161 intargfunc sq_repeat; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
162 intargfunc sq_item; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
163 intintargfunc sq_slice; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
164 intobjargproc sq_ass_item; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
165 intintobjargproc sq_ass_slice; |
|
11867
06104bcf06a6
Patch by Mozhe Zadka, for __contains__ (overloading 'in'). This adds
Guido van Rossum <guido@python.org>
parents:
11673
diff
changeset
|
166 objobjproc sq_contains; |
|
14162
27d7d89c774b
The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents:
13620
diff
changeset
|
167 binaryfunc sq_inplace_concat; |
|
27d7d89c774b
The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents:
13620
diff
changeset
|
168 intargfunc 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
|
169 } PySequenceMethods; |
| 6 | 170 |
| 171 typedef struct { | |
|
1746
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
172 inquiry mp_length; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
173 binaryfunc mp_subscript; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
174 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
|
175 } PyMappingMethods; |
| 6 | 176 |
|
5410
3b2fda31bf1b
Checkin of Jack's buffer mods.
Guido van Rossum <guido@python.org>
parents:
4839
diff
changeset
|
177 typedef struct { |
|
3b2fda31bf1b
Checkin of Jack's buffer mods.
Guido van Rossum <guido@python.org>
parents:
4839
diff
changeset
|
178 getreadbufferproc bf_getreadbuffer; |
|
3b2fda31bf1b
Checkin of Jack's buffer mods.
Guido van Rossum <guido@python.org>
parents:
4839
diff
changeset
|
179 getwritebufferproc bf_getwritebuffer; |
|
3b2fda31bf1b
Checkin of Jack's buffer mods.
Guido van Rossum <guido@python.org>
parents:
4839
diff
changeset
|
180 getsegcountproc bf_getsegcount; |
|
9304
cc3e14837379
Changes by Greg Stein (code) and GvR (design).
Guido van Rossum <guido@python.org>
parents:
8124
diff
changeset
|
181 getcharbufferproc bf_getcharbuffer; |
|
5410
3b2fda31bf1b
Checkin of Jack's buffer mods.
Guido van Rossum <guido@python.org>
parents:
4839
diff
changeset
|
182 } PyBufferProcs; |
|
3b2fda31bf1b
Checkin of Jack's buffer mods.
Guido van Rossum <guido@python.org>
parents:
4839
diff
changeset
|
183 |
|
3b2fda31bf1b
Checkin of Jack's buffer mods.
Guido van Rossum <guido@python.org>
parents:
4839
diff
changeset
|
184 |
|
13418
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
185 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
|
186 typedef int (*printfunc)(PyObject *, FILE *, int); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
187 typedef PyObject *(*getattrfunc)(PyObject *, char *); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
188 typedef PyObject *(*getattrofunc)(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
|
189 typedef int (*setattrfunc)(PyObject *, char *, PyObject *); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
190 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
|
191 typedef int (*cmpfunc)(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
|
192 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
|
193 typedef long (*hashfunc)(PyObject *); |
|
1746
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
194 |
| 6 | 195 typedef struct _typeobject { |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
196 PyObject_VAR_HEAD |
| 6 | 197 char *tp_name; /* For printing */ |
| 2058 | 198 int tp_basicsize, tp_itemsize; /* For allocation */ |
| 6 | 199 |
| 200 /* Methods to implement standard operations */ | |
| 201 | |
|
1746
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
202 destructor tp_dealloc; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
203 printfunc tp_print; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
204 getattrfunc tp_getattr; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
205 setattrfunc tp_setattr; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
206 cmpfunc tp_compare; |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
207 reprfunc tp_repr; |
| 6 | 208 |
| 209 /* Method suites for standard classes */ | |
| 210 | |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
211 PyNumberMethods *tp_as_number; |
|
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
212 PySequenceMethods *tp_as_sequence; |
|
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
213 PyMappingMethods *tp_as_mapping; |
|
1257
1cabc2b6c970
* Changed all copyright messages to include 1993.
Guido van Rossum <guido@python.org>
parents:
1049
diff
changeset
|
214 |
|
12026
8dc0918ae2c2
Updated comment: in PyTypeObject:
Fred Drake <fdrake@acm.org>
parents:
11999
diff
changeset
|
215 /* 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
|
216 |
|
1746
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
217 hashfunc tp_hash; |
|
2841
64928f6a8e80
keyword arguments and faster function calls
Guido van Rossum <guido@python.org>
parents:
2669
diff
changeset
|
218 ternaryfunc tp_call; |
|
2071
048e91a59c75
new tp_str and tp_doc members in type object
Guido van Rossum <guido@python.org>
parents:
2058
diff
changeset
|
219 reprfunc tp_str; |
|
3983
44902516614a
Added tp_getattro, tp_setattro (Sjoerd)
Guido van Rossum <guido@python.org>
parents:
3605
diff
changeset
|
220 getattrofunc tp_getattro; |
|
44902516614a
Added tp_getattro, tp_setattro (Sjoerd)
Guido van Rossum <guido@python.org>
parents:
3605
diff
changeset
|
221 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
|
222 |
|
5410
3b2fda31bf1b
Checkin of Jack's buffer mods.
Guido van Rossum <guido@python.org>
parents:
4839
diff
changeset
|
223 /* Functions to access object as input/output buffer */ |
|
3b2fda31bf1b
Checkin of Jack's buffer mods.
Guido van Rossum <guido@python.org>
parents:
4839
diff
changeset
|
224 PyBufferProcs *tp_as_buffer; |
|
3b2fda31bf1b
Checkin of Jack's buffer mods.
Guido van Rossum <guido@python.org>
parents:
4839
diff
changeset
|
225 |
|
9304
cc3e14837379
Changes by Greg Stein (code) and GvR (design).
Guido van Rossum <guido@python.org>
parents:
8124
diff
changeset
|
226 /* Flags to define presence of optional/expanded features */ |
|
cc3e14837379
Changes by Greg Stein (code) and GvR (design).
Guido van Rossum <guido@python.org>
parents:
8124
diff
changeset
|
227 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
|
228 |
|
048e91a59c75
new tp_str and tp_doc members in type object
Guido van Rossum <guido@python.org>
parents:
2058
diff
changeset
|
229 char *tp_doc; /* Documentation string */ |
|
048e91a59c75
new tp_str and tp_doc members in type object
Guido van Rossum <guido@python.org>
parents:
2058
diff
changeset
|
230 |
|
12990
e615596c5c47
Round 1 of Neil Schemenauer's GC patches:
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
12481
diff
changeset
|
231 /* call function for all accessible objects */ |
|
e615596c5c47
Round 1 of Neil Schemenauer's GC patches:
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
12481
diff
changeset
|
232 traverseproc tp_traverse; |
|
e615596c5c47
Round 1 of Neil Schemenauer's GC patches:
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
12481
diff
changeset
|
233 |
|
e615596c5c47
Round 1 of Neil Schemenauer's GC patches:
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
12481
diff
changeset
|
234 /* delete references to contained objects */ |
|
e615596c5c47
Round 1 of Neil Schemenauer's GC patches:
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
12481
diff
changeset
|
235 inquiry tp_clear; |
|
e615596c5c47
Round 1 of Neil Schemenauer's GC patches:
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
12481
diff
changeset
|
236 |
|
8124
bd744af6845f
Add new spares to the end of the type object struct.
Guido van Rossum <guido@python.org>
parents:
7983
diff
changeset
|
237 /* More spares */ |
|
bd744af6845f
Add new spares to the end of the type object struct.
Guido van Rossum <guido@python.org>
parents:
7983
diff
changeset
|
238 long tp_xxx7; |
|
bd744af6845f
Add new spares to the end of the type object struct.
Guido van Rossum <guido@python.org>
parents:
7983
diff
changeset
|
239 long tp_xxx8; |
|
bd744af6845f
Add new spares to the end of the type object struct.
Guido van Rossum <guido@python.org>
parents:
7983
diff
changeset
|
240 |
|
1347
a22a350d3a5d
* Extended X interface: pixmap objects, colormap objects visual objects,
Sjoerd Mullender <sjoerd@acm.org>
parents:
1329
diff
changeset
|
241 #ifdef COUNT_ALLOCS |
|
a22a350d3a5d
* Extended X interface: pixmap objects, colormap objects visual objects,
Sjoerd Mullender <sjoerd@acm.org>
parents:
1329
diff
changeset
|
242 /* these must be last */ |
|
a22a350d3a5d
* Extended X interface: pixmap objects, colormap objects visual objects,
Sjoerd Mullender <sjoerd@acm.org>
parents:
1329
diff
changeset
|
243 int tp_alloc; |
|
a22a350d3a5d
* Extended X interface: pixmap objects, colormap objects visual objects,
Sjoerd Mullender <sjoerd@acm.org>
parents:
1329
diff
changeset
|
244 int tp_free; |
|
a22a350d3a5d
* Extended X interface: pixmap objects, colormap objects visual objects,
Sjoerd Mullender <sjoerd@acm.org>
parents:
1329
diff
changeset
|
245 int tp_maxalloc; |
|
a22a350d3a5d
* Extended X interface: pixmap objects, colormap objects visual objects,
Sjoerd Mullender <sjoerd@acm.org>
parents:
1329
diff
changeset
|
246 struct _typeobject *tp_next; |
|
a22a350d3a5d
* Extended X interface: pixmap objects, colormap objects visual objects,
Sjoerd Mullender <sjoerd@acm.org>
parents:
1329
diff
changeset
|
247 #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
|
248 } PyTypeObject; |
| 6 | 249 |
|
2669
34eefa226709
DL_IMPORT needs an argument.
Sjoerd Mullender <sjoerd@acm.org>
parents:
2664
diff
changeset
|
250 extern DL_IMPORT(PyTypeObject) PyType_Type; /* The type of type objects */ |
| 6 | 251 |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
252 #define PyType_Check(op) ((op)->ob_type == &PyType_Type) |
| 6 | 253 |
| 86 | 254 /* Generic operations on objects */ |
|
13418
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
255 extern DL_IMPORT(int) PyObject_Print(PyObject *, FILE *, int); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
256 extern DL_IMPORT(PyObject *) PyObject_Repr(PyObject *); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
257 extern DL_IMPORT(PyObject *) PyObject_Str(PyObject *); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
258 extern DL_IMPORT(int) PyObject_Compare(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
|
259 extern DL_IMPORT(PyObject *) PyObject_GetAttrString(PyObject *, char *); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
260 extern DL_IMPORT(int) PyObject_SetAttrString(PyObject *, char *, PyObject *); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
261 extern DL_IMPORT(int) PyObject_HasAttrString(PyObject *, char *); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
262 extern DL_IMPORT(PyObject *) PyObject_GetAttr(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
|
263 extern DL_IMPORT(int) PyObject_SetAttr(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
|
264 extern DL_IMPORT(int) PyObject_HasAttr(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
|
265 extern DL_IMPORT(long) PyObject_Hash(PyObject *); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
266 extern DL_IMPORT(int) PyObject_IsTrue(PyObject *); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
267 extern DL_IMPORT(int) PyObject_Not(PyObject *); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
268 extern DL_IMPORT(int) PyCallable_Check(PyObject *); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
269 extern DL_IMPORT(int) PyNumber_Coerce(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
|
270 extern DL_IMPORT(int) PyNumber_CoerceEx(PyObject **, PyObject **); |
| 6 | 271 |
|
7983
068303f925ea
Add prototypes for Py_Repr{Enter,Leave}.
Guido van Rossum <guido@python.org>
parents:
7935
diff
changeset
|
272 /* Helpers for printing recursive container types */ |
|
13418
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
273 extern DL_IMPORT(int) Py_ReprEnter(PyObject *); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
274 extern DL_IMPORT(void) Py_ReprLeave(PyObject *); |
|
7983
068303f925ea
Add prototypes for Py_Repr{Enter,Leave}.
Guido van Rossum <guido@python.org>
parents:
7935
diff
changeset
|
275 |
|
12406
ec6b6ca5d111
Fix PR#7 comparisons of recursive objects
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
12026
diff
changeset
|
276 /* tstate dict key for PyObject_Compare helper */ |
|
ec6b6ca5d111
Fix PR#7 comparisons of recursive objects
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
12026
diff
changeset
|
277 extern PyObject *_PyCompareState_Key; |
|
ec6b6ca5d111
Fix PR#7 comparisons of recursive objects
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
12026
diff
changeset
|
278 |
|
13141
cca84745da3e
This patch addresses two main issues: (1) There exist some non-fatal
Fred Drake <fdrake@acm.org>
parents:
12993
diff
changeset
|
279 /* Helpers for hash functions */ |
|
13418
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
280 extern DL_IMPORT(long) _Py_HashDouble(double); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
281 extern DL_IMPORT(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
|
282 |
| 6 | 283 /* Flag bits for printing: */ |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
284 #define Py_PRINT_RAW 1 /* No string quotes etc. */ |
| 6 | 285 |
| 286 /* | |
|
9304
cc3e14837379
Changes by Greg Stein (code) and GvR (design).
Guido van Rossum <guido@python.org>
parents:
8124
diff
changeset
|
287 |
|
cc3e14837379
Changes by Greg Stein (code) and GvR (design).
Guido van Rossum <guido@python.org>
parents:
8124
diff
changeset
|
288 Type flags (tp_flags) |
|
cc3e14837379
Changes by Greg Stein (code) and GvR (design).
Guido van Rossum <guido@python.org>
parents:
8124
diff
changeset
|
289 |
|
cc3e14837379
Changes by Greg Stein (code) and GvR (design).
Guido van Rossum <guido@python.org>
parents:
8124
diff
changeset
|
290 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
|
291 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
|
292 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
|
293 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
|
294 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
|
295 |
|
cc3e14837379
Changes by Greg Stein (code) and GvR (design).
Guido van Rossum <guido@python.org>
parents:
8124
diff
changeset
|
296 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
|
297 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
|
298 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
|
299 |
|
cc3e14837379
Changes by Greg Stein (code) and GvR (design).
Guido van Rossum <guido@python.org>
parents:
8124
diff
changeset
|
300 Python 1.5.2 introduced the bf_getcharbuffer slot into PyBufferProcs. |
|
cc3e14837379
Changes by Greg Stein (code) and GvR (design).
Guido van Rossum <guido@python.org>
parents:
8124
diff
changeset
|
301 |
|
cc3e14837379
Changes by Greg Stein (code) and GvR (design).
Guido van Rossum <guido@python.org>
parents:
8124
diff
changeset
|
302 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
|
303 |
|
cc3e14837379
Changes by Greg Stein (code) and GvR (design).
Guido van Rossum <guido@python.org>
parents:
8124
diff
changeset
|
304 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
|
305 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
|
306 |
|
cc3e14837379
Changes by Greg Stein (code) and GvR (design).
Guido van Rossum <guido@python.org>
parents:
8124
diff
changeset
|
307 */ |
|
cc3e14837379
Changes by Greg Stein (code) and GvR (design).
Guido van Rossum <guido@python.org>
parents:
8124
diff
changeset
|
308 |
|
cc3e14837379
Changes by Greg Stein (code) and GvR (design).
Guido van Rossum <guido@python.org>
parents:
8124
diff
changeset
|
309 /* PyBufferProcs contains bf_getcharbuffer */ |
|
cc3e14837379
Changes by Greg Stein (code) and GvR (design).
Guido van Rossum <guido@python.org>
parents:
8124
diff
changeset
|
310 #define Py_TPFLAGS_HAVE_GETCHARBUFFER (1L<<0) |
|
cc3e14837379
Changes by Greg Stein (code) and GvR (design).
Guido van Rossum <guido@python.org>
parents:
8124
diff
changeset
|
311 |
|
11867
06104bcf06a6
Patch by Mozhe Zadka, for __contains__ (overloading 'in'). This adds
Guido van Rossum <guido@python.org>
parents:
11673
diff
changeset
|
312 /* PySequenceMethods contains sq_contains */ |
|
06104bcf06a6
Patch by Mozhe Zadka, for __contains__ (overloading 'in'). This adds
Guido van Rossum <guido@python.org>
parents:
11673
diff
changeset
|
313 #define Py_TPFLAGS_HAVE_SEQUENCE_IN (1L<<1) |
|
06104bcf06a6
Patch by Mozhe Zadka, for __contains__ (overloading 'in'). This adds
Guido van Rossum <guido@python.org>
parents:
11673
diff
changeset
|
314 |
|
12993
8f79c5b69e0a
part 2 of Neil Schemenauer's GC patches:
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
12990
diff
changeset
|
315 /* Objects which participate in garbage collection (see objimp.h) */ |
|
8f79c5b69e0a
part 2 of Neil Schemenauer's GC patches:
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
12990
diff
changeset
|
316 #ifdef WITH_CYCLE_GC |
|
8f79c5b69e0a
part 2 of Neil Schemenauer's GC patches:
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
12990
diff
changeset
|
317 #define Py_TPFLAGS_GC (1L<<2) |
|
8f79c5b69e0a
part 2 of Neil Schemenauer's GC patches:
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
12990
diff
changeset
|
318 #else |
|
8f79c5b69e0a
part 2 of Neil Schemenauer's GC patches:
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
12990
diff
changeset
|
319 #define Py_TPFLAGS_GC 0 |
|
8f79c5b69e0a
part 2 of Neil Schemenauer's GC patches:
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
12990
diff
changeset
|
320 #endif |
|
8f79c5b69e0a
part 2 of Neil Schemenauer's GC patches:
Jeremy Hylton <jeremy@alum.mit.edu>
parents:
12990
diff
changeset
|
321 |
|
14162
27d7d89c774b
The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents:
13620
diff
changeset
|
322 /* PySequenceMethods and PyNumberMethods contain in-place operators */ |
|
27d7d89c774b
The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents:
13620
diff
changeset
|
323 #define Py_TPFLAGS_HAVE_INPLACEOPS (1L<<3) |
|
27d7d89c774b
The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents:
13620
diff
changeset
|
324 |
|
11867
06104bcf06a6
Patch by Mozhe Zadka, for __contains__ (overloading 'in'). This adds
Guido van Rossum <guido@python.org>
parents:
11673
diff
changeset
|
325 #define Py_TPFLAGS_DEFAULT (Py_TPFLAGS_HAVE_GETCHARBUFFER | \ |
|
14162
27d7d89c774b
The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents:
13620
diff
changeset
|
326 Py_TPFLAGS_HAVE_SEQUENCE_IN | \ |
|
27d7d89c774b
The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents:
13620
diff
changeset
|
327 Py_TPFLAGS_HAVE_INPLACEOPS) |
|
9304
cc3e14837379
Changes by Greg Stein (code) and GvR (design).
Guido van Rossum <guido@python.org>
parents:
8124
diff
changeset
|
328 |
|
cc3e14837379
Changes by Greg Stein (code) and GvR (design).
Guido van Rossum <guido@python.org>
parents:
8124
diff
changeset
|
329 #define PyType_HasFeature(t,f) (((t)->tp_flags & (f)) != 0) |
|
cc3e14837379
Changes by Greg Stein (code) and GvR (design).
Guido van Rossum <guido@python.org>
parents:
8124
diff
changeset
|
330 |
|
cc3e14837379
Changes by Greg Stein (code) and GvR (design).
Guido van Rossum <guido@python.org>
parents:
8124
diff
changeset
|
331 |
|
cc3e14837379
Changes by Greg Stein (code) and GvR (design).
Guido van Rossum <guido@python.org>
parents:
8124
diff
changeset
|
332 /* |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
333 The macros Py_INCREF(op) and Py_DECREF(op) are used to increment or decrement |
|
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
334 reference counts. Py_DECREF calls the object's deallocator function; for |
| 6 | 335 objects that don't contain references to other objects or heap memory |
| 336 this can be the standard function free(). Both macros can be used | |
|
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
|
337 wherever a void expression is allowed. The argument shouldn't be a |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
338 NIL pointer. The macro _Py_NewReference(op) is used only to initialize |
|
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
339 reference counts to 1; it is defined here for convenience. |
| 6 | 340 |
| 341 We assume that the reference count field can never overflow; this can | |
| 342 be proven when the size of the field is the same as the pointer size | |
| 343 but even with a 16-bit reference count field it is pretty unlikely so | |
| 344 we ignore the possibility. (If you are paranoid, make it a long.) | |
| 345 | |
| 346 Type objects should never be deallocated; the type pointer in an object | |
| 347 is not considered to be a reference to the type object, to save | |
| 348 complications in the deallocation function. (This is actually a | |
| 349 decision that's up to the implementer of each new type so if you want, | |
| 350 you can count such references to the type object.) | |
| 351 | |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
352 *** WARNING*** The Py_DECREF macro must have a side-effect-free argument |
| 6 | 353 since it may evaluate its argument multiple times. (The alternative |
| 354 would be to mace it a proper function or assign it to a global temporary | |
| 355 variable first, both of which are slower; and in a multi-threaded | |
| 356 environment the global variable trick is not safe.) | |
| 357 */ | |
| 358 | |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
359 #ifdef Py_TRACE_REFS |
|
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
360 #ifndef Py_REF_DEBUG |
|
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
361 #define Py_REF_DEBUG |
| 6 | 362 #endif |
| 363 #endif | |
| 364 | |
|
4001
1ed773e15936
Added extern declarations for reference count admin debug functions.
Guido van Rossum <guido@python.org>
parents:
3983
diff
changeset
|
365 #ifdef Py_TRACE_REFS |
|
13418
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
366 extern DL_IMPORT(void) _Py_Dealloc(PyObject *); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
367 extern DL_IMPORT(void) _Py_NewReference(PyObject *); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
368 extern DL_IMPORT(void) _Py_ForgetReference(PyObject *); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
369 extern DL_IMPORT(void) _Py_PrintReferences(FILE *); |
|
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
370 extern DL_IMPORT(void) _Py_ResetReferences(void); |
|
4001
1ed773e15936
Added extern declarations for reference count admin debug functions.
Guido van Rossum <guido@python.org>
parents:
3983
diff
changeset
|
371 #endif |
|
1ed773e15936
Added extern declarations for reference count admin debug functions.
Guido van Rossum <guido@python.org>
parents:
3983
diff
changeset
|
372 |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
373 #ifndef Py_TRACE_REFS |
|
1347
a22a350d3a5d
* Extended X interface: pixmap objects, colormap objects visual objects,
Sjoerd Mullender <sjoerd@acm.org>
parents:
1329
diff
changeset
|
374 #ifdef COUNT_ALLOCS |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
375 #define _Py_Dealloc(op) ((op)->ob_type->tp_free++, (*(op)->ob_type->tp_dealloc)((PyObject *)(op))) |
|
2638
68c7a0a61fd5
Also count UNREF's as freeing an object (only relevant when
Sjoerd Mullender <sjoerd@acm.org>
parents:
2612
diff
changeset
|
376 #define _Py_ForgetReference(op) ((op)->ob_type->tp_free++) |
|
4001
1ed773e15936
Added extern declarations for reference count admin debug functions.
Guido van Rossum <guido@python.org>
parents:
3983
diff
changeset
|
377 #else /* !COUNT_ALLOCS */ |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
378 #define _Py_Dealloc(op) (*(op)->ob_type->tp_dealloc)((PyObject *)(op)) |
|
2638
68c7a0a61fd5
Also count UNREF's as freeing an object (only relevant when
Sjoerd Mullender <sjoerd@acm.org>
parents:
2612
diff
changeset
|
379 #define _Py_ForgetReference(op) /*empty*/ |
|
4001
1ed773e15936
Added extern declarations for reference count admin debug functions.
Guido van Rossum <guido@python.org>
parents:
3983
diff
changeset
|
380 #endif /* !COUNT_ALLOCS */ |
|
1ed773e15936
Added extern declarations for reference count admin debug functions.
Guido van Rossum <guido@python.org>
parents:
3983
diff
changeset
|
381 #endif /* !Py_TRACE_REFS */ |
| 6 | 382 |
|
1347
a22a350d3a5d
* Extended X interface: pixmap objects, colormap objects visual objects,
Sjoerd Mullender <sjoerd@acm.org>
parents:
1329
diff
changeset
|
383 #ifdef COUNT_ALLOCS |
|
13418
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
384 extern DL_IMPORT(void) inc_count(PyTypeObject *); |
|
1347
a22a350d3a5d
* Extended X interface: pixmap objects, colormap objects visual objects,
Sjoerd Mullender <sjoerd@acm.org>
parents:
1329
diff
changeset
|
385 #endif |
|
a22a350d3a5d
* Extended X interface: pixmap objects, colormap objects visual objects,
Sjoerd Mullender <sjoerd@acm.org>
parents:
1329
diff
changeset
|
386 |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
387 #ifdef Py_REF_DEBUG |
|
3573
4c7bab4cdca6
Added some visual enhancements of debugging ifdefs.
Guido van Rossum <guido@python.org>
parents:
2862
diff
changeset
|
388 |
|
9586
60fdb1db1175
Add DL_IMPORT(returntype) for all officially exported functions.
Guido van Rossum <guido@python.org>
parents:
9304
diff
changeset
|
389 extern DL_IMPORT(long) _Py_RefTotal; |
|
3573
4c7bab4cdca6
Added some visual enhancements of debugging ifdefs.
Guido van Rossum <guido@python.org>
parents:
2862
diff
changeset
|
390 |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
391 #ifndef Py_TRACE_REFS |
|
1347
a22a350d3a5d
* Extended X interface: pixmap objects, colormap objects visual objects,
Sjoerd Mullender <sjoerd@acm.org>
parents:
1329
diff
changeset
|
392 #ifdef COUNT_ALLOCS |
|
2612
ca6b60d4ea90
fix dusty debugging macros
Guido van Rossum <guido@python.org>
parents:
2436
diff
changeset
|
393 #define _Py_NewReference(op) (inc_count((op)->ob_type), _Py_RefTotal++, (op)->ob_refcnt = 1) |
|
1347
a22a350d3a5d
* Extended X interface: pixmap objects, colormap objects visual objects,
Sjoerd Mullender <sjoerd@acm.org>
parents:
1329
diff
changeset
|
394 #else |
|
2612
ca6b60d4ea90
fix dusty debugging macros
Guido van Rossum <guido@python.org>
parents:
2436
diff
changeset
|
395 #define _Py_NewReference(op) (_Py_RefTotal++, (op)->ob_refcnt = 1) |
| 6 | 396 #endif |
|
3573
4c7bab4cdca6
Added some visual enhancements of debugging ifdefs.
Guido van Rossum <guido@python.org>
parents:
2862
diff
changeset
|
397 #endif /* !Py_TRACE_REFS */ |
|
4c7bab4cdca6
Added some visual enhancements of debugging ifdefs.
Guido van Rossum <guido@python.org>
parents:
2862
diff
changeset
|
398 |
|
2612
ca6b60d4ea90
fix dusty debugging macros
Guido van Rossum <guido@python.org>
parents:
2436
diff
changeset
|
399 #define Py_INCREF(op) (_Py_RefTotal++, (op)->ob_refcnt++) |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
400 #define Py_DECREF(op) \ |
|
2612
ca6b60d4ea90
fix dusty debugging macros
Guido van Rossum <guido@python.org>
parents:
2436
diff
changeset
|
401 if (--_Py_RefTotal, --(op)->ob_refcnt != 0) \ |
| 6 | 402 ; \ |
| 403 else \ | |
|
5943
ac877c4768e1
Add a cast to the call to _Py_Dealloc in the expanded version of
Guido van Rossum <guido@python.org>
parents:
5535
diff
changeset
|
404 _Py_Dealloc((PyObject *)(op)) |
|
3573
4c7bab4cdca6
Added some visual enhancements of debugging ifdefs.
Guido van Rossum <guido@python.org>
parents:
2862
diff
changeset
|
405 #else /* !Py_REF_DEBUG */ |
|
4c7bab4cdca6
Added some visual enhancements of debugging ifdefs.
Guido van Rossum <guido@python.org>
parents:
2862
diff
changeset
|
406 |
|
1347
a22a350d3a5d
* Extended X interface: pixmap objects, colormap objects visual objects,
Sjoerd Mullender <sjoerd@acm.org>
parents:
1329
diff
changeset
|
407 #ifdef COUNT_ALLOCS |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
408 #define _Py_NewReference(op) (inc_count((op)->ob_type), (op)->ob_refcnt = 1) |
|
1347
a22a350d3a5d
* Extended X interface: pixmap objects, colormap objects visual objects,
Sjoerd Mullender <sjoerd@acm.org>
parents:
1329
diff
changeset
|
409 #else |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
410 #define _Py_NewReference(op) ((op)->ob_refcnt = 1) |
|
1347
a22a350d3a5d
* Extended X interface: pixmap objects, colormap objects visual objects,
Sjoerd Mullender <sjoerd@acm.org>
parents:
1329
diff
changeset
|
411 #endif |
|
3573
4c7bab4cdca6
Added some visual enhancements of debugging ifdefs.
Guido van Rossum <guido@python.org>
parents:
2862
diff
changeset
|
412 |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
413 #define Py_INCREF(op) ((op)->ob_refcnt++) |
|
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
414 #define Py_DECREF(op) \ |
| 2058 | 415 if (--(op)->ob_refcnt != 0) \ |
| 6 | 416 ; \ |
| 417 else \ | |
|
5943
ac877c4768e1
Add a cast to the call to _Py_Dealloc in the expanded version of
Guido van Rossum <guido@python.org>
parents:
5535
diff
changeset
|
418 _Py_Dealloc((PyObject *)(op)) |
|
3573
4c7bab4cdca6
Added some visual enhancements of debugging ifdefs.
Guido van Rossum <guido@python.org>
parents:
2862
diff
changeset
|
419 #endif /* !Py_REF_DEBUG */ |
| 6 | 420 |
| 86 | 421 /* Macros to use in case the object pointer may be NULL: */ |
| 422 | |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
423 #define Py_XINCREF(op) if ((op) == NULL) ; else Py_INCREF(op) |
|
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
424 #define Py_XDECREF(op) if ((op) == NULL) ; else Py_DECREF(op) |
| 6 | 425 |
| 426 /* | |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
427 _Py_NoneStruct is an object of undefined type which can be used in contexts |
| 6 | 428 where NULL (nil) is not suitable (since NULL often means 'error'). |
| 429 | |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
430 Don't forget to apply Py_INCREF() when returning this value!!! |
| 6 | 431 */ |
| 432 | |
|
2669
34eefa226709
DL_IMPORT needs an argument.
Sjoerd Mullender <sjoerd@acm.org>
parents:
2664
diff
changeset
|
433 extern DL_IMPORT(PyObject) _Py_NoneStruct; /* Don't use this directly */ |
| 6 | 434 |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
435 #define Py_None (&_Py_NoneStruct) |
| 6 | 436 |
| 437 | |
| 438 /* | |
|
1746
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
439 A common programming style in Python requires the forward declaration |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
440 of static, initialized structures, e.g. for a type object that is used |
|
1746
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
441 by the functions whose address must be used in the initializer. |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
442 Some compilers (notably SCO ODT 3.0, I seem to remember early AIX as |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
443 well) botch this if you use the static keyword for both declarations |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
444 (they allocate two objects, and use the first, uninitialized one until |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
445 the second declaration is encountered). Therefore, the forward |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
446 declaration should use the 'forwardstatic' keyword. This expands to |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
447 static on most systems, but to extern on a few. The actual storage |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
448 and name will still be static because the second declaration is |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
449 static, so no linker visible symbols will be generated. (Standard C |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
450 compilers take offense to the extern forward declaration of a static |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
451 object, so I can't just put extern in all cases. :-( ) |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
452 */ |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
453 |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
454 #ifdef BAD_STATIC_FORWARD |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
455 #define staticforward extern |
|
2422
f4f71ebea53f
change in staticforward -- added statichere
Guido van Rossum <guido@python.org>
parents:
2364
diff
changeset
|
456 #define statichere static |
|
f4f71ebea53f
change in staticforward -- added statichere
Guido van Rossum <guido@python.org>
parents:
2364
diff
changeset
|
457 #else /* !BAD_STATIC_FORWARD */ |
|
1746
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
458 #define staticforward static |
|
2422
f4f71ebea53f
change in staticforward -- added statichere
Guido van Rossum <guido@python.org>
parents:
2364
diff
changeset
|
459 #define statichere static |
|
f4f71ebea53f
change in staticforward -- added statichere
Guido van Rossum <guido@python.org>
parents:
2364
diff
changeset
|
460 #endif /* !BAD_STATIC_FORWARD */ |
|
1746
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
461 |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
462 |
|
1940892d2fe3
Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents:
1400
diff
changeset
|
463 /* |
| 6 | 464 More conventions |
| 465 ================ | |
| 466 | |
| 467 Argument Checking | |
| 468 ----------------- | |
| 469 | |
| 470 Functions that take objects as arguments normally don't check for nil | |
| 471 arguments, but they do check the type of the argument, and return an | |
| 472 error if the function doesn't apply to the type. | |
| 473 | |
| 474 Failure Modes | |
| 475 ------------- | |
| 476 | |
| 477 Functions may fail for a variety of reasons, including running out of | |
| 86 | 478 memory. This is communicated to the caller in two ways: an error string |
| 479 is set (see errors.h), and the function result differs: functions that | |
| 480 normally return a pointer return NULL for failure, functions returning | |
| 481 an integer return -1 (which could be a legal return value too!), and | |
| 482 other functions return 0 for success and -1 for failure. | |
| 483 Callers should always check for errors before using the result. | |
| 6 | 484 |
| 485 Reference Counts | |
| 486 ---------------- | |
| 487 | |
| 488 It takes a while to get used to the proper usage of reference counts. | |
| 489 | |
| 490 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
|
491 objects must be stored somewhere or destroyed again with Py_DECREF(). |
|
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
492 Functions that 'store' objects such as PyTuple_SetItem() and |
|
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
493 PyDict_SetItemString() |
| 6 | 494 don't increment the reference count of the object, since the most |
| 495 frequent use is to store a fresh object. Functions that 'retrieve' | |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
496 objects such as PyTuple_GetItem() and PyDict_GetItemString() also |
|
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
497 don't increment |
| 6 | 498 the reference count, since most frequently the object is only looked at |
| 499 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
|
500 must call Py_INCREF() explicitly. |
| 6 | 501 |
|
2129
05360cd616ae
The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents:
2071
diff
changeset
|
502 NOTE: functions that 'consume' a reference count like |
|
6244
5ab21d1b61d8
Fix in trailing comment: PyDict_SetItemString() does *not* consume a reference
Fred Drake <fdrake@acm.org>
parents:
5943
diff
changeset
|
503 PyList_SetItemString() even consume the reference if the object wasn't |
|
5ab21d1b61d8
Fix in trailing comment: PyDict_SetItemString() does *not* consume a reference
Fred Drake <fdrake@acm.org>
parents:
5943
diff
changeset
|
504 stored, to simplify error handling. |
| 6 | 505 |
| 506 It seems attractive to make other functions that take an object as | |
| 507 argument consume a reference count; however this may quickly get | |
| 508 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
|
509 it carefully, it may save lots of calls to Py_INCREF() and Py_DECREF() at |
| 6 | 510 times. |
| 511 */ | |
|
1329
519c25039c6a
* Added support for X11 modules.
Guido van Rossum <guido@python.org>
parents:
1324
diff
changeset
|
512 |
|
11999
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
513 /* |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
514 trashcan |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
515 CT 2k0130 |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
516 non-recursively destroy nested objects |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
517 |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
518 CT 2k0223 |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
519 redefinition for better locality and less overhead. |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
520 |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
521 Objects that want to be recursion safe need to use |
|
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
|
522 the macro's |
|
11999
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
523 Py_TRASHCAN_SAFE_BEGIN(name) |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
524 and |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
525 Py_TRASHCAN_SAFE_END(name) |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
526 surrounding their actual deallocation code. |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
527 |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
528 It would be nice to do this using the thread state. |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
529 Also, we could do an exact stack measure then. |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
530 Unfortunately, deallocations also take place when |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
531 the thread state is undefined. |
|
12481
a8898a172fe2
Christian Tismer -- total rewrite on trashcan code.
Guido van Rossum <guido@python.org>
parents:
12406
diff
changeset
|
532 |
|
a8898a172fe2
Christian Tismer -- total rewrite on trashcan code.
Guido van Rossum <guido@python.org>
parents:
12406
diff
changeset
|
533 CT 2k0422 complete rewrite. |
|
a8898a172fe2
Christian Tismer -- total rewrite on trashcan code.
Guido van Rossum <guido@python.org>
parents:
12406
diff
changeset
|
534 There is no need to allocate new objects. |
|
a8898a172fe2
Christian Tismer -- total rewrite on trashcan code.
Guido van Rossum <guido@python.org>
parents:
12406
diff
changeset
|
535 Everything is done vialob_refcnt and ob_type now. |
|
a8898a172fe2
Christian Tismer -- total rewrite on trashcan code.
Guido van Rossum <guido@python.org>
parents:
12406
diff
changeset
|
536 Adding support for free-threading should be easy, too. |
|
11999
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
537 */ |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
538 |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
539 #define PyTrash_UNWIND_LEVEL 50 |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
540 |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
541 #define Py_TRASHCAN_SAFE_BEGIN(op) \ |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
542 { \ |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
543 ++_PyTrash_delete_nesting; \ |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
544 if (_PyTrash_delete_nesting < PyTrash_UNWIND_LEVEL) { \ |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
545 |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
546 #define Py_TRASHCAN_SAFE_END(op) \ |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
547 ;} \ |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
548 else \ |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
549 _PyTrash_deposit_object((PyObject*)op);\ |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
550 --_PyTrash_delete_nesting; \ |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
551 if (_PyTrash_delete_later && _PyTrash_delete_nesting <= 0) \ |
|
12481
a8898a172fe2
Christian Tismer -- total rewrite on trashcan code.
Guido van Rossum <guido@python.org>
parents:
12406
diff
changeset
|
552 _PyTrash_destroy_chain(); \ |
|
11999
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
553 } \ |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
554 |
|
13418
85520c220067
Got RID of redundant coercions in longobject.c (as spotted by Greg
Tim Peters <tim.peters@gmail.com>
parents:
13256
diff
changeset
|
555 extern DL_IMPORT(void) _PyTrash_deposit_object(PyObject*); |
|
13419
db9392a04bed
One of the new prototypes was missing the "void" args.
Greg Stein <gstein@lyra.org>
parents:
13418
diff
changeset
|
556 extern DL_IMPORT(void) _PyTrash_destroy_chain(void); |
|
11999
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
557 |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
558 extern DL_IMPORT(int) _PyTrash_delete_nesting; |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
559 extern DL_IMPORT(PyObject *) _PyTrash_delete_later; |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
560 |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
561 /* swap the "xx" to check the speed loss */ |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
562 |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
563 #define xxPy_TRASHCAN_SAFE_BEGIN(op) |
|
c94247b5c355
Christian Tismer's "trashcan" patch:
Guido van Rossum <guido@python.org>
parents:
11891
diff
changeset
|
564 #define xxPy_TRASHCAN_SAFE_END(op) ; |
|
12481
a8898a172fe2
Christian Tismer -- total rewrite on trashcan code.
Guido van Rossum <guido@python.org>
parents:
12406
diff
changeset
|
565 |
|
1329
519c25039c6a
* Added support for X11 modules.
Guido van Rossum <guido@python.org>
parents:
1324
diff
changeset
|
566 #ifdef __cplusplus |
|
519c25039c6a
* Added support for X11 modules.
Guido van Rossum <guido@python.org>
parents:
1324
diff
changeset
|
567 } |
|
519c25039c6a
* Added support for X11 modules.
Guido van Rossum <guido@python.org>
parents:
1324
diff
changeset
|
568 #endif |
|
519c25039c6a
* Added support for X11 modules.
Guido van Rossum <guido@python.org>
parents:
1324
diff
changeset
|
569 #endif /* !Py_OBJECT_H */ |