Skip to main content

pyo3_ffi/
dictobject.rs

1use crate::object::*;
2use crate::pyport::Py_ssize_t;
3use core::ffi::{c_char, c_int};
4
5#[cfg(not(RustPython))]
6extern_libpython! {
7    #[cfg_attr(PyPy, link_name = "PyPyDict_Type")]
8    pub static mut PyDict_Type: PyTypeObject;
9}
10
11#[inline]
12#[cfg(not(RustPython))]
13pub unsafe fn PyDict_Check(op: *mut PyObject) -> c_int {
14    PyType_FastSubclass(Py_TYPE(op), Py_TPFLAGS_DICT_SUBCLASS)
15}
16
17#[inline]
18#[cfg(not(RustPython))]
19pub unsafe fn PyDict_CheckExact(op: *mut PyObject) -> c_int {
20    Py_IS_TYPE(op, &raw mut PyDict_Type)
21}
22
23extern_libpython! {
24    #[cfg(RustPython)]
25    pub fn PyDict_Check(op: *mut PyObject) -> c_int;
26    #[cfg(RustPython)]
27    pub fn PyDict_CheckExact(op: *mut PyObject) -> c_int;
28
29    #[cfg_attr(PyPy, link_name = "PyPyDict_New")]
30    pub fn PyDict_New() -> *mut PyObject;
31    #[cfg_attr(PyPy, link_name = "PyPyDict_GetItem")]
32    pub fn PyDict_GetItem(mp: *mut PyObject, key: *mut PyObject) -> *mut PyObject;
33    #[cfg_attr(PyPy, link_name = "PyPyDict_GetItemWithError")]
34    pub fn PyDict_GetItemWithError(mp: *mut PyObject, key: *mut PyObject) -> *mut PyObject;
35    #[cfg_attr(PyPy, link_name = "PyPyDict_SetItem")]
36    pub fn PyDict_SetItem(mp: *mut PyObject, key: *mut PyObject, item: *mut PyObject) -> c_int;
37    #[cfg_attr(PyPy, link_name = "PyPyDict_DelItem")]
38    pub fn PyDict_DelItem(mp: *mut PyObject, key: *mut PyObject) -> c_int;
39    #[cfg_attr(PyPy, link_name = "PyPyDict_Clear")]
40    pub fn PyDict_Clear(mp: *mut PyObject);
41    #[cfg_attr(PyPy, link_name = "PyPyDict_Next")]
42    pub fn PyDict_Next(
43        mp: *mut PyObject,
44        pos: *mut Py_ssize_t,
45        key: *mut *mut PyObject,
46        value: *mut *mut PyObject,
47    ) -> c_int;
48    #[cfg_attr(PyPy, link_name = "PyPyDict_Keys")]
49    pub fn PyDict_Keys(mp: *mut PyObject) -> *mut PyObject;
50    #[cfg_attr(PyPy, link_name = "PyPyDict_Values")]
51    pub fn PyDict_Values(mp: *mut PyObject) -> *mut PyObject;
52    #[cfg_attr(PyPy, link_name = "PyPyDict_Items")]
53    pub fn PyDict_Items(mp: *mut PyObject) -> *mut PyObject;
54    #[cfg_attr(PyPy, link_name = "PyPyDict_Size")]
55    pub fn PyDict_Size(mp: *mut PyObject) -> Py_ssize_t;
56    #[cfg_attr(PyPy, link_name = "PyPyDict_Copy")]
57    pub fn PyDict_Copy(mp: *mut PyObject) -> *mut PyObject;
58    #[cfg_attr(PyPy, link_name = "PyPyDict_Contains")]
59    pub fn PyDict_Contains(mp: *mut PyObject, key: *mut PyObject) -> c_int;
60    #[cfg_attr(PyPy, link_name = "PyPyDict_Update")]
61    pub fn PyDict_Update(mp: *mut PyObject, other: *mut PyObject) -> c_int;
62    #[cfg_attr(PyPy, link_name = "PyPyDict_Merge")]
63    pub fn PyDict_Merge(mp: *mut PyObject, other: *mut PyObject, _override: c_int) -> c_int;
64    pub fn PyDict_MergeFromSeq2(d: *mut PyObject, seq2: *mut PyObject, _override: c_int) -> c_int;
65    #[cfg_attr(PyPy, link_name = "PyPyDict_GetItemString")]
66    pub fn PyDict_GetItemString(dp: *mut PyObject, key: *const c_char) -> *mut PyObject;
67    #[cfg_attr(PyPy, link_name = "PyPyDict_SetItemString")]
68    pub fn PyDict_SetItemString(
69        dp: *mut PyObject,
70        key: *const c_char,
71        item: *mut PyObject,
72    ) -> c_int;
73    #[cfg_attr(PyPy, link_name = "PyPyDict_DelItemString")]
74    pub fn PyDict_DelItemString(dp: *mut PyObject, key: *const c_char) -> c_int;
75    #[cfg(Py_3_13)]
76    #[cfg_attr(PyPy, link_name = "PyPyDict_GetItemRef")]
77    pub fn PyDict_GetItemRef(
78        dp: *mut PyObject,
79        key: *mut PyObject,
80        result: *mut *mut PyObject,
81    ) -> c_int;
82    #[cfg(Py_3_13)]
83    #[cfg_attr(PyPy, link_name = "PyPyDict_GetItemStringRef")]
84    pub fn PyDict_GetItemStringRef(
85        dp: *mut PyObject,
86        key: *const c_char,
87        result: *mut *mut PyObject,
88    ) -> c_int;
89    #[cfg(all(Py_3_13, any(not(Py_LIMITED_API), Py_3_15)))]
90    pub fn PyDict_SetDefaultRef(
91        mp: *mut PyObject,
92        key: *mut PyObject,
93        default_value: *mut PyObject,
94        result: *mut *mut PyObject,
95    ) -> c_int;
96    // skipped 3.10 / ex-non-limited PyObject_GenericGetDict
97}
98
99#[cfg(not(RustPython))]
100extern_libpython! {
101    pub static mut PyDictKeys_Type: PyTypeObject;
102    pub static mut PyDictValues_Type: PyTypeObject;
103    pub static mut PyDictItems_Type: PyTypeObject;
104}
105
106#[inline]
107#[cfg(not(RustPython))]
108pub unsafe fn PyDictKeys_Check(op: *mut PyObject) -> c_int {
109    PyObject_TypeCheck(op, &raw mut PyDictKeys_Type)
110}
111
112#[inline]
113#[cfg(not(RustPython))]
114pub unsafe fn PyDictValues_Check(op: *mut PyObject) -> c_int {
115    PyObject_TypeCheck(op, &raw mut PyDictValues_Type)
116}
117
118#[inline]
119#[cfg(not(RustPython))]
120pub unsafe fn PyDictItems_Check(op: *mut PyObject) -> c_int {
121    PyObject_TypeCheck(op, &raw mut PyDictItems_Type)
122}
123
124extern_libpython! {
125    #[cfg(RustPython)]
126    pub fn PyDictKeys_Check(op: *mut PyObject) -> c_int;
127    #[cfg(RustPython)]
128    pub fn PyDictValues_Check(op: *mut PyObject) -> c_int;
129    #[cfg(RustPython)]
130    pub fn PyDictItems_Check(op: *mut PyObject) -> c_int;
131}
132
133#[inline]
134pub unsafe fn PyDictViewSet_Check(op: *mut PyObject) -> c_int {
135    (PyDictKeys_Check(op) != 0 || PyDictItems_Check(op) != 0) as c_int
136}
137
138#[cfg(not(RustPython))]
139extern_libpython! {
140    pub static mut PyDictIterKey_Type: PyTypeObject;
141    pub static mut PyDictIterValue_Type: PyTypeObject;
142    pub static mut PyDictIterItem_Type: PyTypeObject;
143    pub static mut PyDictRevIterKey_Type: PyTypeObject;
144    pub static mut PyDictRevIterValue_Type: PyTypeObject;
145    pub static mut PyDictRevIterItem_Type: PyTypeObject;
146}
147
148#[cfg(any(GraalPy, Py_LIMITED_API))]
149// TODO: remove (see https://github.com/PyO3/pyo3/pull/1341#issuecomment-751515985)
150opaque_struct!(pub PyDictObject);