cpython/Include/cobject.h

66 lines
1.9 KiB
C
Raw Normal View History

1996-01-11 20:44:03 -04:00
/* C objects to be exported from one extension module to another.
C objects 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.
DEPRECATED - Use PyCapsule objects instead.
CObject will be removed in 2.8 (if there is one).
1996-01-11 20:44:03 -04:00
*/
#ifndef Py_COBJECT_H
#define Py_COBJECT_H
#ifdef __cplusplus
extern "C" {
#endif
PyAPI_DATA(PyTypeObject) PyCObject_Type;
1996-01-11 20:44:03 -04:00
#define PyCObject_Check(op) (Py_TYPE(op) == &PyCObject_Type)
1996-01-11 20:44:03 -04:00
/* Create a PyCObject from a pointer to a C object and an optional
destructor function. If the second argument is non-null, then it
1996-01-11 20:44:03 -04:00
will be called with the first argument if and when the PyCObject is
destroyed.
*/
PyAPI_FUNC(PyObject *) PyCObject_FromVoidPtr(
void *cobj, void (*destruct)(void*));
1996-01-11 20:44:03 -04:00
/* Create a PyCObject from a pointer to a C object, a description object,
and an optional destructor function. If the third argument is non-null,
then it will be called with the first and second arguments if and when
the PyCObject is destroyed.
*/
PyAPI_FUNC(PyObject *) PyCObject_FromVoidPtrAndDesc(
void *cobj, void *desc, void (*destruct)(void*,void*));
1996-01-11 20:44:03 -04:00
/* Retrieve a pointer to a C object from a PyCObject. */
PyAPI_FUNC(void *) PyCObject_AsVoidPtr(PyObject *);
1996-01-11 20:44:03 -04:00
/* Retrieve a pointer to a description object from a PyCObject. */
PyAPI_FUNC(void *) PyCObject_GetDesc(PyObject *);
1997-01-22 16:48:48 -04:00
/* Import a pointer to a C object from a module using a PyCObject. */
PyAPI_FUNC(void *) PyCObject_Import(char *module_name, char *cobject_name);
1997-01-22 16:48:48 -04:00
2003-10-19 15:30:01 -03:00
/* Modify a C object. Fails (==0) if object has a destructor. */
PyAPI_FUNC(int) PyCObject_SetVoidPtr(PyObject *self, void *cobj);
typedef struct {
PyObject_HEAD
void *cobject;
void *desc;
void (*destructor)(void *);
} PyCObject;
1996-01-11 20:44:03 -04:00
#ifdef __cplusplus
}
#endif
#endif /* !Py_COBJECT_H */