pyo3_ffi/cpython/
object.rs

1#[cfg(Py_3_8)]
2use crate::vectorcallfunc;
3use crate::{object, PyGetSetDef, PyMemberDef, PyMethodDef, PyObject, Py_ssize_t};
4use std::mem;
5use std::os::raw::{c_char, c_int, c_uint, c_void};
6
7// skipped private _Py_NewReference
8// skipped private _Py_NewReferenceNoTotal
9// skipped private _Py_ResurrectReference
10
11// skipped private _Py_GetGlobalRefTotal
12// skipped private _Py_GetRefTotal
13// skipped private _Py_GetLegacyRefTotal
14// skipped private _PyInterpreterState_GetRefTotal
15
16// skipped private _Py_Identifier
17
18// skipped private _Py_static_string_init
19// skipped private _Py_static_string
20// skipped private _Py_IDENTIFIER
21
22#[cfg(not(Py_3_11))] // moved to src/buffer.rs from Python
23mod bufferinfo {
24    use crate::Py_ssize_t;
25    use std::os::raw::{c_char, c_int, c_void};
26    use std::ptr;
27
28    #[repr(C)]
29    #[derive(Copy, Clone)]
30    pub struct Py_buffer {
31        pub buf: *mut c_void,
32        /// Owned reference
33        pub obj: *mut crate::PyObject,
34        pub len: Py_ssize_t,
35        pub itemsize: Py_ssize_t,
36        pub readonly: c_int,
37        pub ndim: c_int,
38        pub format: *mut c_char,
39        pub shape: *mut Py_ssize_t,
40        pub strides: *mut Py_ssize_t,
41        pub suboffsets: *mut Py_ssize_t,
42        pub internal: *mut c_void,
43        #[cfg(PyPy)]
44        pub flags: c_int,
45        #[cfg(PyPy)]
46        pub _strides: [Py_ssize_t; PyBUF_MAX_NDIM as usize],
47        #[cfg(PyPy)]
48        pub _shape: [Py_ssize_t; PyBUF_MAX_NDIM as usize],
49    }
50
51    impl Py_buffer {
52        #[allow(clippy::new_without_default)]
53        pub const fn new() -> Self {
54            Py_buffer {
55                buf: ptr::null_mut(),
56                obj: ptr::null_mut(),
57                len: 0,
58                itemsize: 0,
59                readonly: 0,
60                ndim: 0,
61                format: ptr::null_mut(),
62                shape: ptr::null_mut(),
63                strides: ptr::null_mut(),
64                suboffsets: ptr::null_mut(),
65                internal: ptr::null_mut(),
66                #[cfg(PyPy)]
67                flags: 0,
68                #[cfg(PyPy)]
69                _strides: [0; PyBUF_MAX_NDIM as usize],
70                #[cfg(PyPy)]
71                _shape: [0; PyBUF_MAX_NDIM as usize],
72            }
73        }
74    }
75
76    pub type getbufferproc = unsafe extern "C" fn(
77        arg1: *mut crate::PyObject,
78        arg2: *mut Py_buffer,
79        arg3: c_int,
80    ) -> c_int;
81    pub type releasebufferproc =
82        unsafe extern "C" fn(arg1: *mut crate::PyObject, arg2: *mut Py_buffer);
83
84    /// Maximum number of dimensions
85    pub const PyBUF_MAX_NDIM: c_int = if cfg!(PyPy) { 36 } else { 64 };
86
87    /* Flags for getting buffers */
88    pub const PyBUF_SIMPLE: c_int = 0;
89    pub const PyBUF_WRITABLE: c_int = 0x0001;
90    /* we used to include an E, backwards compatible alias */
91    pub const PyBUF_WRITEABLE: c_int = PyBUF_WRITABLE;
92    pub const PyBUF_FORMAT: c_int = 0x0004;
93    pub const PyBUF_ND: c_int = 0x0008;
94    pub const PyBUF_STRIDES: c_int = 0x0010 | PyBUF_ND;
95    pub const PyBUF_C_CONTIGUOUS: c_int = 0x0020 | PyBUF_STRIDES;
96    pub const PyBUF_F_CONTIGUOUS: c_int = 0x0040 | PyBUF_STRIDES;
97    pub const PyBUF_ANY_CONTIGUOUS: c_int = 0x0080 | PyBUF_STRIDES;
98    pub const PyBUF_INDIRECT: c_int = 0x0100 | PyBUF_STRIDES;
99
100    pub const PyBUF_CONTIG: c_int = PyBUF_ND | PyBUF_WRITABLE;
101    pub const PyBUF_CONTIG_RO: c_int = PyBUF_ND;
102
103    pub const PyBUF_STRIDED: c_int = PyBUF_STRIDES | PyBUF_WRITABLE;
104    pub const PyBUF_STRIDED_RO: c_int = PyBUF_STRIDES;
105
106    pub const PyBUF_RECORDS: c_int = PyBUF_STRIDES | PyBUF_WRITABLE | PyBUF_FORMAT;
107    pub const PyBUF_RECORDS_RO: c_int = PyBUF_STRIDES | PyBUF_FORMAT;
108
109    pub const PyBUF_FULL: c_int = PyBUF_INDIRECT | PyBUF_WRITABLE | PyBUF_FORMAT;
110    pub const PyBUF_FULL_RO: c_int = PyBUF_INDIRECT | PyBUF_FORMAT;
111
112    pub const PyBUF_READ: c_int = 0x100;
113    pub const PyBUF_WRITE: c_int = 0x200;
114}
115
116#[cfg(not(Py_3_11))]
117pub use self::bufferinfo::*;
118
119#[repr(C)]
120#[derive(Copy, Clone)]
121pub struct PyNumberMethods {
122    pub nb_add: Option<object::binaryfunc>,
123    pub nb_subtract: Option<object::binaryfunc>,
124    pub nb_multiply: Option<object::binaryfunc>,
125    pub nb_remainder: Option<object::binaryfunc>,
126    pub nb_divmod: Option<object::binaryfunc>,
127    pub nb_power: Option<object::ternaryfunc>,
128    pub nb_negative: Option<object::unaryfunc>,
129    pub nb_positive: Option<object::unaryfunc>,
130    pub nb_absolute: Option<object::unaryfunc>,
131    pub nb_bool: Option<object::inquiry>,
132    pub nb_invert: Option<object::unaryfunc>,
133    pub nb_lshift: Option<object::binaryfunc>,
134    pub nb_rshift: Option<object::binaryfunc>,
135    pub nb_and: Option<object::binaryfunc>,
136    pub nb_xor: Option<object::binaryfunc>,
137    pub nb_or: Option<object::binaryfunc>,
138    pub nb_int: Option<object::unaryfunc>,
139    pub nb_reserved: *mut c_void,
140    pub nb_float: Option<object::unaryfunc>,
141    pub nb_inplace_add: Option<object::binaryfunc>,
142    pub nb_inplace_subtract: Option<object::binaryfunc>,
143    pub nb_inplace_multiply: Option<object::binaryfunc>,
144    pub nb_inplace_remainder: Option<object::binaryfunc>,
145    pub nb_inplace_power: Option<object::ternaryfunc>,
146    pub nb_inplace_lshift: Option<object::binaryfunc>,
147    pub nb_inplace_rshift: Option<object::binaryfunc>,
148    pub nb_inplace_and: Option<object::binaryfunc>,
149    pub nb_inplace_xor: Option<object::binaryfunc>,
150    pub nb_inplace_or: Option<object::binaryfunc>,
151    pub nb_floor_divide: Option<object::binaryfunc>,
152    pub nb_true_divide: Option<object::binaryfunc>,
153    pub nb_inplace_floor_divide: Option<object::binaryfunc>,
154    pub nb_inplace_true_divide: Option<object::binaryfunc>,
155    pub nb_index: Option<object::unaryfunc>,
156    pub nb_matrix_multiply: Option<object::binaryfunc>,
157    pub nb_inplace_matrix_multiply: Option<object::binaryfunc>,
158}
159
160#[repr(C)]
161#[derive(Clone)]
162pub struct PySequenceMethods {
163    pub sq_length: Option<object::lenfunc>,
164    pub sq_concat: Option<object::binaryfunc>,
165    pub sq_repeat: Option<object::ssizeargfunc>,
166    pub sq_item: Option<object::ssizeargfunc>,
167    pub was_sq_slice: *mut c_void,
168    pub sq_ass_item: Option<object::ssizeobjargproc>,
169    pub was_sq_ass_slice: *mut c_void,
170    pub sq_contains: Option<object::objobjproc>,
171    pub sq_inplace_concat: Option<object::binaryfunc>,
172    pub sq_inplace_repeat: Option<object::ssizeargfunc>,
173}
174
175#[repr(C)]
176#[derive(Clone, Default)]
177pub struct PyMappingMethods {
178    pub mp_length: Option<object::lenfunc>,
179    pub mp_subscript: Option<object::binaryfunc>,
180    pub mp_ass_subscript: Option<object::objobjargproc>,
181}
182
183#[cfg(Py_3_10)]
184pub type sendfunc = unsafe extern "C" fn(
185    iter: *mut PyObject,
186    value: *mut PyObject,
187    result: *mut *mut PyObject,
188) -> object::PySendResult;
189
190#[repr(C)]
191#[derive(Clone, Default)]
192pub struct PyAsyncMethods {
193    pub am_await: Option<object::unaryfunc>,
194    pub am_aiter: Option<object::unaryfunc>,
195    pub am_anext: Option<object::unaryfunc>,
196    #[cfg(Py_3_10)]
197    pub am_send: Option<sendfunc>,
198}
199
200#[repr(C)]
201#[derive(Clone, Default)]
202pub struct PyBufferProcs {
203    pub bf_getbuffer: Option<crate::getbufferproc>,
204    pub bf_releasebuffer: Option<crate::releasebufferproc>,
205}
206
207pub type printfunc =
208    unsafe extern "C" fn(arg1: *mut PyObject, arg2: *mut ::libc::FILE, arg3: c_int) -> c_int;
209
210#[repr(C)]
211#[derive(Debug)]
212pub struct PyTypeObject {
213    pub ob_base: object::PyVarObject,
214    pub tp_name: *const c_char,
215    pub tp_basicsize: Py_ssize_t,
216    pub tp_itemsize: Py_ssize_t,
217    pub tp_dealloc: Option<object::destructor>,
218    #[cfg(not(Py_3_8))]
219    pub tp_print: Option<printfunc>,
220    #[cfg(Py_3_8)]
221    pub tp_vectorcall_offset: Py_ssize_t,
222    pub tp_getattr: Option<object::getattrfunc>,
223    pub tp_setattr: Option<object::setattrfunc>,
224    pub tp_as_async: *mut PyAsyncMethods,
225    pub tp_repr: Option<object::reprfunc>,
226    pub tp_as_number: *mut PyNumberMethods,
227    pub tp_as_sequence: *mut PySequenceMethods,
228    pub tp_as_mapping: *mut PyMappingMethods,
229    pub tp_hash: Option<object::hashfunc>,
230    pub tp_call: Option<object::ternaryfunc>,
231    pub tp_str: Option<object::reprfunc>,
232    pub tp_getattro: Option<object::getattrofunc>,
233    pub tp_setattro: Option<object::setattrofunc>,
234    pub tp_as_buffer: *mut PyBufferProcs,
235    #[cfg(not(Py_GIL_DISABLED))]
236    pub tp_flags: std::os::raw::c_ulong,
237    #[cfg(Py_GIL_DISABLED)]
238    pub tp_flags: crate::impl_::AtomicCULong,
239    pub tp_doc: *const c_char,
240    pub tp_traverse: Option<object::traverseproc>,
241    pub tp_clear: Option<object::inquiry>,
242    pub tp_richcompare: Option<object::richcmpfunc>,
243    pub tp_weaklistoffset: Py_ssize_t,
244    pub tp_iter: Option<object::getiterfunc>,
245    pub tp_iternext: Option<object::iternextfunc>,
246    pub tp_methods: *mut PyMethodDef,
247    pub tp_members: *mut PyMemberDef,
248    pub tp_getset: *mut PyGetSetDef,
249    pub tp_base: *mut PyTypeObject,
250    pub tp_dict: *mut object::PyObject,
251    pub tp_descr_get: Option<object::descrgetfunc>,
252    pub tp_descr_set: Option<object::descrsetfunc>,
253    pub tp_dictoffset: Py_ssize_t,
254    pub tp_init: Option<object::initproc>,
255    pub tp_alloc: Option<object::allocfunc>,
256    pub tp_new: Option<object::newfunc>,
257    pub tp_free: Option<object::freefunc>,
258    pub tp_is_gc: Option<object::inquiry>,
259    pub tp_bases: *mut object::PyObject,
260    pub tp_mro: *mut object::PyObject,
261    pub tp_cache: *mut object::PyObject,
262    pub tp_subclasses: *mut object::PyObject,
263    pub tp_weaklist: *mut object::PyObject,
264    pub tp_del: Option<object::destructor>,
265    pub tp_version_tag: c_uint,
266    pub tp_finalize: Option<object::destructor>,
267    #[cfg(Py_3_8)]
268    pub tp_vectorcall: Option<vectorcallfunc>,
269    #[cfg(Py_3_12)]
270    pub tp_watched: c_char,
271    #[cfg(any(all(PyPy, Py_3_8, not(Py_3_10)), all(not(PyPy), Py_3_8, not(Py_3_9))))]
272    pub tp_print: Option<printfunc>,
273    #[cfg(all(PyPy, not(Py_3_10)))]
274    pub tp_pypy_flags: std::os::raw::c_long,
275    #[cfg(py_sys_config = "COUNT_ALLOCS")]
276    pub tp_allocs: Py_ssize_t,
277    #[cfg(py_sys_config = "COUNT_ALLOCS")]
278    pub tp_frees: Py_ssize_t,
279    #[cfg(py_sys_config = "COUNT_ALLOCS")]
280    pub tp_maxalloc: Py_ssize_t,
281    #[cfg(py_sys_config = "COUNT_ALLOCS")]
282    pub tp_prev: *mut PyTypeObject,
283    #[cfg(py_sys_config = "COUNT_ALLOCS")]
284    pub tp_next: *mut PyTypeObject,
285}
286
287#[cfg(Py_3_11)]
288#[repr(C)]
289#[derive(Clone)]
290struct _specialization_cache {
291    getitem: *mut PyObject,
292    #[cfg(Py_3_12)]
293    getitem_version: u32,
294    #[cfg(Py_3_13)]
295    init: *mut PyObject,
296}
297
298#[repr(C)]
299pub struct PyHeapTypeObject {
300    pub ht_type: PyTypeObject,
301    pub as_async: PyAsyncMethods,
302    pub as_number: PyNumberMethods,
303    pub as_mapping: PyMappingMethods,
304    pub as_sequence: PySequenceMethods,
305    pub as_buffer: PyBufferProcs,
306    pub ht_name: *mut object::PyObject,
307    pub ht_slots: *mut object::PyObject,
308    pub ht_qualname: *mut object::PyObject,
309    #[cfg(not(PyPy))]
310    pub ht_cached_keys: *mut c_void,
311    #[cfg(Py_3_9)]
312    pub ht_module: *mut object::PyObject,
313    #[cfg(all(Py_3_11, not(PyPy)))]
314    _ht_tpname: *mut c_char,
315    #[cfg(all(Py_3_11, not(PyPy)))]
316    _spec_cache: _specialization_cache,
317}
318
319impl Default for PyHeapTypeObject {
320    #[inline]
321    fn default() -> Self {
322        unsafe { mem::zeroed() }
323    }
324}
325
326#[inline]
327#[cfg(not(Py_3_11))]
328pub unsafe fn PyHeapType_GET_MEMBERS(etype: *mut PyHeapTypeObject) -> *mut PyMemberDef {
329    let py_type = object::Py_TYPE(etype as *mut object::PyObject);
330    let ptr = etype.offset((*py_type).tp_basicsize);
331    ptr as *mut PyMemberDef
332}
333
334// skipped private _PyType_Name
335// skipped private _PyType_Lookup
336// skipped private _PyType_LookupRef
337
338extern "C" {
339    #[cfg(Py_3_12)]
340    pub fn PyType_GetDict(o: *mut PyTypeObject) -> *mut PyObject;
341
342    #[cfg_attr(PyPy, link_name = "PyPyObject_Print")]
343    pub fn PyObject_Print(o: *mut PyObject, fp: *mut ::libc::FILE, flags: c_int) -> c_int;
344
345    // skipped private _Py_BreakPoint
346    // skipped private _PyObject_Dump
347
348    // skipped _PyObject_GetAttrId
349
350    // skipped private _PyObject_GetDictPtr
351    pub fn PyObject_CallFinalizer(arg1: *mut PyObject);
352    #[cfg_attr(PyPy, link_name = "PyPyObject_CallFinalizerFromDealloc")]
353    pub fn PyObject_CallFinalizerFromDealloc(arg1: *mut PyObject) -> c_int;
354
355    // skipped private _PyObject_GenericGetAttrWithDict
356    // skipped private _PyObject_GenericSetAttrWithDict
357    // skipped private _PyObject_FunctionStr
358}
359
360// skipped Py_SETREF
361// skipped Py_XSETREF
362
363// skipped private _PyObject_ASSERT_FROM
364// skipped private _PyObject_ASSERT_WITH_MSG
365// skipped private _PyObject_ASSERT
366// skipped private _PyObject_ASSERT_FAILED_MSG
367// skipped private _PyObject_AssertFailed
368
369// skipped private _PyTrash_begin
370// skipped private _PyTrash_end
371
372// skipped _PyTrash_thread_deposit_object
373// skipped _PyTrash_thread_destroy_chain
374
375// skipped Py_TRASHCAN_BEGIN
376// skipped Py_TRASHCAN_END
377
378// skipped PyObject_GetItemData
379
380// skipped PyObject_VisitManagedDict
381// skipped _PyObject_SetManagedDict
382// skipped PyObject_ClearManagedDict
383
384// skipped TYPE_MAX_WATCHERS
385
386// skipped PyType_WatchCallback
387// skipped PyType_AddWatcher
388// skipped PyType_ClearWatcher
389// skipped PyType_Watch
390// skipped PyType_Unwatch
391
392// skipped PyUnstable_Type_AssignVersionTag
393
394// skipped PyRefTracerEvent
395
396// skipped PyRefTracer
397// skipped PyRefTracer_SetTracer
398// skipped PyRefTracer_GetTracer
pyo3_ffi/cpython/object.rs

pyo3_ffi/cpython/
object.rs
