blob: 6451dba2245d1688bb00f31a4c9e151a84f608bb [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 Hastings61272b72014-01-07 12:41:53 -08007/*[clinic input]
Larry Hastings31826802013-10-19 00:09:25 -07008module _weakref
Larry Hastings61272b72014-01-07 12:41:53 -08009[clinic start generated code]*/
Larry Hastings581ee362014-01-28 05:00:08 -080010/*[clinic end generated code: output=da39a3ee5e6b4b0d input=ffec73b85846596d]*/
Larry Hastings44e2eaa2013-11-23 15:37:55 -080011
Larry Hastings61272b72014-01-07 12:41:53 -080012/*[clinic input]
Larry Hastings31826802013-10-19 00:09:25 -070013
14_weakref.getweakrefcount -> Py_ssize_t
15
16 object: object
17 /
18
19Return the number of weak references to 'object'.
Larry Hastings61272b72014-01-07 12:41:53 -080020[clinic start generated code]*/
Larry Hastings31826802013-10-19 00:09:25 -070021
22PyDoc_STRVAR(_weakref_getweakrefcount__doc__,
Larry Hastings581ee362014-01-28 05:00:08 -080023"sig=($module, object)\n"
Larry Hastings44e2eaa2013-11-23 15:37:55 -080024"Return the number of weak references to \'object\'.");
Larry Hastings31826802013-10-19 00:09:25 -070025
26#define _WEAKREF_GETWEAKREFCOUNT_METHODDEF \
27 {"getweakrefcount", (PyCFunction)_weakref_getweakrefcount, METH_O, _weakref_getweakrefcount__doc__},
28
29static Py_ssize_t
Larry Hastingsebdcb502013-11-23 14:54:00 -080030_weakref_getweakrefcount_impl(PyModuleDef *module, PyObject *object);
Fred Drake7855aba2001-02-18 05:20:18 +000031
Fred Drake41deb1e2001-02-01 05:27:45 +000032static PyObject *
Larry Hastingsebdcb502013-11-23 14:54:00 -080033_weakref_getweakrefcount(PyModuleDef *module, PyObject *object)
Fred Drake41deb1e2001-02-01 05:27:45 +000034{
Larry Hastings31826802013-10-19 00:09:25 -070035 PyObject *return_value = NULL;
36 Py_ssize_t _return_value;
Larry Hastingsbebf7352014-01-17 17:47:17 -080037
Larry Hastingsed4a1c52013-11-18 09:32:13 -080038 _return_value = _weakref_getweakrefcount_impl(module, object);
Larry Hastings31826802013-10-19 00:09:25 -070039 if ((_return_value == -1) && PyErr_Occurred())
40 goto exit;
41 return_value = PyLong_FromSsize_t(_return_value);
Fred Drake41deb1e2001-02-01 05:27:45 +000042
Larry Hastings31826802013-10-19 00:09:25 -070043exit:
44 return return_value;
45}
Fred Drake41deb1e2001-02-01 05:27:45 +000046
Larry Hastings31826802013-10-19 00:09:25 -070047static Py_ssize_t
Larry Hastingsebdcb502013-11-23 14:54:00 -080048_weakref_getweakrefcount_impl(PyModuleDef *module, PyObject *object)
Larry Hastings581ee362014-01-28 05:00:08 -080049/*[clinic end generated code: output=ef51baac56180816 input=cedb69711b6a2507]*/
Larry Hastings31826802013-10-19 00:09:25 -070050{
51 PyWeakReference **list;
Fred Drake7fdc0a12001-08-16 14:11:30 +000052
Larry Hastings31826802013-10-19 00:09:25 -070053 if (!PyType_SUPPORTS_WEAKREFS(Py_TYPE(object)))
54 return 0;
Larry Hastings61272b72014-01-07 12:41:53 -080055
Larry Hastings31826802013-10-19 00:09:25 -070056 list = GET_WEAKREFS_LISTPTR(object);
57 return _PyWeakref_GetWeakrefCount(*list);
Fred Drake41deb1e2001-02-01 05:27:45 +000058}
59
60
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000061PyDoc_STRVAR(weakref_getweakrefs__doc__,
Fred Drake7855aba2001-02-18 05:20:18 +000062"getweakrefs(object) -- return a list of all weak reference objects\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000063"that point to 'object'.");
Fred Drake7855aba2001-02-18 05:20:18 +000064
Fred Drake41deb1e2001-02-01 05:27:45 +000065static PyObject *
Fred Drake7fdc0a12001-08-16 14:11:30 +000066weakref_getweakrefs(PyObject *self, PyObject *object)
Fred Drake41deb1e2001-02-01 05:27:45 +000067{
68 PyObject *result = NULL;
Fred Drake41deb1e2001-02-01 05:27:45 +000069
Christian Heimes90aa7642007-12-19 02:45:37 +000070 if (PyType_SUPPORTS_WEAKREFS(Py_TYPE(object))) {
Fred Drake7fdc0a12001-08-16 14:11:30 +000071 PyWeakReference **list = GET_WEAKREFS_LISTPTR(object);
Thomas Wouters0e3f5912006-08-11 14:57:12 +000072 Py_ssize_t count = _PyWeakref_GetWeakrefCount(*list);
Fred Drake41deb1e2001-02-01 05:27:45 +000073
Fred Drake7fdc0a12001-08-16 14:11:30 +000074 result = PyList_New(count);
75 if (result != NULL) {
76 PyWeakReference *current = *list;
Thomas Wouters0e3f5912006-08-11 14:57:12 +000077 Py_ssize_t i;
Fred Drake7fdc0a12001-08-16 14:11:30 +000078 for (i = 0; i < count; ++i) {
79 PyList_SET_ITEM(result, i, (PyObject *) current);
80 Py_INCREF(current);
81 current = current->wr_next;
Fred Drake41deb1e2001-02-01 05:27:45 +000082 }
83 }
Fred Drake7fdc0a12001-08-16 14:11:30 +000084 }
85 else {
86 result = PyList_New(0);
Fred Drake41deb1e2001-02-01 05:27:45 +000087 }
88 return result;
89}
90
91
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000092PyDoc_STRVAR(weakref_proxy__doc__,
Fred Drake7855aba2001-02-18 05:20:18 +000093"proxy(object[, callback]) -- create a proxy object that weakly\n"
94"references 'object'. 'callback', if given, is called with a\n"
Fred Drake610291c2002-08-02 20:23:40 +000095"reference to the proxy when 'object' is about to be finalized.");
Fred Drake7855aba2001-02-18 05:20:18 +000096
Fred Drake41deb1e2001-02-01 05:27:45 +000097static PyObject *
98weakref_proxy(PyObject *self, PyObject *args)
99{
100 PyObject *object;
101 PyObject *callback = NULL;
Fred Drakef7f8cad2001-10-05 22:00:24 +0000102 PyObject *result = NULL;
Fred Drake41deb1e2001-02-01 05:27:45 +0000103
Fred Drake0d429e82001-10-23 21:12:47 +0000104 if (PyArg_UnpackTuple(args, "proxy", 1, 2, &object, &callback)) {
Fred Drakef7f8cad2001-10-05 22:00:24 +0000105 result = PyWeakref_NewProxy(object, callback);
Fred Drake41deb1e2001-02-01 05:27:45 +0000106 }
Fred Drakef7f8cad2001-10-05 22:00:24 +0000107 return result;
Fred Drake41deb1e2001-02-01 05:27:45 +0000108}
109
110
111static PyMethodDef
112weakref_functions[] = {
Larry Hastings31826802013-10-19 00:09:25 -0700113 _WEAKREF_GETWEAKREFCOUNT_METHODDEF
Fred Drake7fdc0a12001-08-16 14:11:30 +0000114 {"getweakrefs", weakref_getweakrefs, METH_O,
Fred Drake7855aba2001-02-18 05:20:18 +0000115 weakref_getweakrefs__doc__},
116 {"proxy", weakref_proxy, METH_VARARGS,
117 weakref_proxy__doc__},
Fred Drake41deb1e2001-02-01 05:27:45 +0000118 {NULL, NULL, 0, NULL}
119};
120
121
Martin v. Löwis1a214512008-06-11 05:26:20 +0000122static struct PyModuleDef weakrefmodule = {
123 PyModuleDef_HEAD_INIT,
124 "_weakref",
125 "Weak-reference support module.",
126 -1,
127 weakref_functions,
128 NULL,
129 NULL,
130 NULL,
131 NULL
132};
133
Mark Hammondfe51c6d2002-08-02 02:27:13 +0000134PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +0000135PyInit__weakref(void)
Fred Drake41deb1e2001-02-01 05:27:45 +0000136{
137 PyObject *m;
138
Martin v. Löwis1a214512008-06-11 05:26:20 +0000139 m = PyModule_Create(&weakrefmodule);
Larry Hastings31826802013-10-19 00:09:25 -0700140
Fred Drake41deb1e2001-02-01 05:27:45 +0000141 if (m != NULL) {
Fred Drakef7f8cad2001-10-05 22:00:24 +0000142 Py_INCREF(&_PyWeakref_RefType);
Fred Drake0a4dd392004-07-02 18:57:45 +0000143 PyModule_AddObject(m, "ref",
144 (PyObject *) &_PyWeakref_RefType);
145 Py_INCREF(&_PyWeakref_RefType);
Fred Drake41deb1e2001-02-01 05:27:45 +0000146 PyModule_AddObject(m, "ReferenceType",
Fred Drakef7f8cad2001-10-05 22:00:24 +0000147 (PyObject *) &_PyWeakref_RefType);
148 Py_INCREF(&_PyWeakref_ProxyType);
Fred Drake41deb1e2001-02-01 05:27:45 +0000149 PyModule_AddObject(m, "ProxyType",
Fred Drakef7f8cad2001-10-05 22:00:24 +0000150 (PyObject *) &_PyWeakref_ProxyType);
151 Py_INCREF(&_PyWeakref_CallableProxyType);
Fred Drake41deb1e2001-02-01 05:27:45 +0000152 PyModule_AddObject(m, "CallableProxyType",
Fred Drakef7f8cad2001-10-05 22:00:24 +0000153 (PyObject *) &_PyWeakref_CallableProxyType);
Fred Drake41deb1e2001-02-01 05:27:45 +0000154 }
Martin v. Löwis1a214512008-06-11 05:26:20 +0000155 return m;
Fred Drake41deb1e2001-02-01 05:27:45 +0000156}