mirror of https://github.com/python/cpython
64 lines
1.8 KiB
C
64 lines
1.8 KiB
C
|
|
/* Capsule objects let you wrap a C "void *" pointer in a Python
|
|
object. They're a way of passing data through the Python interpreter
|
|
without creating your own custom type.
|
|
|
|
Capsules are used for communication between extension modules.
|
|
They provide a way for an extension module to export a C interface
|
|
to other extension modules, so that extension modules can use the
|
|
Python import mechanism to link to one another.
|
|
|
|
For more information, please see "c-api/capsule.html" in the
|
|
documentation.
|
|
*/
|
|
|
|
#ifndef Py_CAPSULE_H
|
|
#define Py_CAPSULE_H
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
PyAPI_DATA(PyTypeObject) PyCapsule_Type;
|
|
|
|
typedef void (*PyCapsule_Destructor)(PyObject *);
|
|
|
|
#define PyCapsule_CheckExact(op) Py_IS_TYPE((op), &PyCapsule_Type)
|
|
|
|
|
|
PyAPI_FUNC(PyObject *) PyCapsule_New(
|
|
void *pointer,
|
|
const char *name,
|
|
PyCapsule_Destructor destructor);
|
|
|
|
PyAPI_FUNC(void *) PyCapsule_GetPointer(PyObject *capsule, const char *name);
|
|
|
|
PyAPI_FUNC(PyCapsule_Destructor) PyCapsule_GetDestructor(PyObject *capsule);
|
|
|
|
PyAPI_FUNC(const char *) PyCapsule_GetName(PyObject *capsule);
|
|
|
|
PyAPI_FUNC(void *) PyCapsule_GetContext(PyObject *capsule);
|
|
|
|
PyAPI_FUNC(int) PyCapsule_IsValid(PyObject *capsule, const char *name);
|
|
|
|
PyAPI_FUNC(int) PyCapsule_SetPointer(PyObject *capsule, void *pointer);
|
|
|
|
PyAPI_FUNC(int) PyCapsule_SetDestructor(PyObject *capsule, PyCapsule_Destructor destructor);
|
|
|
|
PyAPI_FUNC(int) PyCapsule_SetName(PyObject *capsule, const char *name);
|
|
|
|
PyAPI_FUNC(int) PyCapsule_SetContext(PyObject *capsule, void *context);
|
|
|
|
#ifdef Py_BUILD_CORE
|
|
PyAPI_FUNC(int) _PyCapsule_SetTraverse(PyObject *op, traverseproc traverse_func, inquiry clear_func);
|
|
#endif
|
|
|
|
PyAPI_FUNC(void *) PyCapsule_Import(
|
|
const char *name, /* UTF-8 encoded string */
|
|
int no_block);
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#endif /* !Py_CAPSULE_H */
|