blob: af845fff522ac8a7a78126763b31821c531c9160 [file] [log] [blame]
Fred Drake41deb1e2001-02-01 05:27:45 +00001#include "Python.h"
Fred Drake41deb1e2001-02-01 05:27:45 +00002
3
4#define GET_WEAKREFS_LISTPTR(o) \
5 ((PyWeakReference **) PyObject_GET_WEAKREFS_LISTPTR(o))
6
Larry Hastings31826802013-10-19 00:09:25 -07007/*[clinic]
Fred Drake41deb1e2001-02-01 05:27:45 +00008
Larry Hastings31826802013-10-19 00:09:25 -07009module _weakref
10
11_weakref.getweakrefcount -> Py_ssize_t
12
13 object: object
14 /
15
16Return the number of weak references to 'object'.
17[clinic]*/
18
19PyDoc_STRVAR(_weakref_getweakrefcount__doc__,
20"Return the number of weak references to \'object\'.\n"
21"\n"
22"_weakref.getweakrefcount(object)");
23
24#define _WEAKREF_GETWEAKREFCOUNT_METHODDEF \
25 {"getweakrefcount", (PyCFunction)_weakref_getweakrefcount, METH_O, _weakref_getweakrefcount__doc__},
26
27static Py_ssize_t
Larry Hastingsebdcb502013-11-23 14:54:00 -080028_weakref_getweakrefcount_impl(PyModuleDef *module, PyObject *object);
Fred Drake7855aba2001-02-18 05:20:18 +000029
Fred Drake41deb1e2001-02-01 05:27:45 +000030static PyObject *
Larry Hastingsebdcb502013-11-23 14:54:00 -080031_weakref_getweakrefcount(PyModuleDef *module, PyObject *object)
Fred Drake41deb1e2001-02-01 05:27:45 +000032{
Larry Hastings31826802013-10-19 00:09:25 -070033 PyObject *return_value = NULL;
34 Py_ssize_t _return_value;
Larry Hastingsed4a1c52013-11-18 09:32:13 -080035 _return_value = _weakref_getweakrefcount_impl(module, object);
Larry Hastings31826802013-10-19 00:09:25 -070036 if ((_return_value == -1) && PyErr_Occurred())
37 goto exit;
38 return_value = PyLong_FromSsize_t(_return_value);
Fred Drake41deb1e2001-02-01 05:27:45 +000039
Larry Hastings31826802013-10-19 00:09:25 -070040exit:
41 return return_value;
42}
Fred Drake41deb1e2001-02-01 05:27:45 +000043
Larry Hastings31826802013-10-19 00:09:25 -070044static Py_ssize_t
Larry Hastingsebdcb502013-11-23 14:54:00 -080045_weakref_getweakrefcount_impl(PyModuleDef *module, PyObject *object)
46/*[clinic checksum: 015113be0c9a0a8672d35df10c63e3642cc23da4]*/
Larry Hastings31826802013-10-19 00:09:25 -070047{
48 PyWeakReference **list;
Fred Drake7fdc0a12001-08-16 14:11:30 +000049
Larry Hastings31826802013-10-19 00:09:25 -070050 if (!PyType_SUPPORTS_WEAKREFS(Py_TYPE(object)))
51 return 0;
52
53 list = GET_WEAKREFS_LISTPTR(object);
54 return _PyWeakref_GetWeakrefCount(*list);
Fred Drake41deb1e2001-02-01 05:27:45 +000055}
56
57
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000058PyDoc_STRVAR(weakref_getweakrefs__doc__,
Fred Drake7855aba2001-02-18 05:20:18 +000059"getweakrefs(object) -- return a list of all weak reference objects\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000060"that point to 'object'.");
Fred Drake7855aba2001-02-18 05:20:18 +000061
Fred Drake41deb1e2001-02-01 05:27:45 +000062static PyObject *
Fred Drake7fdc0a12001-08-16 14:11:30 +000063weakref_getweakrefs(PyObject *self, PyObject *object)
Fred Drake41deb1e2001-02-01 05:27:45 +000064{
65 PyObject *result = NULL;
Fred Drake41deb1e2001-02-01 05:27:45 +000066
Christian Heimes90aa7642007-12-19 02:45:37 +000067 if (PyType_SUPPORTS_WEAKREFS(Py_TYPE(object))) {
Fred Drake7fdc0a12001-08-16 14:11:30 +000068 PyWeakReference **list = GET_WEAKREFS_LISTPTR(object);
Thomas Wouters0e3f5912006-08-11 14:57:12 +000069 Py_ssize_t count = _PyWeakref_GetWeakrefCount(*list);
Fred Drake41deb1e2001-02-01 05:27:45 +000070
Fred Drake7fdc0a12001-08-16 14:11:30 +000071 result = PyList_New(count);
72 if (result != NULL) {
73 PyWeakReference *current = *list;
Thomas Wouters0e3f5912006-08-11 14:57:12 +000074 Py_ssize_t i;
Fred Drake7fdc0a12001-08-16 14:11:30 +000075 for (i = 0; i < count; ++i) {
76 PyList_SET_ITEM(result, i, (PyObject *) current);
77 Py_INCREF(current);
78 current = current->wr_next;
Fred Drake41deb1e2001-02-01 05:27:45 +000079 }
80 }
Fred Drake7fdc0a12001-08-16 14:11:30 +000081 }
82 else {
83 result = PyList_New(0);
Fred Drake41deb1e2001-02-01 05:27:45 +000084 }
85 return result;
86}
87
88
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000089PyDoc_STRVAR(weakref_proxy__doc__,
Fred Drake7855aba2001-02-18 05:20:18 +000090"proxy(object[, callback]) -- create a proxy object that weakly\n"
91"references 'object'. 'callback', if given, is called with a\n"
Fred Drake610291c2002-08-02 20:23:40 +000092"reference to the proxy when 'object' is about to be finalized.");
Fred Drake7855aba2001-02-18 05:20:18 +000093
Fred Drake41deb1e2001-02-01 05:27:45 +000094static PyObject *
95weakref_proxy(PyObject *self, PyObject *args)
96{
97 PyObject *object;
98 PyObject *callback = NULL;
Fred Drakef7f8cad2001-10-05 22:00:24 +000099 PyObject *result = NULL;
Fred Drake41deb1e2001-02-01 05:27:45 +0000100
Fred Drake0d429e82001-10-23 21:12:47 +0000101 if (PyArg_UnpackTuple(args, "proxy", 1, 2, &object, &callback)) {
Fred Drakef7f8cad2001-10-05 22:00:24 +0000102 result = PyWeakref_NewProxy(object, callback);
Fred Drake41deb1e2001-02-01 05:27:45 +0000103 }
Fred Drakef7f8cad2001-10-05 22:00:24 +0000104 return result;
Fred Drake41deb1e2001-02-01 05:27:45 +0000105}
106
107
108static PyMethodDef
109weakref_functions[] = {
Larry Hastings31826802013-10-19 00:09:25 -0700110 _WEAKREF_GETWEAKREFCOUNT_METHODDEF
Fred Drake7fdc0a12001-08-16 14:11:30 +0000111 {"getweakrefs", weakref_getweakrefs, METH_O,
Fred Drake7855aba2001-02-18 05:20:18 +0000112 weakref_getweakrefs__doc__},
113 {"proxy", weakref_proxy, METH_VARARGS,
114 weakref_proxy__doc__},
Fred Drake41deb1e2001-02-01 05:27:45 +0000115 {NULL, NULL, 0, NULL}
116};
117
118
Martin v. Löwis1a214512008-06-11 05:26:20 +0000119static struct PyModuleDef weakrefmodule = {
120 PyModuleDef_HEAD_INIT,
121 "_weakref",
122 "Weak-reference support module.",
123 -1,
124 weakref_functions,
125 NULL,
126 NULL,
127 NULL,
128 NULL
129};
130
Mark Hammondfe51c6d2002-08-02 02:27:13 +0000131PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +0000132PyInit__weakref(void)
Fred Drake41deb1e2001-02-01 05:27:45 +0000133{
134 PyObject *m;
135
Martin v. Löwis1a214512008-06-11 05:26:20 +0000136 m = PyModule_Create(&weakrefmodule);
Larry Hastings31826802013-10-19 00:09:25 -0700137
Fred Drake41deb1e2001-02-01 05:27:45 +0000138 if (m != NULL) {
Fred Drakef7f8cad2001-10-05 22:00:24 +0000139 Py_INCREF(&_PyWeakref_RefType);
Fred Drake0a4dd392004-07-02 18:57:45 +0000140 PyModule_AddObject(m, "ref",
141 (PyObject *) &_PyWeakref_RefType);
142 Py_INCREF(&_PyWeakref_RefType);
Fred Drake41deb1e2001-02-01 05:27:45 +0000143 PyModule_AddObject(m, "ReferenceType",
Fred Drakef7f8cad2001-10-05 22:00:24 +0000144 (PyObject *) &_PyWeakref_RefType);
145 Py_INCREF(&_PyWeakref_ProxyType);
Fred Drake41deb1e2001-02-01 05:27:45 +0000146 PyModule_AddObject(m, "ProxyType",
Fred Drakef7f8cad2001-10-05 22:00:24 +0000147 (PyObject *) &_PyWeakref_ProxyType);
148 Py_INCREF(&_PyWeakref_CallableProxyType);
Fred Drake41deb1e2001-02-01 05:27:45 +0000149 PyModule_AddObject(m, "CallableProxyType",
Fred Drakef7f8cad2001-10-05 22:00:24 +0000150 (PyObject *) &_PyWeakref_CallableProxyType);
Fred Drake41deb1e2001-02-01 05:27:45 +0000151 }
Martin v. Löwis1a214512008-06-11 05:26:20 +0000152 return m;
Fred Drake41deb1e2001-02-01 05:27:45 +0000153}