python3_sys/
objectabstract.rs

1use core::ptr;
2use libc::{c_char, c_int, c_void};
3
4use crate::object::*;
5use crate::pyport::Py_ssize_t;
6
7#[inline]
8pub unsafe fn PyObject_DelAttrString(o: *mut PyObject, attr_name: *const c_char) -> c_int {
9    PyObject_SetAttrString(o, attr_name, ptr::null_mut())
10}
11
12#[inline]
13pub unsafe fn PyObject_DelAttr(o: *mut PyObject, attr_name: *mut PyObject) -> c_int {
14    PyObject_SetAttr(o, attr_name, ptr::null_mut())
15}
16
17#[cfg_attr(windows, link(name = "pythonXY"))]
18extern "C" {
19    #[cfg(Py_3_9)]
20    pub fn PyObject_CallNoArgs(func: *mut PyObject) -> *mut PyObject;
21
22    pub fn PyObject_Call(
23        callable: *mut PyObject,
24        args: *mut PyObject,
25        kwargs: *mut PyObject,
26    ) -> *mut PyObject;
27    pub fn PyObject_CallObject(callable: *mut PyObject, args: *mut PyObject) -> *mut PyObject;
28    pub fn PyObject_CallFunction(
29        callable: *mut PyObject,
30        format: *const c_char,
31        ...
32    ) -> *mut PyObject;
33    pub fn PyObject_CallMethod(
34        obj: *mut PyObject,
35        name: *const c_char,
36        format: *const c_char,
37        ...
38    ) -> *mut PyObject;
39
40    pub fn PyObject_CallFunctionObjArgs(callable: *mut PyObject, ...) -> *mut PyObject;
41    pub fn PyObject_CallMethodObjArgs(
42        obj: *mut PyObject,
43        name: *mut PyObject,
44        ...
45    ) -> *mut PyObject;
46    pub fn PyObject_Type(o: *mut PyObject) -> *mut PyObject;
47    pub fn PyObject_Size(o: *mut PyObject) -> Py_ssize_t;
48}
49
50#[inline]
51pub unsafe fn PyObject_Length(o: *mut PyObject) -> Py_ssize_t {
52    PyObject_Size(o)
53}
54
55#[cfg_attr(windows, link(name = "pythonXY"))]
56extern "C" {
57    #[cfg(all(not(Py_LIMITED_API), Py_3_4))]
58    pub fn PyObject_LengthHint(o: *mut PyObject, arg1: Py_ssize_t) -> Py_ssize_t;
59
60    pub fn PyObject_GetItem(o: *mut PyObject, key: *mut PyObject) -> *mut PyObject;
61    pub fn PyObject_SetItem(o: *mut PyObject, key: *mut PyObject, v: *mut PyObject) -> c_int;
62    pub fn PyObject_DelItemString(o: *mut PyObject, key: *const c_char) -> c_int;
63    pub fn PyObject_DelItem(o: *mut PyObject, key: *mut PyObject) -> c_int;
64    #[deprecated(since = "0.2.1", note = "Old Buffer API")]
65    pub fn PyObject_AsCharBuffer(
66        obj: *mut PyObject,
67        buffer: *mut *const c_char,
68        buffer_len: *mut Py_ssize_t,
69    ) -> c_int;
70    #[deprecated(since = "0.2.1", note = "Old Buffer API")]
71    pub fn PyObject_CheckReadBuffer(obj: *mut PyObject) -> c_int;
72    #[deprecated(since = "0.2.1", note = "Old Buffer API")]
73    pub fn PyObject_AsReadBuffer(
74        obj: *mut PyObject,
75        buffer: *mut *const c_void,
76        buffer_len: *mut Py_ssize_t,
77    ) -> c_int;
78    #[deprecated(since = "0.2.1", note = "Old Buffer API")]
79    pub fn PyObject_AsWriteBuffer(
80        obj: *mut PyObject,
81        buffer: *mut *mut c_void,
82        buffer_len: *mut Py_ssize_t,
83    ) -> c_int;
84}
85
86// This is the old version of PyObject_CheckBuffer that was implemented as a macro.
87// The new version is in pybuffer.rs.
88#[cfg(all(not(Py_LIMITED_API), not(Py_3_9)))]
89#[inline]
90pub unsafe fn PyObject_CheckBuffer(o: *mut PyObject) -> c_int {
91    let tp_as_buffer = (*(*o).ob_type).tp_as_buffer;
92    (!tp_as_buffer.is_null() && (*tp_as_buffer).bf_getbuffer.is_some()) as c_int
93}
94
95#[cfg_attr(windows, link(name = "pythonXY"))]
96extern "C" {
97    pub fn PyObject_Format(obj: *mut PyObject, format_spec: *mut PyObject) -> *mut PyObject;
98    pub fn PyObject_GetIter(arg1: *mut PyObject) -> *mut PyObject;
99    #[cfg(Py_3_10)]
100    pub fn PyObject_GetAIter(arg1: *mut PyObject) -> *mut PyObject;
101
102    // Note: prior to 3.8, PyIter_Check was a macro instead
103    #[cfg(Py_3_8)]
104    pub fn PyIter_Check(o: *mut PyObject) -> c_int;
105
106    #[cfg(Py_3_10)]
107    pub fn PyAIter_Check(o: *mut PyObject) -> c_int;
108
109    pub fn PyIter_Next(arg1: *mut PyObject) -> *mut PyObject;
110    #[cfg(Py_3_10)]
111    pub fn PyIter_Send(iter: *mut PyObject, arg: *mut PyObject, result: *mut *mut PyObject) -> PySendResult;
112}
113
114#[cfg(not(Py_3_8))]
115#[inline]
116pub unsafe fn PyIter_Check(o: *mut PyObject) -> c_int {
117    (match (*(*o).ob_type).tp_iternext {
118        Some(tp_iternext) => {
119            tp_iternext as *const c_void
120                != crate::object::_PyObject_NextNotImplemented as *const c_void
121        }
122        None => false,
123    }) as c_int
124}
125
126#[cfg_attr(windows, link(name = "pythonXY"))]
127extern "C" {
128    pub fn PyNumber_Check(o: *mut PyObject) -> c_int;
129    pub fn PyNumber_Add(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
130    pub fn PyNumber_Subtract(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
131    pub fn PyNumber_Multiply(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
132    #[cfg(Py_3_5)]
133    pub fn PyNumber_MatrixMultiply(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
134    pub fn PyNumber_FloorDivide(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
135    pub fn PyNumber_TrueDivide(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
136    pub fn PyNumber_Remainder(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
137    pub fn PyNumber_Divmod(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
138    pub fn PyNumber_Power(o1: *mut PyObject, o2: *mut PyObject, o3: *mut PyObject)
139        -> *mut PyObject;
140    pub fn PyNumber_Negative(o: *mut PyObject) -> *mut PyObject;
141    pub fn PyNumber_Positive(o: *mut PyObject) -> *mut PyObject;
142    pub fn PyNumber_Absolute(o: *mut PyObject) -> *mut PyObject;
143    pub fn PyNumber_Invert(o: *mut PyObject) -> *mut PyObject;
144    pub fn PyNumber_Lshift(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
145    pub fn PyNumber_Rshift(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
146    pub fn PyNumber_And(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
147    pub fn PyNumber_Xor(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
148    pub fn PyNumber_Or(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
149}
150
151// Note: Py 3.8 has PyIndex_Check as a function, prior to that it was only availabe as a macro
152#[cfg(all(not(Py_LIMITED_API), not(Py_3_8)))]
153#[inline]
154pub unsafe fn PyIndex_Check(o: *mut PyObject) -> c_int {
155    let tp_as_number = (*(*o).ob_type).tp_as_number;
156    (!tp_as_number.is_null() && (*tp_as_number).nb_index.is_some()) as c_int
157}
158
159#[cfg_attr(windows, link(name = "pythonXY"))]
160extern "C" {
161    #[cfg(Py_3_8)]
162    pub fn PyIndex_Check(o: *mut PyObject) -> c_int;
163
164    pub fn PyNumber_Index(o: *mut PyObject) -> *mut PyObject;
165    pub fn PyNumber_AsSsize_t(o: *mut PyObject, exc: *mut PyObject) -> Py_ssize_t;
166    pub fn PyNumber_Long(o: *mut PyObject) -> *mut PyObject;
167    pub fn PyNumber_Float(o: *mut PyObject) -> *mut PyObject;
168    pub fn PyNumber_InPlaceAdd(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
169    pub fn PyNumber_InPlaceSubtract(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
170    pub fn PyNumber_InPlaceMultiply(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
171    #[cfg(Py_3_5)]
172    pub fn PyNumber_InPlaceMatrixMultiply(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
173    pub fn PyNumber_InPlaceFloorDivide(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
174    pub fn PyNumber_InPlaceTrueDivide(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
175    pub fn PyNumber_InPlaceRemainder(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
176    pub fn PyNumber_InPlacePower(
177        o1: *mut PyObject,
178        o2: *mut PyObject,
179        o3: *mut PyObject,
180    ) -> *mut PyObject;
181    pub fn PyNumber_InPlaceLshift(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
182    pub fn PyNumber_InPlaceRshift(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
183    pub fn PyNumber_InPlaceAnd(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
184    pub fn PyNumber_InPlaceXor(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
185    pub fn PyNumber_InPlaceOr(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
186    pub fn PyNumber_ToBase(n: *mut PyObject, base: c_int) -> *mut PyObject;
187
188    pub fn PySequence_Check(o: *mut PyObject) -> c_int;
189    pub fn PySequence_Size(o: *mut PyObject) -> Py_ssize_t;
190}
191
192#[inline]
193pub unsafe fn PySequence_Length(o: *mut PyObject) -> Py_ssize_t {
194    PySequence_Size(o)
195}
196
197#[cfg_attr(windows, link(name = "pythonXY"))]
198extern "C" {
199    pub fn PySequence_Concat(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
200    pub fn PySequence_Repeat(o: *mut PyObject, count: Py_ssize_t) -> *mut PyObject;
201    pub fn PySequence_GetItem(o: *mut PyObject, i: Py_ssize_t) -> *mut PyObject;
202    pub fn PySequence_GetSlice(o: *mut PyObject, i1: Py_ssize_t, i2: Py_ssize_t) -> *mut PyObject;
203    pub fn PySequence_SetItem(o: *mut PyObject, i: Py_ssize_t, v: *mut PyObject) -> c_int;
204    pub fn PySequence_DelItem(o: *mut PyObject, i: Py_ssize_t) -> c_int;
205    pub fn PySequence_SetSlice(
206        o: *mut PyObject,
207        i1: Py_ssize_t,
208        i2: Py_ssize_t,
209        v: *mut PyObject,
210    ) -> c_int;
211    pub fn PySequence_DelSlice(o: *mut PyObject, i1: Py_ssize_t, i2: Py_ssize_t) -> c_int;
212    pub fn PySequence_Tuple(o: *mut PyObject) -> *mut PyObject;
213    pub fn PySequence_List(o: *mut PyObject) -> *mut PyObject;
214    pub fn PySequence_Fast(o: *mut PyObject, m: *const c_char) -> *mut PyObject;
215    // TODO: PySequence_Fast macros
216    pub fn PySequence_Count(o: *mut PyObject, value: *mut PyObject) -> Py_ssize_t;
217    pub fn PySequence_Contains(seq: *mut PyObject, ob: *mut PyObject) -> c_int;
218}
219
220#[inline]
221pub unsafe fn PySequence_In(o: *mut PyObject, value: *mut PyObject) -> c_int {
222    PySequence_Contains(o, value)
223}
224
225#[cfg_attr(windows, link(name = "pythonXY"))]
226extern "C" {
227    pub fn PySequence_Index(o: *mut PyObject, value: *mut PyObject) -> Py_ssize_t;
228    pub fn PySequence_InPlaceConcat(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
229    pub fn PySequence_InPlaceRepeat(o: *mut PyObject, count: Py_ssize_t) -> *mut PyObject;
230    pub fn PyMapping_Check(o: *mut PyObject) -> c_int;
231    pub fn PyMapping_Size(o: *mut PyObject) -> Py_ssize_t;
232}
233
234#[inline]
235pub unsafe fn PyMapping_Length(o: *mut PyObject) -> Py_ssize_t {
236    PyMapping_Size(o)
237}
238
239#[inline]
240pub unsafe fn PyMapping_DelItemString(o: *mut PyObject, key: *mut c_char) -> c_int {
241    PyObject_DelItemString(o, key)
242}
243
244#[inline]
245pub unsafe fn PyMapping_DelItem(o: *mut PyObject, key: *mut PyObject) -> c_int {
246    PyObject_DelItem(o, key)
247}
248
249#[cfg_attr(windows, link(name = "pythonXY"))]
250extern "C" {
251    pub fn PyMapping_HasKeyString(o: *mut PyObject, key: *const c_char) -> c_int;
252    pub fn PyMapping_HasKey(o: *mut PyObject, key: *mut PyObject) -> c_int;
253    pub fn PyMapping_Keys(o: *mut PyObject) -> *mut PyObject;
254    pub fn PyMapping_Values(o: *mut PyObject) -> *mut PyObject;
255    pub fn PyMapping_Items(o: *mut PyObject) -> *mut PyObject;
256    pub fn PyMapping_GetItemString(o: *mut PyObject, key: *const c_char) -> *mut PyObject;
257    pub fn PyMapping_SetItemString(
258        o: *mut PyObject,
259        key: *const c_char,
260        value: *mut PyObject,
261    ) -> c_int;
262    pub fn PyObject_IsInstance(object: *mut PyObject, typeorclass: *mut PyObject) -> c_int;
263    pub fn PyObject_IsSubclass(object: *mut PyObject, typeorclass: *mut PyObject) -> c_int;
264}