cobject.h 2.08 KB
Newer Older
1
/***********************************************************
2 3 4 5 6 7 8
Copyright (c) 2000, BeOpen.com.
Copyright (c) 1995-2000, Corporation for National Research Initiatives.
Copyright (c) 1990-1995, Stichting Mathematisch Centrum.
All rights reserved.

See the file "Misc/COPYRIGHT" for information on usage and
redistribution of this file, and for a DISCLAIMER OF ALL WARRANTIES.
9 10 11 12 13 14 15 16 17 18 19
******************************************************************/

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

*/

20 21 22 23 24 25
#ifndef Py_COBJECT_H
#define Py_COBJECT_H
#ifdef __cplusplus
extern "C" {
#endif

26 27 28 29 30
extern DL_IMPORT(PyTypeObject) PyCObject_Type;

#define PyCObject_Check(op) ((op)->ob_type == &PyCObject_Type)

/* Create a PyCObject from a pointer to a C object and an optional
31
   destructor function.  If the second argument is non-null, then it
32 33 34 35
   will be called with the first argument if and when the PyCObject is
   destroyed.

*/
36
extern DL_IMPORT(PyObject *)
37
PyCObject_FromVoidPtr(void *cobj, void (*destruct)(void*));
38

39 40

/* Create a PyCObject from a pointer to a C object, a description object,
41
   and an optional destructor function.  If the third argument is non-null,
42 43 44
   then it will be called with the first and second arguments if and when 
   the PyCObject is destroyed.
*/
45
extern DL_IMPORT(PyObject *)
46 47
PyCObject_FromVoidPtrAndDesc(void *cobj, void *desc,
                             void (*destruct)(void*,void*));
48

49
/* Retrieve a pointer to a C object from a PyCObject. */
50
extern DL_IMPORT(void *)
51
PyCObject_AsVoidPtr(PyObject *);
52

53
/* Retrieve a pointer to a description object from a PyCObject. */
54
extern DL_IMPORT(void *)
55
PyCObject_GetDesc(PyObject *);
56

57
/* Import a pointer to a C object from a module using a PyCObject. */
58
extern DL_IMPORT(void *)
59
PyCObject_Import(char *module_name, char *cobject_name);
60

61 62 63 64
#ifdef __cplusplus
}
#endif
#endif /* !Py_COBJECT_H */