PyAPI: add PyC_Err_SetString_Prefix for internal use
[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_ObSpitStr(char *result, size_t result_len, PyObject *var);
35 void      PyC_LineSpit(void);
36 void      PyC_StackSpit(void);
37 PyObject *PyC_ExceptionBuffer(void);
38 PyObject *PyC_ExceptionBuffer_Simple(void);
39 PyObject *PyC_Object_GetAttrStringArgs(PyObject *o, Py_ssize_t n, ...);
40 PyObject *PyC_FrozenSetFromStrings(const char **strings);
41
42 PyObject *PyC_Err_Format_Prefix(PyObject *exception_type_prefix, const char *format, ...);
43 PyObject *PyC_Err_SetString_Prefix(PyObject *exception_type_prefix, const char *str);
44
45 void      PyC_Err_PrintWithFunc(PyObject *py_func);
46
47 void    PyC_FileAndNum(const char **filename, int *lineno);
48 void    PyC_FileAndNum_Safe(const char **filename, int *lineno); /* checks python is running */
49 int             PyC_AsArray_FAST(
50         void *array, PyObject *value_fast, const Py_ssize_t length,
51         const PyTypeObject *type, const bool is_double, const char *error_prefix);
52 int             PyC_AsArray(
53         void *array, PyObject *value, const Py_ssize_t length,
54         const PyTypeObject *type, const bool is_double, const char *error_prefix);
55
56 PyObject       *PyC_Tuple_PackArray_F32(const float *array, uint len);
57 PyObject       *PyC_Tuple_PackArray_F64(const double *array, uint len);
58 PyObject       *PyC_Tuple_PackArray_I32(const int *array, uint len);
59 PyObject       *PyC_Tuple_PackArray_I32FromBool(const int *array, uint len);
60 PyObject       *PyC_Tuple_PackArray_Bool(const bool *array, uint len);
61
62 #define PyC_Tuple_Pack_F32(...) \
63         PyC_Tuple_PackArray_F32(((const float []){__VA_ARGS__}), VA_NARGS_COUNT(__VA_ARGS__))
64 #define PyC_Tuple_Pack_F64(...) \
65         PyC_Tuple_PackArray_F64(((const double []){__VA_ARGS__}), VA_NARGS_COUNT(__VA_ARGS__))
66 #define PyC_Tuple_Pack_I32(...) \
67         PyC_Tuple_PackArray_I32(((const int []){__VA_ARGS__}), VA_NARGS_COUNT(__VA_ARGS__))
68 #define PyC_Tuple_Pack_I32FromBool(...) \
69         PyC_Tuple_PackArray_I32FromBool(((const int []){__VA_ARGS__}), VA_NARGS_COUNT(__VA_ARGS__))
70 #define PyC_Tuple_Pack_Bool(...) \
71         PyC_Tuple_PackArray_Bool(((const bool []){__VA_ARGS__}), VA_NARGS_COUNT(__VA_ARGS__))
72
73 void            PyC_Tuple_Fill(PyObject *tuple, PyObject *value);
74 void            PyC_List_Fill(PyObject *list, PyObject *value);
75
76 /* follow http://www.python.org/dev/peps/pep-0383/ */
77 PyObject   *PyC_UnicodeFromByte(const char *str);
78 PyObject   *PyC_UnicodeFromByteAndSize(const char *str, Py_ssize_t size);
79 const char *PyC_UnicodeAsByte(PyObject *py_str, PyObject **coerce); /* coerce must be NULL */
80 const char *PyC_UnicodeAsByteAndSize(PyObject *py_str, Py_ssize_t *size, PyObject **coerce);
81
82 /* name namespace function for bpy */
83 PyObject *PyC_DefaultNameSpace(const char *filename);
84 void PyC_RunQuicky(const char *filepath, int n, ...);
85 bool PyC_NameSpace_ImportArray(PyObject *py_dict, const char *imports[]);
86
87 void PyC_MainModule_Backup(PyObject **main_mod);
88 void PyC_MainModule_Restore(PyObject *main_mod);
89
90 void PyC_SetHomePath(const char *py_path_bundle);
91
92 bool PyC_IsInterpreterActive(void);
93
94 void *PyC_RNA_AsPointer(PyObject *value, const char *type_name);
95
96 /* flag / set --- interchange */
97 typedef struct PyC_FlagSet {
98         int value;
99         const char *identifier;
100 } PyC_FlagSet;
101
102 char     *PyC_FlagSet_AsString(PyC_FlagSet *item);
103 int       PyC_FlagSet_ValueFromID_int(PyC_FlagSet *item, const char *identifier, int *r_value);
104 int       PyC_FlagSet_ValueFromID(PyC_FlagSet *item, const char *identifier, int *r_value, const char *error_prefix);
105 int       PyC_FlagSet_ToBitfield(PyC_FlagSet *items, PyObject *value, int *r_value, const char *error_prefix);
106 PyObject *PyC_FlagSet_FromBitfield(PyC_FlagSet *items, int flag);
107
108 bool PyC_RunString_AsNumber(const char **imports, const char *expr, const char *filename, double *r_value);
109 bool PyC_RunString_AsIntPtr(const char **imports, const char *expr, const char *filename, intptr_t *r_value);
110 bool PyC_RunString_AsString(const char **imports, const char *expr, const char *filename, char **r_value);
111
112 int PyC_ParseBool(PyObject *o, void *p);
113
114 int PyC_CheckArgs_DeepCopy(PyObject *args);
115
116 /* Integer parsing (with overflow checks), -1 on error. */
117 int     PyC_Long_AsBool(PyObject *value);
118 int8_t  PyC_Long_AsI8(PyObject *value);
119 int16_t PyC_Long_AsI16(PyObject *value);
120 #if 0 /* inline */
121 int32_t PyC_Long_AsI32(PyObject *value);
122 int64_t PyC_Long_AsI64(PyObject *value);
123 #endif
124
125 uint8_t  PyC_Long_AsU8(PyObject *value);
126 uint16_t PyC_Long_AsU16(PyObject *value);
127 uint32_t PyC_Long_AsU32(PyObject *value);
128 #if 0 /* inline */
129 uint64_t PyC_Long_AsU64(PyObject *value);
130 #endif
131
132 /* inline so type signatures match as expected */
133 Py_LOCAL_INLINE(int32_t)  PyC_Long_AsI32(PyObject *value) { return (int32_t)_PyLong_AsInt(value); }
134 Py_LOCAL_INLINE(int64_t)  PyC_Long_AsI64(PyObject *value) { return (int64_t)PyLong_AsLongLong(value); }
135 Py_LOCAL_INLINE(uint64_t) PyC_Long_AsU64(PyObject *value) { return (uint64_t)PyLong_AsUnsignedLongLong(value); }
136
137 /* utils for format string in `struct` module style syntax */
138 char PyC_StructFmt_type_from_str(const char *typestr);
139 bool PyC_StructFmt_type_is_float_any(char format);
140 bool PyC_StructFmt_type_is_int_any(char format);
141 bool PyC_StructFmt_type_is_byte(char format);
142 bool PyC_StructFmt_type_is_bool(char format);
143
144 #endif  /* __PY_CAPI_UTILS_H__ */