Skip to main content

pyforge_ffi/
abstract_.rs

1use crate::object::*;
2use crate::pyport::Py_ssize_t;
3#[cfg(any(Py_3_12, not(Py_LIMITED_API)))]
4use libc::size_t;
5use std::ffi::{c_char, c_int};
6
7#[inline]
8#[cfg(not(Py_3_13))] // CPython exposed as a function in 3.13, in object.h
9pub unsafe fn PyObject_DelAttrString(o: *mut PyObject, attr_name: *const c_char) -> c_int {
10    PyObject_SetAttrString(o, attr_name, std::ptr::null_mut())
11}
12
13#[inline]
14#[cfg(not(Py_3_13))] // CPython exposed as a function in 3.13, in object.h
15pub unsafe fn PyObject_DelAttr(o: *mut PyObject, attr_name: *mut PyObject) -> c_int {
16    PyObject_SetAttr(o, attr_name, std::ptr::null_mut())
17}
18
19extern_libpython! {
20    #[cfg(any(Py_3_10, all(not(Py_LIMITED_API), Py_3_9)))] // Added to python in 3.9 but to limited API in 3.10
21    pub fn PyObject_CallNoArgs(func: *mut PyObject) -> *mut PyObject;
22    pub fn PyObject_Call(
23        callable_object: *mut PyObject,
24        args: *mut PyObject,
25        kw: *mut PyObject,
26    ) -> *mut PyObject;
27    pub fn PyObject_CallObject(
28        callable_object: *mut PyObject,
29        args: *mut PyObject,
30    ) -> *mut PyObject;
31    pub fn PyObject_CallFunction(
32        callable_object: *mut PyObject,
33        format: *const c_char,
34        ...
35    ) -> *mut PyObject;
36    pub fn PyObject_CallMethod(
37        o: *mut PyObject,
38        method: *const c_char,
39        format: *const c_char,
40        ...
41    ) -> *mut PyObject;
42
43    #[cfg(not(Py_3_13))]
44    pub fn _PyObject_CallFunction_SizeT(
45        callable_object: *mut PyObject,
46        format: *const c_char,
47        ...
48    ) -> *mut PyObject;
49    #[cfg(not(Py_3_13))]
50    pub fn _PyObject_CallMethod_SizeT(
51        o: *mut PyObject,
52        method: *const c_char,
53        format: *const c_char,
54        ...
55    ) -> *mut PyObject;
56
57    pub fn PyObject_CallFunctionObjArgs(callable: *mut PyObject, ...) -> *mut PyObject;
58    pub fn PyObject_CallMethodObjArgs(
59        o: *mut PyObject,
60        method: *mut PyObject,
61        ...
62    ) -> *mut PyObject;
63}
64#[cfg(any(Py_3_12, not(Py_LIMITED_API)))]
65pub const PY_VECTORCALL_ARGUMENTS_OFFSET: size_t =
66    1 << (8 * std::mem::size_of::<size_t>() as size_t - 1);
67
68extern_libpython! {
69    #[cfg(any(Py_3_12, all(Py_3_11, not(Py_LIMITED_API))))]
70    pub fn PyObject_Vectorcall(
71        callable: *mut PyObject,
72        args: *const *mut PyObject,
73        nargsf: size_t,
74        kwnames: *mut PyObject,
75    ) -> *mut PyObject;
76
77    #[cfg(any(Py_3_12, all(Py_3_9, not(Py_LIMITED_API))))]
78    pub fn PyObject_VectorcallMethod(
79        name: *mut PyObject,
80        args: *const *mut PyObject,
81        nargsf: size_t,
82        kwnames: *mut PyObject,
83    ) -> *mut PyObject;
84    pub fn PyObject_Type(o: *mut PyObject) -> *mut PyObject;
85    pub fn PyObject_Size(o: *mut PyObject) -> Py_ssize_t;
86}
87
88#[inline]
89pub unsafe fn PyObject_Length(o: *mut PyObject) -> Py_ssize_t {
90    PyObject_Size(o)
91}
92
93extern_libpython! {
94    pub fn PyObject_GetItem(o: *mut PyObject, key: *mut PyObject) -> *mut PyObject;
95    pub fn PyObject_SetItem(o: *mut PyObject, key: *mut PyObject, v: *mut PyObject) -> c_int;
96    pub fn PyObject_DelItemString(o: *mut PyObject, key: *const c_char) -> c_int;
97    pub fn PyObject_DelItem(o: *mut PyObject, key: *mut PyObject) -> c_int;
98}
99
100extern_libpython! {
101    pub fn PyObject_Format(obj: *mut PyObject, format_spec: *mut PyObject) -> *mut PyObject;
102    pub fn PyObject_GetIter(arg1: *mut PyObject) -> *mut PyObject;
103}
104
105extern_libpython! {
106    pub fn PyIter_Check(obj: *mut PyObject) -> c_int;
107
108    #[cfg(Py_3_14)]
109    pub fn PyIter_NextItem(iter: *mut PyObject, item: *mut *mut PyObject) -> c_int;
110    pub fn PyIter_Next(arg1: *mut PyObject) -> *mut PyObject;
111    #[cfg(Py_3_10)]
112    pub fn PyIter_Send(
113        iter: *mut PyObject,
114        arg: *mut PyObject,
115        presult: *mut *mut PyObject,
116    ) -> PySendResult;
117
118    pub fn PyNumber_Check(o: *mut PyObject) -> c_int;
119    pub fn PyNumber_Add(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
120    pub fn PyNumber_Subtract(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
121    pub fn PyNumber_Multiply(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
122    pub fn PyNumber_MatrixMultiply(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
123    pub fn PyNumber_FloorDivide(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
124    pub fn PyNumber_TrueDivide(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
125    pub fn PyNumber_Remainder(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
126    pub fn PyNumber_Divmod(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
127    pub fn PyNumber_Power(o1: *mut PyObject, o2: *mut PyObject, o3: *mut PyObject)
128        -> *mut PyObject;
129    pub fn PyNumber_Negative(o: *mut PyObject) -> *mut PyObject;
130    pub fn PyNumber_Positive(o: *mut PyObject) -> *mut PyObject;
131    pub fn PyNumber_Absolute(o: *mut PyObject) -> *mut PyObject;
132    pub fn PyNumber_Invert(o: *mut PyObject) -> *mut PyObject;
133    pub fn PyNumber_Lshift(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
134    pub fn PyNumber_Rshift(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
135    pub fn PyNumber_And(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
136    pub fn PyNumber_Xor(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
137    pub fn PyNumber_Or(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
138}
139
140// Defined as this macro in Python limited API, but relies on
141// non-limited PyTypeObject. Don't expose this since it cannot be used.
142#[cfg(not(Py_LIMITED_API))]
143#[inline]
144pub unsafe fn PyIndex_Check(o: *mut PyObject) -> c_int {
145    let tp_as_number = (*Py_TYPE(o)).tp_as_number;
146    (!tp_as_number.is_null() && (*tp_as_number).nb_index.is_some()) as c_int
147}
148
149extern_libpython! {
150    #[cfg(Py_LIMITED_API)]
151    pub fn PyIndex_Check(o: *mut PyObject) -> c_int;
152
153    pub fn PyNumber_Index(o: *mut PyObject) -> *mut PyObject;
154    pub fn PyNumber_AsSsize_t(o: *mut PyObject, exc: *mut PyObject) -> Py_ssize_t;
155    pub fn PyNumber_Long(o: *mut PyObject) -> *mut PyObject;
156    pub fn PyNumber_Float(o: *mut PyObject) -> *mut PyObject;
157    pub fn PyNumber_InPlaceAdd(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
158    pub fn PyNumber_InPlaceSubtract(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
159    pub fn PyNumber_InPlaceMultiply(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
160    pub fn PyNumber_InPlaceMatrixMultiply(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
161    pub fn PyNumber_InPlaceFloorDivide(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
162    pub fn PyNumber_InPlaceTrueDivide(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
163    pub fn PyNumber_InPlaceRemainder(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
164    pub fn PyNumber_InPlacePower(
165        o1: *mut PyObject,
166        o2: *mut PyObject,
167        o3: *mut PyObject,
168    ) -> *mut PyObject;
169    pub fn PyNumber_InPlaceLshift(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
170    pub fn PyNumber_InPlaceRshift(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
171    pub fn PyNumber_InPlaceAnd(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
172    pub fn PyNumber_InPlaceXor(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
173    pub fn PyNumber_InPlaceOr(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
174    pub fn PyNumber_ToBase(n: *mut PyObject, base: c_int) -> *mut PyObject;
175
176    pub fn PySequence_Check(o: *mut PyObject) -> c_int;
177    pub fn PySequence_Size(o: *mut PyObject) -> Py_ssize_t;
178
179}
180
181#[inline]
182pub unsafe fn PySequence_Length(o: *mut PyObject) -> Py_ssize_t {
183    PySequence_Size(o)
184}
185
186extern_libpython! {
187    pub fn PySequence_Concat(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
188    pub fn PySequence_Repeat(o: *mut PyObject, count: Py_ssize_t) -> *mut PyObject;
189    pub fn PySequence_GetItem(o: *mut PyObject, i: Py_ssize_t) -> *mut PyObject;
190    pub fn PySequence_GetSlice(o: *mut PyObject, i1: Py_ssize_t, i2: Py_ssize_t) -> *mut PyObject;
191    pub fn PySequence_SetItem(o: *mut PyObject, i: Py_ssize_t, v: *mut PyObject) -> c_int;
192    pub fn PySequence_DelItem(o: *mut PyObject, i: Py_ssize_t) -> c_int;
193    pub fn PySequence_SetSlice(
194        o: *mut PyObject,
195        i1: Py_ssize_t,
196        i2: Py_ssize_t,
197        v: *mut PyObject,
198    ) -> c_int;
199    pub fn PySequence_DelSlice(o: *mut PyObject, i1: Py_ssize_t, i2: Py_ssize_t) -> c_int;
200    pub fn PySequence_Tuple(o: *mut PyObject) -> *mut PyObject;
201    pub fn PySequence_List(o: *mut PyObject) -> *mut PyObject;
202    pub fn PySequence_Fast(o: *mut PyObject, m: *const c_char) -> *mut PyObject;
203    // skipped PySequence_Fast_GET_SIZE
204    // skipped PySequence_Fast_GET_ITEM
205    // skipped PySequence_Fast_GET_ITEMS
206    pub fn PySequence_Count(o: *mut PyObject, value: *mut PyObject) -> Py_ssize_t;
207    pub fn PySequence_Contains(seq: *mut PyObject, ob: *mut PyObject) -> c_int;
208}
209
210#[inline]
211pub unsafe fn PySequence_In(o: *mut PyObject, value: *mut PyObject) -> c_int {
212    PySequence_Contains(o, value)
213}
214
215extern_libpython! {
216    pub fn PySequence_Index(o: *mut PyObject, value: *mut PyObject) -> Py_ssize_t;
217    pub fn PySequence_InPlaceConcat(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
218    pub fn PySequence_InPlaceRepeat(o: *mut PyObject, count: Py_ssize_t) -> *mut PyObject;
219    pub fn PyMapping_Check(o: *mut PyObject) -> c_int;
220    pub fn PyMapping_Size(o: *mut PyObject) -> Py_ssize_t;
221
222}
223
224#[inline]
225pub unsafe fn PyMapping_Length(o: *mut PyObject) -> Py_ssize_t {
226    PyMapping_Size(o)
227}
228
229#[inline]
230pub unsafe fn PyMapping_DelItemString(o: *mut PyObject, key: *mut c_char) -> c_int {
231    PyObject_DelItemString(o, key)
232}
233
234#[inline]
235pub unsafe fn PyMapping_DelItem(o: *mut PyObject, key: *mut PyObject) -> c_int {
236    PyObject_DelItem(o, key)
237}
238
239extern_libpython! {
240    pub fn PyMapping_HasKeyString(o: *mut PyObject, key: *const c_char) -> c_int;
241    pub fn PyMapping_HasKey(o: *mut PyObject, key: *mut PyObject) -> c_int;
242    pub fn PyMapping_Keys(o: *mut PyObject) -> *mut PyObject;
243    pub fn PyMapping_Values(o: *mut PyObject) -> *mut PyObject;
244    pub fn PyMapping_Items(o: *mut PyObject) -> *mut PyObject;
245    pub fn PyMapping_GetItemString(o: *mut PyObject, key: *const c_char) -> *mut PyObject;
246    pub fn PyMapping_SetItemString(
247        o: *mut PyObject,
248        key: *const c_char,
249        value: *mut PyObject,
250    ) -> c_int;
251    pub fn PyObject_IsInstance(object: *mut PyObject, typeorclass: *mut PyObject) -> c_int;
252    pub fn PyObject_IsSubclass(object: *mut PyObject, typeorclass: *mut PyObject) -> c_int;
253}