HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PY_CPythonAPI.h
Go to the documentation of this file.
1 /*
2  * PROPRIETARY INFORMATION. This software is proprietary to
3  * Side Effects Software Inc., and is not to be reproduced,
4  * transmitted, or disclosed in any way without written permission.
5  *
6  * COMMENTS:
7  * This file provides a set of functions, types, and macros that wrap
8  * Python's C API. This way, we can choose at runtime which version
9  * of the Python library we load, and we do not add a compile/link-time
10  * dependency on a particular version of Python. Use this wrapper API
11  * as follows:
12  *
13  * - Instead of including <python/Python.h>, instead include
14  * PY_CPythonAPI.h. Still include this file first, just like you would
15  * with Python.h.
16  * (It's even in the Python docs that you need to include Python.h
17  * before anything else. Otherwise you get strange gcc warnings.)
18  *
19  * - Add a "PY_" prefix to all Python functions, types, and macros. For
20  * example,
21  * PyObject *dict = PyDict_New();
22  * becomes
23  * PY_PyObject *dict = PY_PyDict_New();
24  *
25  * - Access to Python constants, such as PyExc_SystemExit, become function
26  * calls. For example,
27  * PyErr_SetObject(PyExc_IndexError, error_message);
28  * becomes
29  * PY_PyErr_SetObject(PY_PyExc_IndexError(), error_message);
30  *
31  * - When directly accessing members of Python structures, change the
32  * data member accesses into method calls. For example, when accessing
33  * the ob_type member of a [PY_]PyObject,
34  * op->ob_type
35  * becomes
36  * ob->ob_type()
37  *
38  * - Constructing instances of Python objects like PySequenceMethods,
39  * or creating subclasses of PyObject, is different.
40  */
41 
42 #ifndef __PY_CPythonAPI_h__
43 #define __PY_CPythonAPI_h__
44 
45 #include "PY_API.h"
46 #include <UT/UT_WorkBuffer.h>
47 #include <SYS/SYS_Types.h>
48 #include <SYS/SYS_Visibility.h>
49 #include <hboost/preprocessor/seq/for_each.hpp>
50 #include <hboost/preprocessor/seq/for_each_i.hpp>
51 #include <hboost/preprocessor/seq/seq.hpp>
52 #include <hboost/preprocessor/punctuation/comma_if.hpp>
53 #include <hboost/preprocessor/cat.hpp>
54 #include <hboost/preprocessor/stringize.hpp>
55 #include <stdarg.h>
56 #include <stdio.h>
57 #include <string.h>
58 
59 #ifdef WIN32
60 // Disable MSVC warnings about not enough actual parameters for macros.
61 // Otherwise, wrapped functions that take no parameters will generate
62 // warnings.
63 #pragma warning(disable:4003)
64 #endif
65 
66 
67 using PY_AtExitFunc = void (*)();
68 
69 // The Py_Main signature changed between Python 2 and 3.
70 #if defined(USE_PYTHON3)
71 
72 #define PY_FUNC_SEQ_Py_Main \
73  ((Py_Main)(int)((int)(wchar_t **)))
74 
75 #define PY_FUNC_SEQ_PySys_SetArgv \
76  ((PySys_SetArgv)(void)((int)(wchar_t **)))
77 
78 #define PY_FUNC_SEQ_PySys_SetArgvEx \
79  ((PySys_SetArgvEx)(void)((int)(wchar_t **)(int)))
80 #else
81 
82 #define PY_FUNC_SEQ_Py_Main \
83  ((Py_Main)(int)((int)(char **)))
84 
85 #define PY_FUNC_SEQ_PySys_SetArgv \
86  ((PySys_SetArgv)(void)((int)(char **)))
87 
88 #define PY_FUNC_SEQ_PySys_SetArgvEx \
89  ((PySys_SetArgvEx)(void)((int)(char **)(int)))
90 #endif
91 
92 
93 class PY_PyFrameObject;
94 class PY_PyObject;
95 class UT_WorkBuffer;
96 
97 // These are the functions we'll automatically wrap, of the form
98 // (function_name)(return_type)(parm_types). parm_types is itself a sequence
99 // of (T1)(T2)(T3). While the wrapped functions don't have a "PY_" prefix,
100 // any non-native data types do.
101 #define PY_WRAPPED_FUNCTIONS \
102  ((_PyImport_AcquireLock)(void)()) \
103  ((_PyImport_ReleaseLock)(int)()) \
104  ((Py_AtExit)(int)((PY_AtExitFunc))) \
105  ((PyGILState_Release)(void)((PY_PyGILState_STATE))) \
106  ((PyRun_SimpleStringFlags)(int)((const char *)(PY_PyCompilerFlags *))) \
107  ((Py_CompileStringFlags)(PY_PyObject *) \
108  ((const char *)(const char *)(int)(PY_PyCompilerFlags *))) \
109  ((PyCFunction_NewEx)(PY_PyObject *) \
110  ((PY_PyMethodDef *)(PY_PyObject *)(PY_PyObject *))) \
111  ((PyEval_CallObjectWithKeywords)(PY_PyObject *) \
112  ((PY_PyObject *)(PY_PyObject *)(PY_PyObject *))) \
113  ((PyEval_GetFrame)(PY_PyFrameObject *)()) \
114  ((PyEval_EvalCode)(PY_PyObject *) \
115  ((PY_PyCodeObject *)(PY_PyObject *)(PY_PyObject *))) \
116  ((PyThread_get_thread_ident)(long)()) \
117  ((PyThreadState_SetAsyncExc)(int)((long)(PY_PyObject *))) \
118  PY_FUNC_SEQ_Py_Main \
119  ((Py_IncRef)(void)((PY_PyObject *))) \
120  ((Py_DecRef)(void)((PY_PyObject *))) \
121  ((PyObject_GetAttr)(PY_PyObject *)((PY_PyObject *)(PY_PyObject *))) \
122  ((PyObject_GetAttrString)(PY_PyObject *)((PY_PyObject *)(const char *))) \
123  ((PyObject_SetAttr)(int)((PY_PyObject *)(PY_PyObject *)(PY_PyObject *))) \
124  ((PyObject_Repr)(PY_PyObject *)((PY_PyObject*))) \
125  ((PyObject_Str)(PY_PyObject *)((PY_PyObject *))) \
126  ((PyObject_IsTrue)(int)((PY_PyObject *))) \
127  ((PyObject_CallObject)(PY_PyObject *)((PY_PyObject *)(PY_PyObject *))) \
128  ((PyObject_Call)(PY_PyObject *) \
129  ((PY_PyObject *)(PY_PyObject *)(PY_PyObject *))) \
130  ((PyObject_GetIter)(PY_PyObject *)((PY_PyObject *))) \
131  ((PyObject_RichCompareBool)(int)((PY_PyObject *)(PY_PyObject *)(int))) \
132  ((PyObject_Print)(int)((PY_PyObject *)(FILE *)(int))) \
133  ((PyObject_Hash)(PY_Py_hash_t)((PY_PyObject *))) \
134  ((Py_VaBuildValue)(PY_PyObject *)((const char *)(va_list))) \
135  ((PyArg_VaParse)(int)((PY_PyObject *)(const char *)(va_list))) \
136  ((PyType_IsSubtype)(int)((PY_PyTypeObject *)(PY_PyTypeObject *))) \
137  ((PyType_Ready)(int)((PY_PyTypeObject *))) \
138  ((PyErr_Occurred)(PY_PyObject *)()) \
139  ((PyErr_ExceptionMatches)(int)((PY_PyObject *))) \
140  ((PyErr_Fetch)(void)((PY_PyObject **)(PY_PyObject **)(PY_PyObject **))) \
141  ((PyErr_Clear)(void)()) \
142  ((PyErr_NormalizeException)(void) \
143  ((PY_PyObject **)(PY_PyObject **)(PY_PyObject **))) \
144  ((PyErr_Print)(void)()) \
145  ((PyErr_SetInterrupt)(void)()) \
146  ((PyErr_SetString)(void)((PY_PyObject *)(const char *))) \
147  ((PyErr_SetNone)(void)((PY_PyObject *))) \
148  ((PyErr_SetObject)(void)((PY_PyObject *)(PY_PyObject *))) \
149  ((PyErr_CheckSignals)(int)()) \
150  ((PyLong_FromLongLong)(PY_PyObject *)((int64))) \
151  ((PyLong_FromLong)(PY_PyObject *)((long))) \
152  ((PyLong_AsLong)(long)((PY_PyObject *))) \
153  ((PyLong_AsLongLong)(int64)((PY_PyObject *))) \
154  ((PyLong_AsVoidPtr)(void*)((PY_PyObject *))) \
155  ((PyFloat_AsDouble)(double)((PY_PyObject *))) \
156  ((PyFloat_FromDouble)(PY_PyObject *)((double))) \
157  ((PySequence_Check)(int)((PY_PyObject *))) \
158  ((PySequence_Size)(PY_Py_ssize_t)((PY_PyObject *))) \
159  ((PySequence_GetItem)(PY_PyObject *)((PY_PyObject *)(PY_Py_ssize_t))) \
160  ((PyList_New)(PY_PyObject *)((PY_Py_ssize_t))) \
161  ((PyList_Size)(PY_Py_ssize_t)((PY_PyObject *))) \
162  ((PyList_GetItem)(PY_PyObject *)((PY_PyObject *)(PY_Py_ssize_t))) \
163  ((PyList_SetItem)(int)((PY_PyObject *)(PY_Py_ssize_t)(PY_PyObject *))) \
164  ((PyList_Append)(int)((PY_PyObject *)(PY_PyObject *))) \
165  ((PyTuple_New)(PY_PyObject *)((PY_Py_ssize_t))) \
166  ((PyTuple_SetItem)(int)((PY_PyObject *)(PY_Py_ssize_t)(PY_PyObject *))) \
167  ((PyTuple_Size)(PY_Py_ssize_t)((PY_PyObject *))) \
168  ((PyDict_Copy)(PY_PyObject *)((PY_PyObject *))) \
169  ((PyDict_New)(PY_PyObject *)()) \
170  ((PyDict_Clear)(void)((PY_PyObject *))) \
171  ((PyDict_Next)(int) \
172  ((PY_PyObject *)(PY_Py_ssize_t *)(PY_PyObject **)(PY_PyObject **))) \
173  ((PyDict_GetItem)(PY_PyObject *)((PY_PyObject *)(PY_PyObject *))) \
174  ((PyDict_GetItemString)(PY_PyObject *)((PY_PyObject *)(const char *))) \
175  ((PyDict_SetItemString)(int) \
176  ((PY_PyObject *)(const char *)(PY_PyObject *))) \
177  ((PyDict_SetItem)(int)((PY_PyObject *)(PY_PyObject *)(PY_PyObject *))) \
178  ((PyDict_DelItemString)(PY_PyObject *)((PY_PyObject *)(const char *))) \
179  ((PyDict_Merge)(int)((PY_PyObject *)(PY_PyObject *)(int))) \
180  ((PyDict_Size)(int)((PY_PyObject *))) \
181  ((PyIter_Next)(PY_PyObject *)((PY_PyObject *))) \
182  ((PyFunction_GetCode)(PY_PyObject *)((PY_PyObject *))) \
183  ((PyCallable_Check)(int)((PY_PyObject *))) \
184  ((PyImport_ImportModule)(PY_PyObject *)((const char *))) \
185  ((PyImport_ExecCodeModule)(PY_PyObject *)((char *)(PY_PyObject *))) \
186  ((PyImport_AddModule)(PY_PyObject *)((const char *))) \
187  ((PyImport_GetMagicNumber)(long)()) \
188  ((PyModule_GetDict)(PY_PyObject *)((PY_PyObject *))) \
189  ((PyModule_AddObject)(int)((PY_PyObject *)(const char *)(PY_PyObject *))) \
190  PY_FUNC_SEQ_PySys_SetArgv \
191  PY_FUNC_SEQ_PySys_SetArgvEx \
192  ((PySys_GetObject)(PY_PyObject *)((char *))) \
193  ((PyOS_InitInterrupts)(void)()) \
194  ((PyMarshal_ReadObjectFromString)(PY_PyObject *)((char *)(PY_Py_ssize_t))) \
195  ((PyMarshal_WriteObjectToString)(PY_PyObject *)((PY_PyObject *)(int))) \
196  ((PyRun_InteractiveLoopFlags)(int) \
197  ((FILE *)(const char *)(PY_PyCompilerFlags *)))
198 
199 // Like PY_WRAPPED_FUNCTIONS above, these are the functions we'll automatically
200 // wrap, of the form (function_name)(return_type)(parm_types). parm_types is
201 // itself a sequence of (T1)(T2)(T3). While the wrapped functions don't have a
202 // "PY_" prefix, any non-native data types do.
203 //
204 // The difference here from PY_WRAPPED_FUNCTIONS is that these functions do not
205 // assert on debug builds whether we have the GIL when they're called.
206 #define PY_WRAPPED_UNCHECKED_FUNCTIONS \
207  ((Py_InitializeEx)(void)((int))) \
208  ((Py_IsInitialized)(int)()) \
209  ((Py_SetProgramName)(void)((char*))) \
210  ((Py_SetPythonHome)(void)((char*))) \
211  ((PyEval_InitThreads)(void)()) \
212  ((PyEval_RestoreThread)(void)((PY_PyThreadState *))) \
213  ((PyEval_SaveThread)(PY_PyThreadState *)()) \
214  ((PyGILState_Ensure)(PY_PyGILState_STATE)()) \
215  ((PyGILState_GetThisThreadState)(PY_PyThreadState *)()) \
216  /**/
217 
218 // These wrapped functions only require the GIL on Python 3
219 #define PY_WRAPPED_MEMORY_FUNCTIONS \
220  ((PyMem_Malloc)(void *)((size_t))) \
221  ((PyMem_Free)(void)((void *))) \
222  /**/
223 
224 // These are the constants we'll automatically wrap, of the form
225 // (constant_name)(type). The names of the constants must correspond directly
226 // to symbols in the Python shared object.
227 #if defined(USE_PYTHON3)
228 typedef char *(*PY_PyOS_ReadlineFunctionPointerType)
229  (FILE *, FILE *, const char *);
230 #else
231 typedef char *(*PY_PyOS_ReadlineFunctionPointerType)(FILE *, FILE *, char *);
232 #endif
233 #define PY_WRAPPED_CONSTANTS \
234  ((_Py_NoneStruct)(PY_PyObject)) \
235  ((_PyOS_ReadlineTState)(PY_PyThreadState *)) \
236  ((PyOS_ReadlineFunctionPointer)(PY_PyOS_ReadlineFunctionPointerType)) \
237  ((PyExc_RuntimeError)(PY_PyObject *)) \
238  ((PyExc_IndexError)(PY_PyObject *)) \
239  ((PyExc_AttributeError)(PY_PyObject *)) \
240  ((PyExc_TypeError)(PY_PyObject *)) \
241  ((PyExc_KeyboardInterrupt)(PY_PyObject *)) \
242  ((PyExc_SystemExit)(PY_PyObject *)) \
243  ((PyExc_BaseException)(PY_PyObject *)) \
244  ((PyLong_Type)(PY_PyTypeObject)) \
245  ((PyBool_Type)(PY_PyTypeObject)) \
246  ((PyFloat_Type)(PY_PyTypeObject)) \
247  ((PyUnicode_Type)(PY_PyTypeObject)) \
248  ((PyTuple_Type)(PY_PyTypeObject)) \
249  ((PyList_Type)(PY_PyTypeObject)) \
250  ((PyDict_Type)(PY_PyTypeObject)) \
251  ((PyFunction_Type)(PY_PyTypeObject))
252 
253 //----------------------------------------------------------------------------
254 
255 // These initial macros simplify usage of Boost's preprocessor SEQ_FOR_EACH
256 // macros. SEQ_FOR_EACH works as follows: you pass it a callback macro,
257 // some extra data, and a sequence of the form (a)(b)(c). It then calls
258 // the callback macro with a repetition construct (named r, and only used
259 // internally by boost), the extra data you pased in, and each element of
260 // the sequence.
261 //
262 // Almost all the time, you don't need extra data, so you pass in _ and
263 // ingore the second parameter in the callback macro.
264 //
265 // Often, the sequence contains other sequences, and that's where these
266 // macros come in handy. PY_FOR_EACH_SEQ_OF_2, for example, takes a callback
267 // and a sequence of pair sequences of the form ((A1)(A2))((B1)(B2))((C1)(C2)).
268 // It then calls the callback with (A1, A2), then with (B1, B2), and so on.
269 // PY_FOR_EACH_SEQ_OF_3 works with sequences of triplets.
270 
271 // This helper macro works by passing in the caller's macro as the extra data.
272 // The caller's macro will then be the second argument of the
273 // PY_CALLBACK_SEQ_OF_2 macro.
274 #define PY_FOR_EACH_SEQ_OF_2(macro, seq) \
275  HBOOST_PP_SEQ_FOR_EACH(PY_CALLBACK_SEQ_OF_2, macro, seq)
276 
277 // Pull off the first and second elements of the sequence, and pass them into
278 // the caller's macro.
279 #define PY_CALLBACK_SEQ_OF_2(r, macro, seq) \
280  macro(PY_SEQ_ELEM_0(seq), PY_SEQ_ELEM_1(seq))
281 
282 
283 // This helper macro is similar to the last one, except it works with
284 // subsequences of 3 elements.
285 #define PY_FOR_EACH_SEQ_OF_3(macro, seq) \
286  HBOOST_PP_SEQ_FOR_EACH(PY_CALLBACK_SEQ_OF_3, macro, seq)
287 #define PY_CALLBACK_SEQ_OF_3(r, macro, seq) \
288  macro(PY_SEQ_ELEM_0(seq), PY_SEQ_ELEM_1(seq), PY_SEQ_ELEM_2(seq))
289 
290 
291 // These helper macros extract the first, second, and third elements from
292 // an (a)(b)(c) style sequence.
293 #define PY_SEQ_ELEM_0(seq) \
294  HBOOST_PP_SEQ_HEAD(seq)
295 #define PY_SEQ_ELEM_1(seq) \
296  HBOOST_PP_SEQ_HEAD(HBOOST_PP_SEQ_TAIL(seq))
297 #define PY_SEQ_ELEM_2(seq) \
298  HBOOST_PP_SEQ_HEAD(HBOOST_PP_SEQ_TAIL(HBOOST_PP_SEQ_TAIL(seq)))
299 
300 //----------------------------------------------------------------------------
301 
302 // This macro takes a sequence of of parameter types (T1)(T2)(T3) and creates a
303 // parameter list of the form T1 arg1, T2 arg2, T3 arg3. SEQ_FOR_EACH_I
304 // passes in the index as well as the element into PY_MAKE_PARM.
305 #define PY_MAKE_PARM_LIST(parm_types) \
306  HBOOST_PP_SEQ_FOR_EACH_I(PY_MAKE_PARM, _, parm_types)
307 
308 // unused_data is the second parameter passed to FOR_EACH_I. i is the index
309 // of the element in the parm types sequence, and elem is that element.
310 // If i is not 0, we add a comma to make sure the parameters are comma-
311 // separated.
312 #define PY_MAKE_PARM(r, unused_data, i, elem) \
313  HBOOST_PP_COMMA_IF(i) elem HBOOST_PP_CAT(arg, i)
314 
315 // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
316 
317 // This macro takes a sequence of of parameter types (T1)(T2)(T3) and creates
318 // an argument list of the form arg1, arg2, arg3. The length of the parameter
319 // type sequence is used, but the actual parameter types are not.
320 #define PY_MAKE_ARG_LIST(parm_types) \
321  HBOOST_PP_SEQ_FOR_EACH_I(PY_MAKE_ARG, _, parm_types)
322 
323 #define PY_MAKE_ARG(r, unused_data, i, unused_elem) \
324  HBOOST_PP_COMMA_IF(i) HBOOST_PP_CAT(arg, i)
325 
326 //============================================================================
327 
328 // These enums and opaque types are used by the wrapped Python functions:
335 
336 #if defined(WIN32)
337  // Windows doesn't define ssize_t (a signed version of size_t). pyconfig.h
338  // (included by Python.h) does define it, though. So, rather than defining
339  // ssize_t and risking a compiler error if Python.h is ever included in our
340  // code or HDK code, we instead just define PY_Py_ssize_t directly.
341  #if SIZEOF_VOID_P == 8
342  typedef int64 PY_Py_ssize_t;
343  #else
344  typedef int32 PY_Py_ssize_t;
345  #endif
346 #else
347  typedef ssize_t PY_Py_ssize_t;
348 #endif
349 
350 // Python 3.3+ defines Py_hash_t
352 
353 // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
354 
355 // This helper function is used below to emulate the result of looking up a
356 // struct element via an offset, without actually knowing the type definition
357 // of the object.
358 template <typename RETURN_TYPE>
359 static inline RETURN_TYPE &
360 pyAccessStructMember(void *c_struct, int offset)
361 { return *(RETURN_TYPE *)((char *)c_struct + offset); }
362 
363 // We can't actually declare Python structures, since their size can change
364 // depending on defines that were set when Python was compiled. Also, their
365 // size and organization could change in future Python versions. Instead,
366 // we create wrapper classes with methods to look up the corresponding
367 // data member. For example, if you would normally write op->ob_type using
368 // the standard Python API, you instead write op->ob_type() using this API.
369 //
370 // Start by building up the Python class hierarchy. Since Python is written
371 // in C, the class hierarchy is built manually, using macros for common
372 // members between subclasses. These members aren't likely to change between
373 // Python versions, but if they do we can still preserve the API (i.e. using
374 // methods to access members), although we'll have to manually give some class
375 // definitions instead of letting macros take care of everything.
376 
377 // PY_PyObject_HEAD_EXTRA is at the beginning of most Python object structures.
378 // Unfortunately, its size varies depending on compiler defines, so we compute
379 // its size when we load the Python shared object. Its constructor is private
380 // and unimplemented so that you can't accidentally instance it or any of its
381 // subclasses.
383 {
384 public:
385  static int theStructSize;
386 private:
387  PY_PyObject_HEAD_EXTRA(); // unimplemented
388 };
389 
390 // This macro creates a new subclass, adding one member.
391 #define PY_ADD_SUBCLASS_1(subclass, base_class, member1_type, member1_name) \
392 class PY_API subclass : public base_class \
393 { \
394 public: \
395  member1_type member1_name() \
396  { return pyAccessStructMember<member1_type>( \
397  this, base_class::theStructSize); } \
398 \
399  static void computeStructSize() \
400  { theStructSize = base_class::theStructSize + sizeof(member1_type); } \
401 \
402  static int theStructSize; \
403 };
404 
405 // This macro creates a new subclass, adding two members.
406 #define PY_ADD_SUBCLASS_2(subclass, base_class, \
407  member1_type, member1_name, member2_type, member2_name) \
408 class PY_API subclass : public base_class \
409 { \
410 public: \
411  member1_type member1_name() \
412  { return pyAccessStructMember<member1_type>( \
413  this, base_class::theStructSize); } \
414 \
415  member2_type member2_name() \
416  { return pyAccessStructMember<member2_type>( \
417  this, base_class::theStructSize + sizeof(member1_type)); } \
418 \
419  static void computeStructSize() \
420  { theStructSize = base_class::theStructSize + \
421  sizeof(member1_type) + sizeof(member2_type); } \
422 \
423  static int theStructSize; \
424 };
425 
426 // The elements in the PyObject_HEAD_EXTRA are dependent on Python compilation
427 // settings. See the .C file for more information. The other structures
428 // we create are:
429 //
430 // PyObject_HEAD (common to all PyObject's) is defined as: (It's changed
431 // slightly in Python 3.0, but the size is the same. See PEP 3123.)
432 // PyObject_HEAD_EXTRA
433 // Py_ssize_t ob_refcnt;
434 // PyTypeObject *ob_type;
435 //
436 // PyObject_VAR_HEAD (common to all PyVarObject's) is defined as:
437 // PyObject_HEAD
438 // Py_ssize_t ob_size;
439 //
440 // PyTypeObject starts with:
441 // PyObject_VAR_HEAD
442 // const char *tp_name;
443 // ...more...
444 //
445 // PyFrameObject starts with:
446 // PyObject_VAR_HEAD
447 // PyFrameObject *f_back;
448 // PyCodeObject *f_code;
449 // ...more...
450 //
451 // PyListObject starts with
452 // PyObject_VAR_HEAD
453 // PyObject **ob_item;
454 // ...more...
455 //
456 // PyTupleObject starts with
457 // PyObject_VAR_HEAD
458 // PyObject *ob_item[1];
459 // ...more...
460 
462  PY_Py_ssize_t, ob_refcnt,
463  PY_PyTypeObject *, ob_type)
464 
466  PY_Py_ssize_t, ob_size)
467 
468 PY_ADD_SUBCLASS_1(PY_PyTypeObject, PY_PyVarObject,
469  const char *, tp_name)
470 
471 PY_ADD_SUBCLASS_2(PY_PyFrameObject, PY_PyVarObject,
472  PY_PyFrameObject *, f_back,
473  PY_PyCodeObject *, f_code)
474 
475 PY_ADD_SUBCLASS_1(PY_PyListObject, PY_PyVarObject,
476  PY_PyObject **, ob_item)
477 
478 // We need to manually specify PY_PyTupleObject. Its struct member is declared
479 // as "PyObject *ob_item[1]", so ob_item is a "PyObject **" whose value is
480 // computed as an offset from the "this" pointer, _without_ doing any
481 // dereferencing.
482 class PY_API PY_PyTupleObject : public PY_PyVarObject
483 {
484 public:
485  PY_PyObject **ob_item()
486  { return (PY_PyObject **)((char *)this + PY_PyVarObject::theStructSize); }
487 };
488 
489 //----------------------------------------------------------------------------
490 
491 // These few concrete types make it much easier to extend Python to add new
492 // classes, methods, etc. If Python changes their definition in future
493 // versions, we'll have to rework how we do things. Currently, though, these
494 // few classes are small.
495 
496 typedef PY_PyObject *(*PY_PyCFunction)(PY_PyObject *, PY_PyObject *);
497 
499 {
500  const char *ml_name;
502  int ml_flags;
503  const char *ml_doc;
504 };
505 
506 // New to Python 3.5.
507 // Required by PyModuleDef.
509 {
510  int slot;
511  void *value;
512 };
513 
514 //----------------------------------------------------------------------------
515 
516 // This macro takes a (function_name)(return_type)(parm_types) sequence and
517 // calls PY_DECLARE_FUNCTION.
518 #define PY_DECLARE_FUNCTION_FROM_SEQ(seq) \
519  PY_CALLBACK_SEQ_OF_3(_, PY_DECLARE_FUNCTION, seq)
520 
521 // This macro forward declares a function, prefixing "PY_" to the function
522 // name.
523 #define PY_DECLARE_FUNCTION(function_name, return_type, parm_types) \
524  PY_API return_type HBOOST_PP_CAT(PY_, function_name)( \
525  PY_MAKE_PARM_LIST(parm_types));
526 
527 // This macro forward declares the function that wraps a constant, prefixing
528 // "PY_" to the constant's name.
529 #define PY_DECLARE_WRAPPED_CONSTANT(constant_name, type) \
530  PY_API type &HBOOST_PP_CAT(PY_, constant_name)();
531 
532 // For each element in the big list of wrapped functions, create forward
533 // declarations. Create similar forward declarations for the big list of
534 // constants.
539 
540 // The PyBytes_Type symbol only exists in Python 3.
541 // It is preproc defined in Python 2.
542 // Therefore, we cannot register the constant with PY_WRAPPED_CONSTANTS.
543 // We want to map the constant in Python 3 but not in Python 2.
544 PY_DECLARE_WRAPPED_CONSTANT(PyBytes_Type, PY_PyTypeObject)
545 
546 //----------------------------------------------------------------------------
547 
548 // These functions need to be manually-wrapped:
551 PY_API PY_PyObject *PY_Py_BuildValue(const char *format, ...);
553  PY_PyObject *o, const char *name, const char *format, ...);
555 
556 #define PY_FUNC_SEQ_PyInt_AsLong (PyInt_AsLong)(long)((PY_PyObject *))
557 #define PY_FUNC_SEQ_PyInt_FromLong (PyInt_FromLong)(PY_PyObject *)((long))
558 #define PY_FUNC_SEQ_PyString_AsString \
559  (PyString_AsString)(char *)((PY_PyObject *))
560 #define PY_FUNC_SEQ_PyString_AsStringAndSize \
561  (PyString_AsStringAndSize)(int)((PY_PyObject *)(char **)(PY_Py_ssize_t *))
562 #define PY_FUNC_SEQ_PyString_FromString \
563  (PyString_FromString)(PY_PyObject *)((const char *))
564 #define PY_FUNC_SEQ_PyString_FromStringAndSize \
565  (PyString_FromStringAndSize)(PY_PyObject *)((const char *)(PY_Py_ssize_t))
566 #define PY_FUNC_SEQ_PyString_AsUTF8String \
567  (PyString_AsUTF8String)(PY_PyObject *)((PY_PyObject *))
568 #define PY_FUNC_SEQ_PyBytes_AsStringAndSize \
569  (PyBytes_AsStringAndSize)(int) \
570  ((PY_PyObject *)(char **)(PY_Py_ssize_t *))
571 #define PY_FUNC_SEQ_PyCObject_GetDesc \
572  (PyCObject_GetDesc)(void*)((PY_PyObject *))
573 #define PY_FUNC_SEQ_PyCObject_AsVoidPtr \
574  (PyCObject_AsVoidPtr)(void*)((PY_PyObject *))
575 #define PY_FUNC_SEQ_Py_DecodeLocale \
576  (Py_DecodeLocale)(wchar_t *)((const char *)(size_t *))
577 #define PY_FUNC_SEQ_PyMem_RawFree \
578  (PyMem_RawFree)(void)((void *))
579 #define PY_FUNC_SEQ_PyMem_RawMalloc \
580  (PyMem_RawMalloc)(void *)((size_t))
581 #define PY_FUNC_SEQ_PyModule_GetState \
582  (PyModule_GetState)(void *)((PY_PyObject *))
583 
598 
599 
600 // These wrapper functions replace constants. If the constants change between
601 // Python versions, we can use the value of pyPythonVersion to decide what to
602 // return. First do a search to make sure they're not called from static
603 // constructors, though (like PY_METH_VARARGS), since pyPythonVersion may not
604 // be intialized yet.
605 static inline int PY_Py_single_input() { return 256; }
606 static inline int PY_Py_file_input() { return 257; }
607 static inline int PY_Py_eval_input() { return 258; }
608 static inline int PY_Py_MARSHAL_VERSION() { return 2; }
609 static inline int PY_METH_VARARGS() { return 0x0001; }
610 static inline int PY_Py_EQ() { return 2; }
611 static inline int PY_PyGILState_LOCKED() { return 0; }
612 static inline int PY_PyGILState_UNLOCKED() { return 1; }
613 
614 
615 // _Py_TrueStruct, _Py_FalseStruct and _Py_ZeroStruct need to be manually
616 // wrapped. Before Python 3.0, _Py_TrueStruct and _Py_ZeroStruct are
617 // PyIntObjects. Starting in 3.0, they're PyLongObjects, since ints were
618 // removed. For our purposes, we don't care -- we just treat them as
619 // PyObjects. However, the automatically- generated wrapper functions will
620 // give compiler errors because it can't convert PyIntObject/PyLongObjects to
621 // PyObjects. So, we wrap them manually.
623 PY_DECLARE_WRAPPED_CONSTANT(_Py_FalseStruct, PY_PyObject)
624 PY_DECLARE_WRAPPED_CONSTANT(_Py_ZeroStruct, PY_PyObject)
625 
626 // Even though int and string have been replaced by long and unicode in Python
627 // 3.0, we still support the old API, including the old types. They're simply
628 // mapped to the replacement types internally. So, PyInt_Check and
629 // PyString_Check will actually be using longs and unicodes in Python 3.0.
630 PY_DECLARE_WRAPPED_CONSTANT(PyInt_Type, PY_PyTypeObject)
631 PY_DECLARE_WRAPPED_CONSTANT(PyString_Type, PY_PyTypeObject)
632 PY_DECLARE_WRAPPED_CONSTANT(Py_TabcheckFlag, int)
633 PY_DECLARE_WRAPPED_CONSTANT(_PyThreadState_Current, PY_PyThreadState *)
634 #define PY_PyInt_Check(op) PY_PyObject_TypeCheck(op, &PY_PyInt_Type())
635 #define PY_PyString_Check(op) PY_PyObject_TypeCheck(op, &PY_PyString_Type())
636 
637 
638 // Various macros follow, to account for API elements that do not have symbols
639 // in the Python shared object. Note that they might need to be modified if
640 // the they change between Python versions.
641 #define PY_Py_INCREF PY_Py_IncRef
642 #define PY_Py_DECREF PY_Py_DecRef
643 #define PY_Py_XDECREF(op) if ((op) == NULL) ; else PY_Py_DECREF(op)
644 
645 #define PY_Py_False() (&PY__Py_ZeroStruct())
646 #define PY_Py_True() (&PY__Py_TrueStruct())
647 #define PY_Py_None() (&PY__Py_NoneStruct())
648 
649 #define PY_Py_RETURN_NONE return PY_Py_INCREF(PY_Py_None()), PY_Py_None()
650 #define PY_PyMODINIT_FUNC extern "C" SYS_VISIBILITY_EXPORT void
651 
652 #define PY_PyRun_SimpleString(s) PY_PyRun_SimpleStringFlags(s, NULL)
653 #define PY_Py_CompileString(str, p, s) PY_Py_CompileStringFlags(str, p, s, NULL)
654 #define PY_PyRun_InteractiveLoop(f, p) PY_PyRun_InteractiveLoopFlags(f, p, NULL)
655 
656 #define PY_PyList_SET_ITEM(op, i, v) \
657  (((PY_PyListObject *)(op))->ob_item()[i] = (v))
658 #define PY_PyTuple_SET_ITEM(op, i, v) \
659  (((PY_PyTupleObject *)(op))->ob_item()[i] = (v))
660 
661 #define PY_PyList_GET_ITEM(op, i, v) \
662  (((PY_PyListObject *)(op))->ob_item()[i])
663 #define PY_PyTuple_GET_ITEM(op, i) \
664  (((PY_PyTupleObject *)(op))->ob_item()[i])
665 
666 // TODO: These checking defines may need to change for Python 3.0.
667 #define PY_PyObject_TypeCheck(ob, tp) \
668  ((ob)->ob_type() == (tp) || PY_PyType_IsSubtype((ob)->ob_type(), (tp)))
669 #define PY_PyCObject_Check(op) (op->ob_type() == &PY_PyCObject_Type())
670 #define PY_PyFloat_Check(op) PY_PyObject_TypeCheck(op, &PY_PyFloat_Type())
671 #define PY_PyLong_Check(op) PY_PyObject_TypeCheck(op, &PY_PyLong_Type())
672 #define PY_PyBool_Check(op) PY_PyObject_TypeCheck(op, &PY_PyBool_Type())
673 #define PY_PyUnicode_Check(op) PY_PyObject_TypeCheck(op, &PY_PyUnicode_Type())
674 #define PY_PyTuple_Check(op) PY_PyObject_TypeCheck(op, &PY_PyTuple_Type())
675 #define PY_PyList_Check(op) PY_PyObject_TypeCheck(op, &PY_PyList_Type())
676 #define PY_PyDict_Check(op) PY_PyObject_TypeCheck(op, &PY_PyDict_Type())
677 #define PY_PyFunction_Check(op) ((op)->ob_type() == &PY_PyFunction_Type())
678 #if defined(USE_PYTHON3)
679  #define PY_PyBytes_Check(op) ((op)->ob_type() == &PY_PyBytes_Type())
680 #endif
681 
682 // TODO: Before Python 3.0, this macro also checks returns true if
683 // PyInstance_Check returns true. Starting with 3.0, it no longer
684 // does the PyInstance_Check.
685 // To do the proper thing, We need to make this a manually-implemented function.
686 #define PY_PyExceptionInstance_Check(op) \
687  PY_PyObject_TypeCheck(op, (PY_PyTypeObject *)&PY_PyExc_BaseException())
688 
689 // Unfortunately, there's no uniform way to directly access struct members
690 // for both compile-time and non-compile-time dependencies on Python. The
691 // compile-time acccess doesn't use a method call, but the non-compile-time
692 // one does. So, we instead use macros.
693 #define PY_PYFRAME_BACK(op) ((op)->f_back())
694 #define PY_PYFRAME_CODE(op) ((op)->f_code())
695 
696 // This function loads the appropriate Python library and looks up symbols
697 // in it. It should only be called from PY_InterpreterAutoLock, when it
698 // initializes Python.
700 
701 // This function returns the Python major and minor version (e.g. a return
702 // value of 25 means version 2.5). It is up to you to ensure that you call
703 // this function after the Python library has been loaded (creating a
704 // PY_InterpreterAutoLock will load the Python library and initialize the
705 // interpreter).
707 
708 // This function returns the path to HFS's Python's site-packages directory.
709 PY_API void PYgetHFSPythonSitePackagesPath(UT_WorkBuffer &site_packages_path);
710 
711 // Return true if the Python library in $HFS is loaded.
713 
714 #if defined(USE_PYTHON3)
715 // Convert argv to an array of wchar_t*. Alloc new memory for the wchar_t*
716 // array. It is the responsibility of the caller to free the returned array by
717 // calling PY_FreeWCharArgs().
718 PY_API wchar_t **PY_AllocAndInitWCharArgs(int argc, char *argv[]);
719 
720 // Free the memory for the specified wchar_t* array.
721 PY_API void PY_FreeWCharArgs(int argc, wchar_t **wargv);
722 #endif
723 
724 #endif
#define PY_FUNC_SEQ_PyMem_RawFree
const char * ml_doc
#define PY_FUNC_SEQ_PyString_AsString
#define PY_WRAPPED_FUNCTIONS
#define PY_FUNC_SEQ_PyString_FromStringAndSize
int int32
Definition: SYS_Types.h:39
GLuint const GLchar * name
Definition: glew.h:1814
const char * ml_name
int PY_PyGILState_STATE
PY_PyObject *(* PY_PyCFunction)(PY_PyObject *, PY_PyObject *)
*get result *(waiting if necessary)*A common idiom is to fire a bunch of sub tasks at the and then *wait for them to all complete We provide a helper class
Definition: thread.h:643
PY_API int PY_PyGILState_Check()
PY_API int PY_PyArg_ParseTuple(PY_PyObject *args, const char *format,...)
const Args & args
Definition: printf.h:628
#define PY_FUNC_SEQ_Py_DecodeLocale
PY_API PY_PyObject * PY_Py_BuildValue(const char *format,...)
PY_API bool PYisHFSPythonLibraryLoaded()
#define PY_FOR_EACH_SEQ_OF_3(macro, seq)
GLint GLint GLsizei GLsizei GLsizei GLint GLenum format
Definition: glew.h:1254
PY_API int PYgetPythonVersion()
#define PY_FUNC_SEQ_PyCObject_AsVoidPtr
#define PY_FUNC_SEQ_PyCObject_GetDesc
class PY_API PY_PyCodeObject
#define PY_WRAPPED_MEMORY_FUNCTIONS
PY_API void PYgetHFSPythonSitePackagesPath(UT_WorkBuffer &site_packages_path)
#define PY_WRAPPED_CONSTANTS
#define PY_WRAPPED_UNCHECKED_FUNCTIONS
#define PY_FUNC_SEQ_PyBytes_AsStringAndSize
#define PY_FUNC_SEQ_PyInt_AsLong
PY_PyObject
PY_API void PYloadPythonLibrary()
void
Definition: png.h:1083
class PY_API PY_PyThreadState
class PY_API PY_PyTypeObject
#define PY_API
Definition: PY_API.h:10
#define PY_FUNC_SEQ_PyInt_FromLong
long long int64
Definition: SYS_Types.h:116
ob_size PY_PyVarObject
#define PY_ADD_SUBCLASS_1(subclass, base_class, member1_type, member1_name)
void(*)( PY_AtExitFunc)
Definition: PY_CPythonAPI.h:67
class PY_API PY_PyCompilerFlags
#define PY_ADD_SUBCLASS_2(subclass, base_class, member1_type, member1_name, member2_type, member2_name)
#define PY_DECLARE_FUNCTION_FROM_SEQ(seq)
#define PY_DECLARE_WRAPPED_CONSTANT(constant_name, type)
#define PY_FOR_EACH_SEQ_OF_2(macro, seq)
#define PY_FUNC_SEQ_PyString_AsStringAndSize
PY_Py_ssize_t PY_Py_hash_t
PY_API PY_PyObject * PY_PyObject_CallMethod(PY_PyObject *o, const char *name, const char *format,...)
#define PY_FUNC_SEQ_PyMem_RawMalloc
#define PY_FUNC_SEQ_PyModule_GetState
PY_API PY_PyObject * PY_Py_InitModule(const char *name, PY_PyMethodDef *methods)
#define PY_DECLARE_FUNCTION(function_name, return_type, parm_types)
#define PY_FUNC_SEQ_PyString_FromString
#define const
Definition: zconf.h:214
ssize_t PY_Py_ssize_t
ob_size PY_PyFrameObject f_back
#define PY_FUNC_SEQ_PyString_AsUTF8String
PY_PyCFunction ml_meth
GLintptr offset
Definition: glew.h:1682