PyAPI: add utilities PyTuple_SET_ITEMS, Py_INCREF_RET
[blender.git] / source / blender / python / generic / py_capi_utils.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Campbell Barton
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/python/generic/py_capi_utils.h
24  *  \ingroup pygen
25  */
26
27
28 #ifndef __PY_CAPI_UTILS_H__
29 #define __PY_CAPI_UTILS_H__
30
31 void                    PyC_ObSpit(const char *name, PyObject *var);
32 void                    PyC_LineSpit(void);
33 void                    PyC_StackSpit(void);
34 PyObject *              PyC_ExceptionBuffer(void);
35 PyObject *              PyC_Object_GetAttrStringArgs(PyObject *o, Py_ssize_t n, ...);
36 PyObject *              PyC_FrozenSetFromStrings(const char **strings);
37 PyObject *              PyC_Err_Format_Prefix(PyObject *exception_type_prefix, const char *format, ...);
38 void                    PyC_FileAndNum(const char **filename, int *lineno);
39 void                    PyC_FileAndNum_Safe(const char **filename, int *lineno); /* checks python is running */
40 int                             PyC_AsArray(void *array, PyObject *value, const Py_ssize_t length,
41                             const PyTypeObject *type, const bool is_double, const char *error_prefix);
42 PyObject *      PyC_FromArray(const void *array, int length, const PyTypeObject *type,
43                               const bool is_double, const char *error_prefix);
44 void            PyC_Tuple_Fill(PyObject *tuple, PyObject *value);
45 void            PyC_List_Fill(PyObject *list, PyObject *value);
46
47 /* follow http://www.python.org/dev/peps/pep-0383/ */
48 PyObject *      PyC_UnicodeFromByte(const char *str);
49 PyObject *      PyC_UnicodeFromByteAndSize(const char *str, Py_ssize_t size);
50 const char *    PyC_UnicodeAsByte(PyObject *py_str, PyObject **coerce); /* coerce must be NULL */
51
52 /* name namespace function for bpy & bge */
53 PyObject *              PyC_DefaultNameSpace(const char *filename);
54 void                    PyC_RunQuicky(const char *filepath, int n, ...);
55
56 void PyC_MainModule_Backup(PyObject **main_mod);
57 void PyC_MainModule_Restore(PyObject *main_mod);
58
59 void PyC_SetHomePath(const char *py_path_bundle);
60
61 bool PyC_IsInterpreterActive(void);
62
63 void *PyC_RNA_AsPointer(PyObject *value, const char *type_name);
64
65 /* flag / set --- interchange */
66 typedef struct PyC_FlagSet {
67         int value;
68         const char *identifier;
69 } PyC_FlagSet;
70
71 char     *PyC_FlagSet_AsString(PyC_FlagSet *item);
72 int       PyC_FlagSet_ValueFromID_int(PyC_FlagSet *item, const char *identifier, int *value);
73 int       PyC_FlagSet_ValueFromID(PyC_FlagSet *item, const char *identifier, int *value, const char *error_prefix);
74 int       PyC_FlagSet_ToBitfield(PyC_FlagSet *items, PyObject *value, int *r_value, const char *error_prefix);
75 PyObject *PyC_FlagSet_FromBitfield(PyC_FlagSet *items, int flag);
76
77 int PyC_RunString_AsNumber(const char *expr, double *value, const char *filename);
78
79 #endif  /* __PY_CAPI_UTILS_H__ */