doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / blender / python / intern / bpy_util.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributor(s): Campbell Barton
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #ifndef BPY_UTIL_H
26 #define BPY_UTIL_H
27
28 #if PY_VERSION_HEX <  0x03010000
29 #error "Python versions below 3.1 are not supported anymore, you'll need to update your python."
30 #endif
31
32 #include "RNA_types.h" /* for EnumPropertyItem only */
33
34 struct EnumPropertyItem;
35 struct ReportList;
36
37 char *BPy_enum_as_string(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, const short clear);
43 short BPy_errors_to_report(struct ReportList *reports);
44
45 /* TODO - find a better solution! */
46 struct bContext *BPy_GetContext(void);
47 void BPy_SetContext(struct bContext *C);
48
49 extern void bpy_context_set(struct bContext *C, PyGILState_STATE *gilstate);
50 extern void bpy_context_clear(struct bContext *C, PyGILState_STATE *gilstate);
51 #endif