Fred Drake | 8844d52 | 2001-10-05 21:52:26 +0000 | [diff] [blame] | 1 | /* Weak references objects for Python. */ |
| 2 | |
| 3 | #ifndef Py_WEAKREFOBJECT_H |
| 4 | #define Py_WEAKREFOBJECT_H |
| 5 | #ifdef __cplusplus |
| 6 | extern "C" { |
| 7 | #endif |
| 8 | |
| 9 | |
| 10 | typedef struct _PyWeakReference PyWeakReference; |
| 11 | |
| 12 | struct _PyWeakReference { |
| 13 | PyObject_HEAD |
| 14 | PyObject *wr_object; |
| 15 | PyObject *wr_callback; |
| 16 | long hash; |
| 17 | PyWeakReference *wr_prev; |
| 18 | PyWeakReference *wr_next; |
| 19 | }; |
| 20 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 21 | PyAPI_DATA(PyTypeObject) _PyWeakref_RefType; |
| 22 | PyAPI_DATA(PyTypeObject) _PyWeakref_ProxyType; |
| 23 | PyAPI_DATA(PyTypeObject) _PyWeakref_CallableProxyType; |
Fred Drake | 8844d52 | 2001-10-05 21:52:26 +0000 | [diff] [blame] | 24 | |
Fred Drake | 0a4dd39 | 2004-07-02 18:57:45 +0000 | [diff] [blame] | 25 | #define PyWeakref_CheckRef(op) PyObject_TypeCheck(op, &_PyWeakref_RefType) |
| 26 | #define PyWeakref_CheckRefExact(op) \ |
Fred Drake | 8844d52 | 2001-10-05 21:52:26 +0000 | [diff] [blame] | 27 | ((op)->ob_type == &_PyWeakref_RefType) |
| 28 | #define PyWeakref_CheckProxy(op) \ |
| 29 | (((op)->ob_type == &_PyWeakref_ProxyType) || \ |
| 30 | ((op)->ob_type == &_PyWeakref_CallableProxyType)) |
Fred Drake | 0a4dd39 | 2004-07-02 18:57:45 +0000 | [diff] [blame] | 31 | |
| 32 | /* This macro calls PyWeakref_CheckRef() last since that can involve a |
| 33 | function call; this makes it more likely that the function call |
| 34 | will be avoided. */ |
Fred Drake | 8844d52 | 2001-10-05 21:52:26 +0000 | [diff] [blame] | 35 | #define PyWeakref_Check(op) \ |
| 36 | (PyWeakref_CheckRef(op) || PyWeakref_CheckProxy(op)) |
| 37 | |
| 38 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 39 | PyAPI_FUNC(PyObject *) PyWeakref_NewRef(PyObject *ob, |
Fred Drake | 8844d52 | 2001-10-05 21:52:26 +0000 | [diff] [blame] | 40 | PyObject *callback); |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 41 | PyAPI_FUNC(PyObject *) PyWeakref_NewProxy(PyObject *ob, |
Fred Drake | 8844d52 | 2001-10-05 21:52:26 +0000 | [diff] [blame] | 42 | PyObject *callback); |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 43 | PyAPI_FUNC(PyObject *) PyWeakref_GetObject(PyObject *ref); |
Fred Drake | 8844d52 | 2001-10-05 21:52:26 +0000 | [diff] [blame] | 44 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 45 | PyAPI_FUNC(long) _PyWeakref_GetWeakrefCount(PyWeakReference *head); |
Fred Drake | 8844d52 | 2001-10-05 21:52:26 +0000 | [diff] [blame] | 46 | |
Tim Peters | 403a203 | 2003-11-20 21:21:46 +0000 | [diff] [blame] | 47 | PyAPI_FUNC(void) _PyWeakref_ClearRef(PyWeakReference *self); |
| 48 | |
Fred Drake | 8844d52 | 2001-10-05 21:52:26 +0000 | [diff] [blame] | 49 | #define PyWeakref_GET_OBJECT(ref) (((PyWeakReference *)(ref))->wr_object) |
| 50 | |
| 51 | |
| 52 | #ifdef __cplusplus |
| 53 | } |
| 54 | #endif |
| 55 | #endif /* !Py_WEAKREFOBJECT_H */ |