blob: 7c99d7e7865bff3fb9aebb2da820d0b3d49c5a69 [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
Serhiy Storchaka1009bf12015-04-03 23:53:51 +030012#include "clinic/_weakref.c.h"
13
Larry Hastings61272b72014-01-07 12:41:53 -080014/*[clinic input]
Larry Hastings31826802013-10-19 00:09:25 -070015
16_weakref.getweakrefcount -> Py_ssize_t
17
18 object: object
19 /
20
21Return the number of weak references to 'object'.
Larry Hastings61272b72014-01-07 12:41:53 -080022[clinic start generated code]*/
Larry Hastings31826802013-10-19 00:09:25 -070023
Larry Hastings31826802013-10-19 00:09:25 -070024static Py_ssize_t
Larry Hastingsebdcb502013-11-23 14:54:00 -080025_weakref_getweakrefcount_impl(PyModuleDef *module, PyObject *object)
Serhiy Storchaka1009bf12015-04-03 23:53:51 +030026/*[clinic end generated code: output=6a6ad0b98285e468 input=cedb69711b6a2507]*/
Larry Hastings31826802013-10-19 00:09:25 -070027{
28 PyWeakReference **list;
Fred Drake7fdc0a12001-08-16 14:11:30 +000029
Larry Hastings31826802013-10-19 00:09:25 -070030 if (!PyType_SUPPORTS_WEAKREFS(Py_TYPE(object)))
31 return 0;
Larry Hastings61272b72014-01-07 12:41:53 -080032
Larry Hastings31826802013-10-19 00:09:25 -070033 list = GET_WEAKREFS_LISTPTR(object);
34 return _PyWeakref_GetWeakrefCount(*list);
Fred Drake41deb1e2001-02-01 05:27:45 +000035}
36
37
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000038PyDoc_STRVAR(weakref_getweakrefs__doc__,
Fred Drake7855aba2001-02-18 05:20:18 +000039"getweakrefs(object) -- return a list of all weak reference objects\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000040"that point to 'object'.");
Fred Drake7855aba2001-02-18 05:20:18 +000041
Fred Drake41deb1e2001-02-01 05:27:45 +000042static PyObject *
Fred Drake7fdc0a12001-08-16 14:11:30 +000043weakref_getweakrefs(PyObject *self, PyObject *object)
Fred Drake41deb1e2001-02-01 05:27:45 +000044{
45 PyObject *result = NULL;
Fred Drake41deb1e2001-02-01 05:27:45 +000046
Christian Heimes90aa7642007-12-19 02:45:37 +000047 if (PyType_SUPPORTS_WEAKREFS(Py_TYPE(object))) {
Fred Drake7fdc0a12001-08-16 14:11:30 +000048 PyWeakReference **list = GET_WEAKREFS_LISTPTR(object);
Thomas Wouters0e3f5912006-08-11 14:57:12 +000049 Py_ssize_t count = _PyWeakref_GetWeakrefCount(*list);
Fred Drake41deb1e2001-02-01 05:27:45 +000050
Fred Drake7fdc0a12001-08-16 14:11:30 +000051 result = PyList_New(count);
52 if (result != NULL) {
53 PyWeakReference *current = *list;
Thomas Wouters0e3f5912006-08-11 14:57:12 +000054 Py_ssize_t i;
Fred Drake7fdc0a12001-08-16 14:11:30 +000055 for (i = 0; i < count; ++i) {
56 PyList_SET_ITEM(result, i, (PyObject *) current);
57 Py_INCREF(current);
58 current = current->wr_next;
Fred Drake41deb1e2001-02-01 05:27:45 +000059 }
60 }
Fred Drake7fdc0a12001-08-16 14:11:30 +000061 }
62 else {
63 result = PyList_New(0);
Fred Drake41deb1e2001-02-01 05:27:45 +000064 }
65 return result;
66}
67
68
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000069PyDoc_STRVAR(weakref_proxy__doc__,
Fred Drake7855aba2001-02-18 05:20:18 +000070"proxy(object[, callback]) -- create a proxy object that weakly\n"
71"references 'object'. 'callback', if given, is called with a\n"
Fred Drake610291c2002-08-02 20:23:40 +000072"reference to the proxy when 'object' is about to be finalized.");
Fred Drake7855aba2001-02-18 05:20:18 +000073
Fred Drake41deb1e2001-02-01 05:27:45 +000074static PyObject *
75weakref_proxy(PyObject *self, PyObject *args)
76{
77 PyObject *object;
78 PyObject *callback = NULL;
Fred Drakef7f8cad2001-10-05 22:00:24 +000079 PyObject *result = NULL;
Fred Drake41deb1e2001-02-01 05:27:45 +000080
Fred Drake0d429e82001-10-23 21:12:47 +000081 if (PyArg_UnpackTuple(args, "proxy", 1, 2, &object, &callback)) {
Fred Drakef7f8cad2001-10-05 22:00:24 +000082 result = PyWeakref_NewProxy(object, callback);
Fred Drake41deb1e2001-02-01 05:27:45 +000083 }
Fred Drakef7f8cad2001-10-05 22:00:24 +000084 return result;
Fred Drake41deb1e2001-02-01 05:27:45 +000085}
86
87
88static PyMethodDef
89weakref_functions[] = {
Larry Hastings31826802013-10-19 00:09:25 -070090 _WEAKREF_GETWEAKREFCOUNT_METHODDEF
Fred Drake7fdc0a12001-08-16 14:11:30 +000091 {"getweakrefs", weakref_getweakrefs, METH_O,
Fred Drake7855aba2001-02-18 05:20:18 +000092 weakref_getweakrefs__doc__},
93 {"proxy", weakref_proxy, METH_VARARGS,
94 weakref_proxy__doc__},
Fred Drake41deb1e2001-02-01 05:27:45 +000095 {NULL, NULL, 0, NULL}
96};
97
98
Martin v. Löwis1a214512008-06-11 05:26:20 +000099static struct PyModuleDef weakrefmodule = {
100 PyModuleDef_HEAD_INIT,
101 "_weakref",
102 "Weak-reference support module.",
103 -1,
104 weakref_functions,
105 NULL,
106 NULL,
107 NULL,
108 NULL
109};
110
Mark Hammondfe51c6d2002-08-02 02:27:13 +0000111PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +0000112PyInit__weakref(void)
Fred Drake41deb1e2001-02-01 05:27:45 +0000113{
114 PyObject *m;
115
Martin v. Löwis1a214512008-06-11 05:26:20 +0000116 m = PyModule_Create(&weakrefmodule);
Larry Hastings31826802013-10-19 00:09:25 -0700117
Fred Drake41deb1e2001-02-01 05:27:45 +0000118 if (m != NULL) {
Fred Drakef7f8cad2001-10-05 22:00:24 +0000119 Py_INCREF(&_PyWeakref_RefType);
Fred Drake0a4dd392004-07-02 18:57:45 +0000120 PyModule_AddObject(m, "ref",
121 (PyObject *) &_PyWeakref_RefType);
122 Py_INCREF(&_PyWeakref_RefType);
Fred Drake41deb1e2001-02-01 05:27:45 +0000123 PyModule_AddObject(m, "ReferenceType",
Fred Drakef7f8cad2001-10-05 22:00:24 +0000124 (PyObject *) &_PyWeakref_RefType);
125 Py_INCREF(&_PyWeakref_ProxyType);
Fred Drake41deb1e2001-02-01 05:27:45 +0000126 PyModule_AddObject(m, "ProxyType",
Fred Drakef7f8cad2001-10-05 22:00:24 +0000127 (PyObject *) &_PyWeakref_ProxyType);
128 Py_INCREF(&_PyWeakref_CallableProxyType);
Fred Drake41deb1e2001-02-01 05:27:45 +0000129 PyModule_AddObject(m, "CallableProxyType",
Fred Drakef7f8cad2001-10-05 22:00:24 +0000130 (PyObject *) &_PyWeakref_CallableProxyType);
Fred Drake41deb1e2001-02-01 05:27:45 +0000131 }
Martin v. Löwis1a214512008-06-11 05:26:20 +0000132 return m;
Fred Drake41deb1e2001-02-01 05:27:45 +0000133}