Skip to main content

pyforge_ffi/
dictobject.rs

1use crate::object::*;
2use crate::pyport::Py_ssize_t;
3use std::ffi::{c_char, c_int};
4
5extern_libpython! {
6    pub static mut PyDict_Type: PyTypeObject;
7}
8
9#[inline]
10pub unsafe fn PyDict_Check(op: *mut PyObject) -> c_int {
11    PyType_FastSubclass(Py_TYPE(op), Py_TPFLAGS_DICT_SUBCLASS)
12}
13
14#[inline]
15pub unsafe fn PyDict_CheckExact(op: *mut PyObject) -> c_int {
16    (Py_TYPE(op) == &raw mut PyDict_Type) as c_int
17}
18
19extern_libpython! {
20    pub fn PyDict_New() -> *mut PyObject;
21    pub fn PyDict_GetItem(mp: *mut PyObject, key: *mut PyObject) -> *mut PyObject;
22    pub fn PyDict_GetItemWithError(mp: *mut PyObject, key: *mut PyObject) -> *mut PyObject;
23    pub fn PyDict_SetItem(mp: *mut PyObject, key: *mut PyObject, item: *mut PyObject) -> c_int;
24    pub fn PyDict_DelItem(mp: *mut PyObject, key: *mut PyObject) -> c_int;
25    pub fn PyDict_Clear(mp: *mut PyObject);
26    pub fn PyDict_Next(
27        mp: *mut PyObject,
28        pos: *mut Py_ssize_t,
29        key: *mut *mut PyObject,
30        value: *mut *mut PyObject,
31    ) -> c_int;
32    pub fn PyDict_Keys(mp: *mut PyObject) -> *mut PyObject;
33    pub fn PyDict_Values(mp: *mut PyObject) -> *mut PyObject;
34    pub fn PyDict_Items(mp: *mut PyObject) -> *mut PyObject;
35    pub fn PyDict_Size(mp: *mut PyObject) -> Py_ssize_t;
36    pub fn PyDict_Copy(mp: *mut PyObject) -> *mut PyObject;
37    pub fn PyDict_Contains(mp: *mut PyObject, key: *mut PyObject) -> c_int;
38    pub fn PyDict_Update(mp: *mut PyObject, other: *mut PyObject) -> c_int;
39    pub fn PyDict_Merge(mp: *mut PyObject, other: *mut PyObject, _override: c_int) -> c_int;
40    pub fn PyDict_MergeFromSeq2(d: *mut PyObject, seq2: *mut PyObject, _override: c_int) -> c_int;
41    pub fn PyDict_GetItemString(dp: *mut PyObject, key: *const c_char) -> *mut PyObject;
42    pub fn PyDict_SetItemString(
43        dp: *mut PyObject,
44        key: *const c_char,
45        item: *mut PyObject,
46    ) -> c_int;
47    pub fn PyDict_DelItemString(dp: *mut PyObject, key: *const c_char) -> c_int;
48    #[cfg(Py_3_13)]
49    pub fn PyDict_GetItemRef(
50        dp: *mut PyObject,
51        key: *mut PyObject,
52        result: *mut *mut PyObject,
53    ) -> c_int;
54    #[cfg(Py_3_13)]
55    pub fn PyDict_GetItemStringRef(
56        dp: *mut PyObject,
57        key: *const c_char,
58        result: *mut *mut PyObject,
59    ) -> c_int;
60    // skipped 3.10 / ex-non-limited PyObject_GenericGetDict
61}
62
63extern_libpython! {
64    pub static mut PyDictKeys_Type: PyTypeObject;
65    pub static mut PyDictValues_Type: PyTypeObject;
66    pub static mut PyDictItems_Type: PyTypeObject;
67}
68
69#[inline]
70pub unsafe fn PyDictKeys_Check(op: *mut PyObject) -> c_int {
71    PyObject_TypeCheck(op, &raw mut PyDictKeys_Type)
72}
73
74#[inline]
75pub unsafe fn PyDictValues_Check(op: *mut PyObject) -> c_int {
76    PyObject_TypeCheck(op, &raw mut PyDictValues_Type)
77}
78
79#[inline]
80pub unsafe fn PyDictItems_Check(op: *mut PyObject) -> c_int {
81    PyObject_TypeCheck(op, &raw mut PyDictItems_Type)
82}
83
84#[inline]
85pub unsafe fn PyDictViewSet_Check(op: *mut PyObject) -> c_int {
86    (PyDictKeys_Check(op) != 0 || PyDictItems_Check(op) != 0) as c_int
87}
88
89extern_libpython! {
90    pub static mut PyDictIterKey_Type: PyTypeObject;
91    pub static mut PyDictIterValue_Type: PyTypeObject;
92    pub static mut PyDictIterItem_Type: PyTypeObject;
93    pub static mut PyDictRevIterKey_Type: PyTypeObject;
94    pub static mut PyDictRevIterValue_Type: PyTypeObject;
95    pub static mut PyDictRevIterItem_Type: PyTypeObject;
96}
97
98#[cfg(Py_LIMITED_API)]
99// TODO: remove (see https://github.com/PyForge/pyo3/pull/1341#issuecomment-751515985)
100opaque_struct!(pub PyDictObject);