1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
// -*- mode: cpp; mode: fold -*-
// Description /*{{{*/
// $Id: generic.h,v 1.4 2002/03/10 05:45:34 mdz Exp $
/* ######################################################################
generic - Some handy functions to make integration a tad simpler
Python needs this little _HEAD tacked onto the front of the object..
This complicates the integration with C++. We use some templates to
make that quite transparent to us. It would have been nice if Python
internally used a page from the C++ ref counting book to hide its little
header from the world, but it doesn't.
The CppPyObject has the target object and the Python header, this is
needed to ensure proper alignment.
GetCpp returns the C++ object from a PyObject.
CppPyObject_NEW creates the Python object and then uses placement new
to init the C++ class.. This is good for simple situations and as an
example on how to do it in other more specific cases.
CppPyObject_Dealloc should be used in the Type as the destructor
function.
HandleErrors converts errors from the internal _error stack into Python
exceptions and makes sure the _error stack is empty.
##################################################################### */
/*}}}*/
#ifndef GENERIC_H
#define GENERIC_H
#include <Python.h>
#include <string>
#include <iostream>
#include <new>
#if PYTHON_API_VERSION < 1013
typedef int Py_ssize_t;
#endif
/* Define compatibility for Python 3.
*
* We will use the names PyString_* to refer to the default string type
* of the current Python version (PyString on 2.X, PyUnicode on 3.X).
*
* When we really need unicode strings, we will use PyUnicode_* directly, as
* long as it exists in Python 2 and Python 3.
*
* When we want bytes in Python 3, we use PyBytes*_ instead of PyString_* and
* define aliases from PyBytes_* to PyString_* for Python 2.
*/
#if PY_MAJOR_VERSION >= 3
#define PyString_Check PyUnicode_Check
#define PyString_FromString PyUnicode_FromString
#define PyString_FromStringAndSize PyUnicode_FromStringAndSize
#define PyString_AsString(op) PyBytes_AsString(PyUnicode_AsUTF8String(op))
#define PyInt_Check PyLong_Check
#define PyInt_AsLong PyLong_AsLong
// Force 0.7 compatibility to be off in Python 3 builds
#undef COMPAT_0_7
#else
#define PyBytes_Check PyString_Check
#define PyBytes_AsString PyString_AsString
#define PyBytes_AsStringAndSize PyString_AsStringAndSize
#endif
// Hacks to make Python 2.4 build.
#if PY_MAJOR_VERSION == 2 && PY_MINOR_VERSION <= 4
#define PyErr_WarnEx(cat,msg,stacklevel) PyErr_Warn(cat,msg)
#endif
template <class T> struct CppPyObject : public PyObject
{
// We are only using CppPyObject and friends as dumb structs only, ie the
// c'tor is never called.
// However if T doesn't have a default c'tor C++ doesn't generate one for
// CppPyObject (since it can't know how it should initialize Object).
//
// This causes problems then in CppOwnedPyObject, for which C++ can't create
// a c'tor that calls the base class c'tor (which causes a compilation
// error).
// So basically having the c'tor here removes the need for T to have a
// default c'tor, which is not always desireable.
CppPyObject() { };
T Object;
};
template <class T> struct CppOwnedPyObject : public CppPyObject<T>
{
PyObject *Owner;
};
template <class T>
inline T &GetCpp(PyObject *Obj)
{
return ((CppPyObject<T> *)Obj)->Object;
}
template <class T>
inline PyObject *GetOwner(PyObject *Obj)
{
return ((CppOwnedPyObject<T> *)Obj)->Owner;
}
// Generic 'new' functions
template <class T>
inline CppPyObject<T> *CppPyObject_NEW(PyTypeObject *Type)
{
#ifdef ALLOC_DEBUG
std::cerr << "=== ALLOCATING " << Type->tp_name << " ===\n";
#endif
CppPyObject<T> *New = (CppPyObject<T>*)Type->tp_alloc(Type, 0);
new (&New->Object) T;
return New;
}
template <class T,class A>
inline CppPyObject<T> *CppPyObject_NEW(PyTypeObject *Type,A const &Arg)
{
#ifdef ALLOC_DEBUG
std::cerr << "=== ALLOCATING " << Type->tp_name << " ===\n";
#endif
CppPyObject<T> *New = (CppPyObject<T>*)Type->tp_alloc(Type, 0);
new (&New->Object) T(Arg);
return New;
}
template <class T>
inline CppOwnedPyObject<T> *CppOwnedPyObject_NEW(PyObject *Owner,
PyTypeObject *Type)
{
#ifdef ALLOC_DEBUG
std::cerr << "=== ALLOCATING " << Type->tp_name << "+ ===\n";
#endif
CppOwnedPyObject<T> *New = (CppOwnedPyObject<T>*)Type->tp_alloc(Type, 0);
new (&New->Object) T;
New->Owner = Owner;
Py_INCREF(Owner);
return New;
}
template <class T,class A>
inline CppOwnedPyObject<T> *CppOwnedPyObject_NEW(PyObject *Owner,
PyTypeObject *Type,A const &Arg)
{
#ifdef ALLOC_DEBUG
std::cerr << "=== ALLOCATING " << Type->tp_name << "+ ===\n";
#endif
CppOwnedPyObject<T> *New = (CppOwnedPyObject<T>*)Type->tp_alloc(Type, 0);
new (&New->Object) T(Arg);
New->Owner = Owner;
if (Owner != 0)
Py_INCREF(Owner);
return New;
}
// Traversal and Clean for owned objects
template <class T>
int CppOwnedTraverse(PyObject *self, visitproc visit, void* arg) {
Py_VISIT(((CppOwnedPyObject<T> *)self)->Owner);
return 0;
}
template <class T>
int CppOwnedClear(PyObject *self) {
Py_CLEAR(((CppOwnedPyObject<T> *)self)->Owner);
return 0;
}
// Generic Dealloc type functions
template <class T>
void CppDealloc(PyObject *Obj)
{
#ifdef ALLOC_DEBUG
std::cerr << "=== DEALLOCATING " << Obj->ob_type->tp_name << " ===\n";
#endif
GetCpp<T>(Obj).~T();
Obj->ob_type->tp_free(Obj);
}
template <class T>
void CppOwnedDealloc(PyObject *iObj)
{
#ifdef ALLOC_DEBUG
std::cerr << "=== DEALLOCATING " << iObj->ob_type->tp_name << "+ ===\n";
#endif
CppOwnedPyObject<T> *Obj = (CppOwnedPyObject<T> *)iObj;
Obj->Object.~T();
CppOwnedClear<T>(iObj);
iObj->ob_type->tp_free(iObj);
}
// Pointer deallocation
// Generic Dealloc type functions
template <class T>
void CppDeallocPtr(PyObject *Obj)
{
#ifdef ALLOC_DEBUG
std::cerr << "=== DEALLOCATING " << Obj->ob_type->tp_name << "* ===\n";
#endif
delete GetCpp<T>(Obj);
Obj->ob_type->tp_free(Obj);
}
template <class T>
void CppOwnedDeallocPtr(PyObject *iObj)
{
#ifdef ALLOC_DEBUG
std::cerr << "=== DEALLOCATING " << iObj->ob_type->tp_name << "*+ ===\n";
#endif
CppOwnedPyObject<T> *Obj = (CppOwnedPyObject<T> *)iObj;
delete Obj->Object;
CppOwnedClear<T>(iObj);
iObj->ob_type->tp_free(iObj);
}
inline PyObject *CppPyString(std::string Str)
{
return PyString_FromStringAndSize(Str.c_str(),Str.length());
}
inline PyObject *Safe_FromString(const char *Str)
{
if (Str == 0)
return PyString_FromString("");
return PyString_FromString(Str);
}
// Convert _error into Python exceptions
PyObject *HandleErrors(PyObject *Res = 0);
// Convert a list of strings to a char **
const char **ListToCharChar(PyObject *List,bool NullTerm = false);
PyObject *CharCharToList(const char **List,unsigned long Size = 0);
#endif
|
