cobject.h 1.72 KB
Newer Older
1 2 3 4 5 6 7 8 9 10

/* 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.

*/

11 12 13 14 15 16
#ifndef Py_COBJECT_H
#define Py_COBJECT_H
#ifdef __cplusplus
extern "C" {
#endif

17
PyAPI_DATA(PyTypeObject) PyCObject_Type;
18

19
#define PyCObject_Check(op) (Py_Type(op) == &PyCObject_Type)
20 21

/* Create a PyCObject from a pointer to a C object and an optional
22
   destructor function.  If the second argument is non-null, then it
23 24 25 26
   will be called with the first argument if and when the PyCObject is
   destroyed.

*/
27 28
PyAPI_FUNC(PyObject *) PyCObject_FromVoidPtr(
	void *cobj, void (*destruct)(void*));
29

30 31

/* Create a PyCObject from a pointer to a C object, a description object,
32
   and an optional destructor function.  If the third argument is non-null,
33 34 35
   then it will be called with the first and second arguments if and when 
   the PyCObject is destroyed.
*/
36 37
PyAPI_FUNC(PyObject *) PyCObject_FromVoidPtrAndDesc(
	void *cobj, void *desc, void (*destruct)(void*,void*));
38

39
/* Retrieve a pointer to a C object from a PyCObject. */
40
PyAPI_FUNC(void *) PyCObject_AsVoidPtr(PyObject *);
41

42
/* Retrieve a pointer to a description object from a PyCObject. */
43
PyAPI_FUNC(void *) PyCObject_GetDesc(PyObject *);
44

45
/* Import a pointer to a C object from a module using a PyCObject. */
46
PyAPI_FUNC(void *) PyCObject_Import(char *module_name, char *cobject_name);
47

48 49 50
/* Modify a C object. Fails (==0) if object has a destructor. */
PyAPI_FUNC(int) PyCObject_SetVoidPtr(PyObject *self, void *cobj);

51 52 53 54
#ifdef __cplusplus
}
#endif
#endif /* !Py_COBJECT_H */