Merge branch 'master' into blender2.8
[blender.git] / source / blender / python / intern / bpy_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/intern/bpy_capi_utils.h
24  *  \ingroup pythonintern
25  */
26
27 #ifndef __BPY_UTIL_H__
28 #define __BPY_UTIL_H__
29
30 #if PY_VERSION_HEX <  0x03060000
31 #  error "Python 3.6 or greater is required, you'll need to update your python."
32 #endif
33
34 struct EnumPropertyItem;
35 struct ReportList;
36
37 char *BPy_enum_as_string(const struct EnumPropertyItem *item);
38
39 #define BLANK_PYTHON_TYPE {PyVarObject_HEAD_INIT(NULL, 0) NULL}
40
41 /* error reporting */
42 short BPy_reports_to_error(struct ReportList *reports, PyObject *exception, const bool clear);
43 bool BPy_errors_to_report_ex(struct ReportList *reports, const bool use_full, const bool use_location);
44 bool BPy_errors_to_report(struct ReportList *reports);
45
46 /* TODO - find a better solution! */
47 struct bContext *BPy_GetContext(void);
48 void BPy_SetContext(struct bContext *C);
49
50 extern void bpy_context_set(struct bContext *C, PyGILState_STATE *gilstate);
51 extern void bpy_context_clear(struct bContext *C, PyGILState_STATE *gilstate);
52
53 #endif  /* __BPY_UTIL_H__ */