Remove "_base*" from context API
[blender.git] / source / blender / python / generic / py_capi_utils.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file
18  * \ingroup pygen
19  */
20
21 #ifndef __PY_CAPI_UTILS_H__
22 #define __PY_CAPI_UTILS_H__
23
24 #include "BLI_sys_types.h"
25 #include "BLI_utildefines_variadic.h"
26
27 void PyC_ObSpit(const char *name, PyObject *var);
28 void PyC_ObSpitStr(char *result, size_t result_len, PyObject *var);
29 void PyC_LineSpit(void);
30 void PyC_StackSpit(void);
31 PyObject *PyC_ExceptionBuffer(void);
32 PyObject *PyC_ExceptionBuffer_Simple(void);
33 PyObject *PyC_Object_GetAttrStringArgs(PyObject *o, Py_ssize_t n, ...);
34 PyObject *PyC_FrozenSetFromStrings(const char **strings);
35
36 PyObject *PyC_Err_Format_Prefix(PyObject *exception_type_prefix, const char *format, ...);
37 PyObject *PyC_Err_SetString_Prefix(PyObject *exception_type_prefix, const char *str);
38
39 void PyC_Err_PrintWithFunc(PyObject *py_func);
40
41 void PyC_FileAndNum(const char **filename, int *lineno);
42 void PyC_FileAndNum_Safe(const char **filename, int *lineno); /* checks python is running */
43 int PyC_AsArray_FAST(void *array,
44                      PyObject *value_fast,
45                      const Py_ssize_t length,
46                      const PyTypeObject *type,
47                      const bool is_double,
48                      const char *error_prefix);
49 int PyC_AsArray(void *array,
50                 PyObject *value,
51                 const Py_ssize_t length,
52                 const PyTypeObject *type,
53                 const bool is_double,
54                 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,
105                             const char *identifier,
106                             int *r_value,
107                             const char *error_prefix);
108 int PyC_FlagSet_ToBitfield(PyC_FlagSet *items,
109                            PyObject *value,
110                            int *r_value,
111                            const char *error_prefix);
112 PyObject *PyC_FlagSet_FromBitfield(PyC_FlagSet *items, int flag);
113
114 bool PyC_RunString_AsNumber(const char **imports,
115                             const char *expr,
116                             const char *filename,
117                             double *r_value);
118 bool PyC_RunString_AsIntPtr(const char **imports,
119                             const char *expr,
120                             const char *filename,
121                             intptr_t *r_value);
122 bool PyC_RunString_AsString(const char **imports,
123                             const char *expr,
124                             const char *filename,
125                             char **r_value);
126
127 int PyC_ParseBool(PyObject *o, void *p);
128
129 int PyC_CheckArgs_DeepCopy(PyObject *args);
130
131 /* Integer parsing (with overflow checks), -1 on error. */
132 int PyC_Long_AsBool(PyObject *value);
133 int8_t PyC_Long_AsI8(PyObject *value);
134 int16_t PyC_Long_AsI16(PyObject *value);
135 #if 0 /* inline */
136 int32_t PyC_Long_AsI32(PyObject *value);
137 int64_t PyC_Long_AsI64(PyObject *value);
138 #endif
139
140 uint8_t PyC_Long_AsU8(PyObject *value);
141 uint16_t PyC_Long_AsU16(PyObject *value);
142 uint32_t PyC_Long_AsU32(PyObject *value);
143 #if 0 /* inline */
144 uint64_t PyC_Long_AsU64(PyObject *value);
145 #endif
146
147 /* inline so type signatures match as expected */
148 Py_LOCAL_INLINE(int32_t) PyC_Long_AsI32(PyObject *value)
149 {
150   return (int32_t)_PyLong_AsInt(value);
151 }
152 Py_LOCAL_INLINE(int64_t) PyC_Long_AsI64(PyObject *value)
153 {
154   return (int64_t)PyLong_AsLongLong(value);
155 }
156 Py_LOCAL_INLINE(uint64_t) PyC_Long_AsU64(PyObject *value)
157 {
158   return (uint64_t)PyLong_AsUnsignedLongLong(value);
159 }
160
161 /* utils for format string in `struct` module style syntax */
162 char PyC_StructFmt_type_from_str(const char *typestr);
163 bool PyC_StructFmt_type_is_float_any(char format);
164 bool PyC_StructFmt_type_is_int_any(char format);
165 bool PyC_StructFmt_type_is_byte(char format);
166 bool PyC_StructFmt_type_is_bool(char format);
167
168 #endif /* __PY_CAPI_UTILS_H__ */