pyo3_ffi/
descrobject.rs

1use crate::methodobject::PyMethodDef;
2use crate::object::{PyObject, PyTypeObject};
3use crate::Py_ssize_t;
4use std::ffi::{c_char, c_int, c_void};
5use std::ptr;
6
7pub type getter = unsafe extern "C" fn(slf: *mut PyObject, closure: *mut c_void) -> *mut PyObject;
8pub type setter =
9    unsafe extern "C" fn(slf: *mut PyObject, value: *mut PyObject, closure: *mut c_void) -> c_int;
10
11/// Represents the [PyGetSetDef](https://docs.python.org/3/c-api/structures.html#c.PyGetSetDef)
12/// structure.
13///
14/// Note that CPython may leave fields uninitialized. You must ensure that
15/// `name` != NULL before dereferencing or reading other fields.
16#[repr(C)]
17#[derive(Copy, Clone, Debug)]
18pub struct PyGetSetDef {
19    pub name: *const c_char,
20    pub get: Option<getter>,
21    pub set: Option<setter>,
22    pub doc: *const c_char,
23    pub closure: *mut c_void,
24}
25
26impl Default for PyGetSetDef {
27    fn default() -> PyGetSetDef {
28        PyGetSetDef {
29            name: ptr::null(),
30            get: None,
31            set: None,
32            doc: ptr::null(),
33            closure: ptr::null_mut(),
34        }
35    }
36}
37
38extern_libpython! {
39    #[cfg_attr(PyPy, link_name = "PyPyClassMethodDescr_Type")]
40    pub static mut PyClassMethodDescr_Type: PyTypeObject;
41    #[cfg_attr(PyPy, link_name = "PyPyGetSetDescr_Type")]
42    pub static mut PyGetSetDescr_Type: PyTypeObject;
43    #[cfg_attr(PyPy, link_name = "PyPyMemberDescr_Type")]
44    pub static mut PyMemberDescr_Type: PyTypeObject;
45    #[cfg_attr(PyPy, link_name = "PyPyMethodDescr_Type")]
46    pub static mut PyMethodDescr_Type: PyTypeObject;
47    #[cfg_attr(PyPy, link_name = "PyPyWrapperDescr_Type")]
48    pub static mut PyWrapperDescr_Type: PyTypeObject;
49    #[cfg_attr(PyPy, link_name = "PyPyDictProxy_Type")]
50    pub static mut PyDictProxy_Type: PyTypeObject;
51    #[cfg_attr(PyPy, link_name = "PyPyProperty_Type")]
52    pub static mut PyProperty_Type: PyTypeObject;
53}
54
55extern_libpython! {
56    pub fn PyDescr_NewMethod(arg1: *mut PyTypeObject, arg2: *mut PyMethodDef) -> *mut PyObject;
57    #[cfg_attr(PyPy, link_name = "PyPyDescr_NewClassMethod")]
58    pub fn PyDescr_NewClassMethod(arg1: *mut PyTypeObject, arg2: *mut PyMethodDef)
59        -> *mut PyObject;
60    #[cfg_attr(PyPy, link_name = "PyPyDescr_NewMember")]
61    pub fn PyDescr_NewMember(arg1: *mut PyTypeObject, arg2: *mut PyMemberDef) -> *mut PyObject;
62    #[cfg_attr(PyPy, link_name = "PyPyDescr_NewGetSet")]
63    pub fn PyDescr_NewGetSet(arg1: *mut PyTypeObject, arg2: *mut PyGetSetDef) -> *mut PyObject;
64
65    #[cfg_attr(PyPy, link_name = "PyPyDictProxy_New")]
66    pub fn PyDictProxy_New(arg1: *mut PyObject) -> *mut PyObject;
67    pub fn PyWrapper_New(arg1: *mut PyObject, arg2: *mut PyObject) -> *mut PyObject;
68}
69
70/// Represents the [PyMemberDef](https://docs.python.org/3/c-api/structures.html#c.PyMemberDef)
71/// structure.
72///
73/// Note that CPython may leave fields uninitialized. You must always ensure that
74/// `name` != NULL before dereferencing or reading other fields.
75#[repr(C)]
76#[derive(Copy, Clone, Eq, PartialEq)]
77pub struct PyMemberDef {
78    pub name: *const c_char,
79    pub type_code: c_int,
80    pub offset: Py_ssize_t,
81    pub flags: c_int,
82    pub doc: *const c_char,
83}
84
85impl Default for PyMemberDef {
86    fn default() -> PyMemberDef {
87        PyMemberDef {
88            name: ptr::null_mut(),
89            type_code: 0,
90            offset: 0,
91            flags: 0,
92            doc: ptr::null_mut(),
93        }
94    }
95}
96
97/* Types */
98pub const Py_T_SHORT: c_int = 0;
99pub const Py_T_INT: c_int = 1;
100pub const Py_T_LONG: c_int = 2;
101pub const Py_T_FLOAT: c_int = 3;
102pub const Py_T_DOUBLE: c_int = 4;
103pub const Py_T_STRING: c_int = 5;
104#[deprecated(note = "Use Py_T_OBJECT_EX instead")]
105pub const _Py_T_OBJECT: c_int = 6;
106pub const Py_T_CHAR: c_int = 7;
107pub const Py_T_BYTE: c_int = 8;
108pub const Py_T_UBYTE: c_int = 9;
109pub const Py_T_USHORT: c_int = 10;
110pub const Py_T_UINT: c_int = 11;
111pub const Py_T_ULONG: c_int = 12;
112pub const Py_T_STRING_INPLACE: c_int = 13;
113pub const Py_T_BOOL: c_int = 14;
114pub const Py_T_OBJECT_EX: c_int = 16;
115pub const Py_T_LONGLONG: c_int = 17;
116pub const Py_T_ULONGLONG: c_int = 18;
117pub const Py_T_PYSSIZET: c_int = 19;
118#[deprecated(note = "Value is always none")]
119pub const _Py_T_NONE: c_int = 20;
120
121/* Flags */
122pub const Py_READONLY: c_int = 1;
123#[cfg(Py_3_10)]
124pub const Py_AUDIT_READ: c_int = 2; // Added in 3.10, harmless no-op before that
125#[deprecated]
126pub const _Py_WRITE_RESTRICTED: c_int = 4; // Deprecated, no-op. Do not reuse the value.
127pub const Py_RELATIVE_OFFSET: c_int = 8;
128
129extern_libpython! {
130    pub fn PyMember_GetOne(addr: *const c_char, l: *mut PyMemberDef) -> *mut PyObject;
131    pub fn PyMember_SetOne(addr: *mut c_char, l: *mut PyMemberDef, value: *mut PyObject) -> c_int;
132}
pyo3_ffi/descrobject.rs

pyo3_ffi/
descrobject.rs
