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