imbuf: revert some of the changes of rBb6ba3c682dd6615e760905572a5bcd69bb46371f since...
[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 #ifndef __PY_CAPI_UTILS_H__
28 #define __PY_CAPI_UTILS_H__
29
30 #include "BLI_sys_types.h"
31 #include "BLI_utildefines_variadic.h"
32
33 void                    PyC_ObSpit(const char *name, PyObject *var);
34 void                    PyC_LineSpit(void);
35 void                    PyC_StackSpit(void);
36 PyObject *              PyC_ExceptionBuffer(void);
37 PyObject *              PyC_ExceptionBuffer_Simple(void);
38 PyObject *              PyC_Object_GetAttrStringArgs(PyObject *o, Py_ssize_t n, ...);
39 PyObject *              PyC_FrozenSetFromStrings(const char **strings);
40 PyObject *              PyC_Err_Format_Prefix(PyObject *exception_type_prefix, const char *format, ...);
41 void                    PyC_Err_PrintWithFunc(PyObject *py_func);
42
43 void                    PyC_FileAndNum(const char **filename, int *lineno);
44 void                    PyC_FileAndNum_Safe(const char **filename, int *lineno); /* checks python is running */
45 int             PyC_AsArray_FAST(
46         void *array, PyObject *value_fast, const Py_ssize_t length,
47         const PyTypeObject *type, const bool is_double, const char *error_prefix);
48 int             PyC_AsArray(
49         void *array, PyObject *value, const Py_ssize_t length,
50         const PyTypeObject *type, const bool is_double, const char *error_prefix);
51
52 PyObject       *PyC_Tuple_PackArray_F32(const float *array, uint len);
53 PyObject       *PyC_Tuple_PackArray_I32(const int *array, uint len);
54 PyObject       *PyC_Tuple_PackArray_I32FromBool(const int *array, uint len);
55 PyObject       *PyC_Tuple_PackArray_Bool(const bool *array, uint len);
56
57 #define PyC_Tuple_Pack_F32(...) \
58         PyC_Tuple_PackArray_F32(((const float []){__VA_ARGS__}), VA_NARGS_COUNT(__VA_ARGS__))
59 #define PyC_Tuple_Pack_I32(...) \
60         PyC_Tuple_PackArray_I32(((const int []){__VA_ARGS__}), VA_NARGS_COUNT(__VA_ARGS__))
61 #define PyC_Tuple_Pack_I32FromBool(...) \
62         PyC_Tuple_PackArray_I32FromBool(((const int []){__VA_ARGS__}), VA_NARGS_COUNT(__VA_ARGS__))
63 #define PyC_Tuple_Pack_Bool(...) \
64         PyC_Tuple_PackArray_Bool(((const bool []){__VA_ARGS__}), VA_NARGS_COUNT(__VA_ARGS__))
65
66 void            PyC_Tuple_Fill(PyObject *tuple, PyObject *value);
67 void            PyC_List_Fill(PyObject *list, PyObject *value);
68
69 /* follow http://www.python.org/dev/peps/pep-0383/ */
70 PyObject *      PyC_UnicodeFromByte(const char *str);
71 PyObject *      PyC_UnicodeFromByteAndSize(const char *str, Py_ssize_t size);
72 const char *    PyC_UnicodeAsByte(PyObject *py_str, PyObject **coerce); /* coerce must be NULL */
73 const char *    PyC_UnicodeAsByteAndSize(PyObject *py_str, Py_ssize_t *size, PyObject **coerce);
74
75 /* name namespace function for bpy & bge */
76 PyObject *              PyC_DefaultNameSpace(const char *filename);
77 void                    PyC_RunQuicky(const char *filepath, int n, ...);
78
79 void PyC_MainModule_Backup(PyObject **main_mod);
80 void PyC_MainModule_Restore(PyObject *main_mod);
81
82 void PyC_SetHomePath(const char *py_path_bundle);
83
84 bool PyC_IsInterpreterActive(void);
85
86 void *PyC_RNA_AsPointer(PyObject *value, const char *type_name);
87
88 /* flag / set --- interchange */
89 typedef struct PyC_FlagSet {
90         int value;
91         const char *identifier;
92 } PyC_FlagSet;
93
94 char     *PyC_FlagSet_AsString(PyC_FlagSet *item);
95 int       PyC_FlagSet_ValueFromID_int(PyC_FlagSet *item, const char *identifier, int *r_value);
96 int       PyC_FlagSet_ValueFromID(PyC_FlagSet *item, const char *identifier, int *r_value, const char *error_prefix);
97 int       PyC_FlagSet_ToBitfield(PyC_FlagSet *items, PyObject *value, int *r_value, const char *error_prefix);
98 PyObject *PyC_FlagSet_FromBitfield(PyC_FlagSet *items, int flag);
99
100 bool PyC_RunString_AsNumber(const char *expr, const char *filename, double *r_value);
101 bool PyC_RunString_AsString(const char *expr, const char *filename, char **r_value);
102
103 int PyC_ParseBool(PyObject *o, void *p);
104
105
106 /* Integer parsing (with overflow checks), -1 on error. */
107 int     PyC_Long_AsBool(PyObject *value);
108 int8_t  PyC_Long_AsI8(PyObject *value);
109 int16_t PyC_Long_AsI16(PyObject *value);
110 #if 0 /* inline */
111 int32_t PyC_Long_AsI32(PyObject *value);
112 int64_t PyC_Long_AsI64(PyObject *value);
113 #endif
114
115 uint8_t  PyC_Long_AsU8(PyObject *value);
116 uint16_t PyC_Long_AsU16(PyObject *value);
117 uint32_t PyC_Long_AsU32(PyObject *value);
118 #if 0 /* inline */
119 uint64_t PyC_Long_AsU64(PyObject *value);
120 #endif
121
122 /* inline so type signatures match as expected */
123 Py_LOCAL_INLINE(int32_t)  PyC_Long_AsI32(PyObject *value) { return (int32_t)_PyLong_AsInt(value); }
124 Py_LOCAL_INLINE(int64_t)  PyC_Long_AsI64(PyObject *value) { return (int64_t)PyLong_AsLongLong(value); }
125 Py_LOCAL_INLINE(uint64_t) PyC_Long_AsU64(PyObject *value) { return (uint64_t)PyLong_AsUnsignedLongLong(value); }
126
127 #endif  /* __PY_CAPI_UTILS_H__ */