8854671977796ed801a3542bf34a04cc91765426
[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 void                    PyC_ObSpit(const char *name, PyObject *var);
31 void                    PyC_LineSpit(void);
32 void                    PyC_StackSpit(void);
33 PyObject *              PyC_ExceptionBuffer(void);
34 PyObject *              PyC_ExceptionBuffer_Simple(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_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 PyObject *      PyC_FromArray(const void *array, int length, const PyTypeObject *type,
47                               const bool is_double, const char *error_prefix);
48 void            PyC_Tuple_Fill(PyObject *tuple, PyObject *value);
49 void            PyC_List_Fill(PyObject *list, PyObject *value);
50
51 /* follow http://www.python.org/dev/peps/pep-0383/ */
52 PyObject *      PyC_UnicodeFromByte(const char *str);
53 PyObject *      PyC_UnicodeFromByteAndSize(const char *str, Py_ssize_t size);
54 const char *    PyC_UnicodeAsByte(PyObject *py_str, PyObject **coerce); /* coerce must be NULL */
55 const char *    PyC_UnicodeAsByteAndSize(PyObject *py_str, Py_ssize_t *size, PyObject **coerce);
56
57 /* name namespace function for bpy & bge */
58 PyObject *              PyC_DefaultNameSpace(const char *filename);
59 void                    PyC_RunQuicky(const char *filepath, int n, ...);
60
61 void PyC_MainModule_Backup(PyObject **main_mod);
62 void PyC_MainModule_Restore(PyObject *main_mod);
63
64 void PyC_SetHomePath(const char *py_path_bundle);
65
66 bool PyC_IsInterpreterActive(void);
67
68 void *PyC_RNA_AsPointer(PyObject *value, const char *type_name);
69
70 /* flag / set --- interchange */
71 typedef struct PyC_FlagSet {
72         int value;
73         const char *identifier;
74 } PyC_FlagSet;
75
76 char     *PyC_FlagSet_AsString(PyC_FlagSet *item);
77 int       PyC_FlagSet_ValueFromID_int(PyC_FlagSet *item, const char *identifier, int *r_value);
78 int       PyC_FlagSet_ValueFromID(PyC_FlagSet *item, const char *identifier, int *r_value, const char *error_prefix);
79 int       PyC_FlagSet_ToBitfield(PyC_FlagSet *items, PyObject *value, int *r_value, const char *error_prefix);
80 PyObject *PyC_FlagSet_FromBitfield(PyC_FlagSet *items, int flag);
81
82 bool PyC_RunString_AsNumber(const char *expr, const char *filename, double *r_value);
83 bool PyC_RunString_AsString(const char *expr, const char *filename, char **r_value);
84
85 int PyC_ParseBool(PyObject *o, void *p);
86
87
88 /* Integer parsing (with overflow checks), -1 on error. */
89 int     PyC_Long_AsBool(PyObject *value);
90 int8_t  PyC_Long_AsI8(PyObject *value);
91 int16_t PyC_Long_AsI16(PyObject *value);
92 #if 0 /* inline */
93 int32_t PyC_Long_AsI32(PyObject *value);
94 int64_t PyC_Long_AsI64(PyObject *value);
95 #endif
96
97 uint8_t  PyC_Long_AsU8(PyObject *value);
98 uint16_t PyC_Long_AsU16(PyObject *value);
99 uint32_t PyC_Long_AsU32(PyObject *value);
100 #if 0 /* inline */
101 uint64_t PyC_Long_AsU64(PyObject *value);
102 #endif
103
104 /* inline so type signatures match as expected */
105 Py_LOCAL_INLINE(int32_t)  PyC_Long_AsI32(PyObject *value) { return (int32_t)_PyLong_AsInt(value); }
106 Py_LOCAL_INLINE(int64_t)  PyC_Long_AsI64(PyObject *value) { return (int64_t)PyLong_AsLongLong(value); }
107 Py_LOCAL_INLINE(uint64_t) PyC_Long_AsU64(PyObject *value) { return (uint64_t)PyLong_AsUnsignedLongLong(value); }
108
109 #endif  /* __PY_CAPI_UTILS_H__ */