Include/cobject.h

   1
   2 /* C objects to be exported from one extension module to another.
   3
   4    C objects are used for communication between extension modules.
   5    They provide a way for an extension module to export a C interface
   6    to other extension modules, so that extension modules can use the
   7    Python import mechanism to link to one another.
   8
   9 */
  10
  11 #ifndef Py_COBJECT_H
  12 #define Py_COBJECT_H
  13 #ifdef __cplusplus
  14 extern "C" {
  15 #endif
  16
  17 extern DL_IMPORT(PyTypeObject) PyCObject_Type;
  18
  19 #define PyCObject_Check(op) ((op)->ob_type == &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    will be called with the first argument if and when the PyCObject is
  24    destroyed.
  25
  26 */
  27 extern DL_IMPORT(PyObject *)
  28 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    then it will be called with the first and second arguments if and when
  34    the PyCObject is destroyed.
  35 */
  36 extern DL_IMPORT(PyObject *)
  37 PyCObject_FromVoidPtrAndDesc(void *cobj, void *desc,
  38                              void (*destruct)(void*,void*));
  39
  40 /* Retrieve a pointer to a C object from a PyCObject. */
  41 extern DL_IMPORT(void *)
  42 PyCObject_AsVoidPtr(PyObject *);
  43
  44 /* Retrieve a pointer to a description object from a PyCObject. */
  45 extern DL_IMPORT(void *)
  46 PyCObject_GetDesc(PyObject *);
  47
  48 /* Import a pointer to a C object from a module using a PyCObject. */
  49 extern DL_IMPORT(void *)
  50 PyCObject_Import(char *module_name, char *cobject_name);
  51
  52 #ifdef __cplusplus
  53 }
  54 #endif
  55 #endif /* !Py_COBJECT_H */