Guido van Rossum | 77654a7 | 1996-01-12 00:44:03 +0000 | [diff] [blame] | 1 | |
| 2 | /* Wrap void* pointers to be passed between C modules */ |
| 3 | |
| 4 | #include "Python.h" |
| 5 | |
| 6 | |
| 7 | /* Declarations for objects of type PyCObject */ |
| 8 | |
Tim Peters | dbd9ba6 | 2000-07-09 03:09:57 +0000 | [diff] [blame] | 9 | typedef void (*destructor1)(void *); |
| 10 | typedef void (*destructor2)(void *, void*); |
Guido van Rossum | 1f84449 | 1997-10-21 19:48:35 +0000 | [diff] [blame] | 11 | |
Larry Hastings | 5ac006d | 2010-04-02 11:01:35 +0000 | [diff] [blame] | 12 | static int cobject_deprecation_warning(void) |
| 13 | { |
Jesus Cea | 33c722b | 2010-11-04 21:39:52 +0000 | [diff] [blame] | 14 | return PyErr_WarnPy3k("CObject type is not supported in 3.x. " |
Larry Hastings | 5ac006d | 2010-04-02 11:01:35 +0000 | [diff] [blame] | 15 | "Please use capsule objects instead.", 1); |
| 16 | } |
| 17 | |
| 18 | |
Guido van Rossum | 77654a7 | 1996-01-12 00:44:03 +0000 | [diff] [blame] | 19 | PyObject * |
Fred Drake | 3be9a8a | 2000-07-09 04:14:42 +0000 | [diff] [blame] | 20 | PyCObject_FromVoidPtr(void *cobj, void (*destr)(void *)) |
Guido van Rossum | 77654a7 | 1996-01-12 00:44:03 +0000 | [diff] [blame] | 21 | { |
Fred Drake | 3be9a8a | 2000-07-09 04:14:42 +0000 | [diff] [blame] | 22 | PyCObject *self; |
| 23 | |
Larry Hastings | 5ac006d | 2010-04-02 11:01:35 +0000 | [diff] [blame] | 24 | if (cobject_deprecation_warning()) { |
| 25 | return NULL; |
| 26 | } |
| 27 | |
Fred Drake | 3be9a8a | 2000-07-09 04:14:42 +0000 | [diff] [blame] | 28 | self = PyObject_NEW(PyCObject, &PyCObject_Type); |
| 29 | if (self == NULL) |
| 30 | return NULL; |
| 31 | self->cobject=cobj; |
| 32 | self->destructor=destr; |
| 33 | self->desc=NULL; |
| 34 | |
| 35 | return (PyObject *)self; |
Guido van Rossum | 1f84449 | 1997-10-21 19:48:35 +0000 | [diff] [blame] | 36 | } |
| 37 | |
| 38 | PyObject * |
Fred Drake | 3be9a8a | 2000-07-09 04:14:42 +0000 | [diff] [blame] | 39 | PyCObject_FromVoidPtrAndDesc(void *cobj, void *desc, |
| 40 | void (*destr)(void *, void *)) |
Guido van Rossum | 1f84449 | 1997-10-21 19:48:35 +0000 | [diff] [blame] | 41 | { |
Fred Drake | 3be9a8a | 2000-07-09 04:14:42 +0000 | [diff] [blame] | 42 | PyCObject *self; |
Guido van Rossum | 1f84449 | 1997-10-21 19:48:35 +0000 | [diff] [blame] | 43 | |
Larry Hastings | 5ac006d | 2010-04-02 11:01:35 +0000 | [diff] [blame] | 44 | if (cobject_deprecation_warning()) { |
| 45 | return NULL; |
| 46 | } |
| 47 | |
Fred Drake | 3be9a8a | 2000-07-09 04:14:42 +0000 | [diff] [blame] | 48 | if (!desc) { |
| 49 | PyErr_SetString(PyExc_TypeError, |
| 50 | "PyCObject_FromVoidPtrAndDesc called with null" |
| 51 | " description"); |
| 52 | return NULL; |
Guido van Rossum | e0e6962 | 1997-01-22 20:48:48 +0000 | [diff] [blame] | 53 | } |
Fred Drake | 3be9a8a | 2000-07-09 04:14:42 +0000 | [diff] [blame] | 54 | self = PyObject_NEW(PyCObject, &PyCObject_Type); |
| 55 | if (self == NULL) |
| 56 | return NULL; |
Jeremy Hylton | 6d3e018 | 2003-07-11 17:02:39 +0000 | [diff] [blame] | 57 | self->cobject = cobj; |
| 58 | self->destructor = (destructor1)destr; |
| 59 | self->desc = desc; |
Guido van Rossum | e0e6962 | 1997-01-22 20:48:48 +0000 | [diff] [blame] | 60 | |
Fred Drake | 3be9a8a | 2000-07-09 04:14:42 +0000 | [diff] [blame] | 61 | return (PyObject *)self; |
| 62 | } |
| 63 | |
| 64 | void * |
| 65 | PyCObject_AsVoidPtr(PyObject *self) |
| 66 | { |
| 67 | if (self) { |
Larry Hastings | 5ac006d | 2010-04-02 11:01:35 +0000 | [diff] [blame] | 68 | if (PyCapsule_CheckExact(self)) { |
| 69 | const char *name = PyCapsule_GetName(self); |
| 70 | return (void *)PyCapsule_GetPointer(self, name); |
| 71 | } |
Fred Drake | 3be9a8a | 2000-07-09 04:14:42 +0000 | [diff] [blame] | 72 | if (self->ob_type == &PyCObject_Type) |
| 73 | return ((PyCObject *)self)->cobject; |
| 74 | PyErr_SetString(PyExc_TypeError, |
| 75 | "PyCObject_AsVoidPtr with non-C-object"); |
| 76 | } |
| 77 | if (!PyErr_Occurred()) |
| 78 | PyErr_SetString(PyExc_TypeError, |
| 79 | "PyCObject_AsVoidPtr called with null pointer"); |
| 80 | return NULL; |
| 81 | } |
| 82 | |
| 83 | void * |
| 84 | PyCObject_GetDesc(PyObject *self) |
| 85 | { |
| 86 | if (self) { |
| 87 | if (self->ob_type == &PyCObject_Type) |
| 88 | return ((PyCObject *)self)->desc; |
| 89 | PyErr_SetString(PyExc_TypeError, |
| 90 | "PyCObject_GetDesc with non-C-object"); |
| 91 | } |
| 92 | if (!PyErr_Occurred()) |
| 93 | PyErr_SetString(PyExc_TypeError, |
| 94 | "PyCObject_GetDesc called with null pointer"); |
| 95 | return NULL; |
| 96 | } |
| 97 | |
| 98 | void * |
| 99 | PyCObject_Import(char *module_name, char *name) |
| 100 | { |
| 101 | PyObject *m, *c; |
| 102 | void *r = NULL; |
| 103 | |
| 104 | if ((m = PyImport_ImportModule(module_name))) { |
| 105 | if ((c = PyObject_GetAttrString(m,name))) { |
| 106 | r = PyCObject_AsVoidPtr(c); |
| 107 | Py_DECREF(c); |
| 108 | } |
| 109 | Py_DECREF(m); |
| 110 | } |
| 111 | return r; |
Guido van Rossum | e0e6962 | 1997-01-22 20:48:48 +0000 | [diff] [blame] | 112 | } |
| 113 | |
Martin v. Löwis | 01a74b2 | 2003-10-19 18:30:01 +0000 | [diff] [blame] | 114 | int |
Neal Norwitz | bab05c9 | 2006-01-24 06:06:11 +0000 | [diff] [blame] | 115 | PyCObject_SetVoidPtr(PyObject *self, void *cobj) |
Martin v. Löwis | 01a74b2 | 2003-10-19 18:30:01 +0000 | [diff] [blame] | 116 | { |
Neal Norwitz | bab05c9 | 2006-01-24 06:06:11 +0000 | [diff] [blame] | 117 | PyCObject* cself = (PyCObject*)self; |
| 118 | if (cself == NULL || !PyCObject_Check(cself) || |
| 119 | cself->destructor != NULL) { |
Martin v. Löwis | 01a74b2 | 2003-10-19 18:30:01 +0000 | [diff] [blame] | 120 | PyErr_SetString(PyExc_TypeError, |
| 121 | "Invalid call to PyCObject_SetVoidPtr"); |
| 122 | return 0; |
| 123 | } |
Neal Norwitz | bab05c9 | 2006-01-24 06:06:11 +0000 | [diff] [blame] | 124 | cself->cobject = cobj; |
Martin v. Löwis | 01a74b2 | 2003-10-19 18:30:01 +0000 | [diff] [blame] | 125 | return 1; |
| 126 | } |
| 127 | |
Guido van Rossum | 77654a7 | 1996-01-12 00:44:03 +0000 | [diff] [blame] | 128 | static void |
Fred Drake | 3be9a8a | 2000-07-09 04:14:42 +0000 | [diff] [blame] | 129 | PyCObject_dealloc(PyCObject *self) |
Guido van Rossum | 77654a7 | 1996-01-12 00:44:03 +0000 | [diff] [blame] | 130 | { |
Fred Drake | 3be9a8a | 2000-07-09 04:14:42 +0000 | [diff] [blame] | 131 | if (self->destructor) { |
| 132 | if(self->desc) |
| 133 | ((destructor2)(self->destructor))(self->cobject, self->desc); |
| 134 | else |
| 135 | (self->destructor)(self->cobject); |
| 136 | } |
| 137 | PyObject_DEL(self); |
Guido van Rossum | 77654a7 | 1996-01-12 00:44:03 +0000 | [diff] [blame] | 138 | } |
| 139 | |
Guido van Rossum | e0e6962 | 1997-01-22 20:48:48 +0000 | [diff] [blame] | 140 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 141 | PyDoc_STRVAR(PyCObject_Type__doc__, |
Guido van Rossum | cee555b | 1996-08-01 00:02:33 +0000 | [diff] [blame] | 142 | "C objects to be exported from one extension module to another\n\ |
| 143 | \n\ |
| 144 | C objects are used for communication between extension modules. They\n\ |
| 145 | provide a way for an extension module to export a C interface to other\n\ |
| 146 | extension modules, so that extension modules can use the Python import\n\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 147 | mechanism to link to one another."); |
Guido van Rossum | 77654a7 | 1996-01-12 00:44:03 +0000 | [diff] [blame] | 148 | |
| 149 | PyTypeObject PyCObject_Type = { |
Martin v. Löwis | 6819210 | 2007-07-21 06:55:02 +0000 | [diff] [blame] | 150 | PyVarObject_HEAD_INIT(&PyType_Type, 0) |
Georg Brandl | 347b300 | 2006-03-30 11:57:00 +0000 | [diff] [blame] | 151 | "PyCObject", /*tp_name*/ |
| 152 | sizeof(PyCObject), /*tp_basicsize*/ |
| 153 | 0, /*tp_itemsize*/ |
Fred Drake | 3be9a8a | 2000-07-09 04:14:42 +0000 | [diff] [blame] | 154 | /* methods */ |
Georg Brandl | 347b300 | 2006-03-30 11:57:00 +0000 | [diff] [blame] | 155 | (destructor)PyCObject_dealloc, /*tp_dealloc*/ |
| 156 | 0, /*tp_print*/ |
| 157 | 0, /*tp_getattr*/ |
| 158 | 0, /*tp_setattr*/ |
| 159 | 0, /*tp_compare*/ |
| 160 | 0, /*tp_repr*/ |
| 161 | 0, /*tp_as_number*/ |
| 162 | 0, /*tp_as_sequence*/ |
| 163 | 0, /*tp_as_mapping*/ |
| 164 | 0, /*tp_hash*/ |
| 165 | 0, /*tp_call*/ |
| 166 | 0, /*tp_str*/ |
| 167 | 0, /*tp_getattro*/ |
| 168 | 0, /*tp_setattro*/ |
| 169 | 0, /*tp_as_buffer*/ |
| 170 | 0, /*tp_flags*/ |
| 171 | PyCObject_Type__doc__ /*tp_doc*/ |
Guido van Rossum | 77654a7 | 1996-01-12 00:44:03 +0000 | [diff] [blame] | 172 | }; |