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