Skip to main content

pyo3_ffi/
weakrefobject.rs

1use crate::object::*;
2use std::ffi::c_int;
3
4#[cfg(all(not(PyPy), Py_LIMITED_API, not(GraalPy)))]
5opaque_struct!(pub PyWeakReference);
6
7#[cfg(all(not(PyPy), not(Py_LIMITED_API), not(GraalPy)))]
8pub use crate::_PyWeakReference as PyWeakReference;
9
10extern_libpython! {
11    // TODO: PyO3 is depending on this symbol in `reference.rs`, we should change this and
12    // remove the export as this is a private symbol.
13    pub static mut _PyWeakref_RefType: PyTypeObject;
14    static mut _PyWeakref_ProxyType: PyTypeObject;
15    static mut _PyWeakref_CallableProxyType: PyTypeObject;
16
17    #[cfg(PyPy)]
18    #[link_name = "PyPyWeakref_CheckRef"]
19    pub fn PyWeakref_CheckRef(op: *mut PyObject) -> c_int;
20
21    #[cfg(PyPy)]
22    #[link_name = "PyPyWeakref_CheckRefExact"]
23    pub fn PyWeakref_CheckRefExact(op: *mut PyObject) -> c_int;
24
25    #[cfg(PyPy)]
26    #[link_name = "PyPyWeakref_CheckProxy"]
27    pub fn PyWeakref_CheckProxy(op: *mut PyObject) -> c_int;
28}
29
30#[inline]
31#[cfg(not(PyPy))]
32pub unsafe fn PyWeakref_CheckRef(op: *mut PyObject) -> c_int {
33    PyObject_TypeCheck(op, &raw mut _PyWeakref_RefType)
34}
35
36#[inline]
37#[cfg(not(PyPy))]
38pub unsafe fn PyWeakref_CheckRefExact(op: *mut PyObject) -> c_int {
39    (Py_TYPE(op) == &raw mut _PyWeakref_RefType) as c_int
40}
41
42#[inline]
43#[cfg(not(PyPy))]
44pub unsafe fn PyWeakref_CheckProxy(op: *mut PyObject) -> c_int {
45    ((Py_TYPE(op) == &raw mut _PyWeakref_ProxyType)
46        || (Py_TYPE(op) == &raw mut _PyWeakref_CallableProxyType)) as c_int
47}
48
49#[inline]
50pub unsafe fn PyWeakref_Check(op: *mut PyObject) -> c_int {
51    (PyWeakref_CheckRef(op) != 0 || PyWeakref_CheckProxy(op) != 0) as c_int
52}
53
54extern_libpython! {
55    #[cfg_attr(PyPy, link_name = "PyPyWeakref_NewRef")]
56    pub fn PyWeakref_NewRef(ob: *mut PyObject, callback: *mut PyObject) -> *mut PyObject;
57    #[cfg_attr(PyPy, link_name = "PyPyWeakref_NewProxy")]
58    pub fn PyWeakref_NewProxy(ob: *mut PyObject, callback: *mut PyObject) -> *mut PyObject;
59    #[cfg_attr(PyPy, link_name = "PyPyWeakref_GetObject")]
60    #[cfg_attr(
61        Py_3_13,
62        deprecated(note = "deprecated since Python 3.13. Use `PyWeakref_GetRef` instead.")
63    )]
64    pub fn PyWeakref_GetObject(reference: *mut PyObject) -> *mut PyObject;
65    #[cfg(Py_3_13)]
66    #[cfg_attr(PyPy, link_name = "PyPyWeakref_GetRef")]
67    pub fn PyWeakref_GetRef(reference: *mut PyObject, pobj: *mut *mut PyObject) -> c_int;
68}