blob: 19693380e5d9e991ef5f318ad24298068990383b [file] [log] [blame]
Guido van Rossum77654a71996-01-12 00:44:03 +00001#ifndef Py_COBJECT_H
2#define Py_COBJECT_H
3#ifdef __cplusplus
4extern "C" {
5#endif
6
7/***********************************************************
8Copyright 1991-1995 by Stichting Mathematisch Centrum, Amsterdam,
9The Netherlands.
10
11 All Rights Reserved
12
13Permission to use, copy, modify, and distribute this software and its
14documentation for any purpose and without fee is hereby granted,
15provided that the above copyright notice appear in all copies and that
16both that copyright notice and this permission notice appear in
17supporting documentation, and that the names of Stichting Mathematisch
18Centrum or CWI not be used in advertising or publicity pertaining to
19distribution of the software without specific, written prior permission.
20
21STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO
22THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
23FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE
24FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
25WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
26ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
27OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
28
29******************************************************************/
30
31/* C objects to be exported from one extension module to another.
32
33 C objects are used for communication between extension modules.
34 They provide a way for an extension module to export a C interface
35 to other extension modules, so that extension modules can use the
36 Python import mechanism to link to one another.
37
38*/
39
40extern DL_IMPORT(PyTypeObject) PyCObject_Type;
41
42#define PyCObject_Check(op) ((op)->ob_type == &PyCObject_Type)
43
44/* Create a PyCObject from a pointer to a C object and an optional
45 destrutor function. If the second argument is non-null, then it
46 will be called with the first argument if and when the PyCObject is
47 destroyed.
48
49*/
50
51extern PyObject *
52PyCObject_FromVoidPtr Py_PROTO((void *cobj, void (*destruct)(void*)));
53
54/* Retrieve a pointer to a C object from a PyCObject. */
55extern void *
56PyCObject_AsVoidPtr Py_PROTO((PyObject *));
57
58#ifdef __cplusplus
59}
60#endif
61#endif /* !Py_COBJECT_H */