Merge with 2.5 -r 21003:21788.
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * Contributor(s): Campbell Barton
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <Python.h>
26
27 #ifndef BPY_UTIL_H
28 #define BPY_UTIL_H
29
30 #include "bpy_compat.h"
31 #include "RNA_types.h" /* for EnumPropertyItem only */
32
33 struct EnumPropertyItem;
34 struct ReportList;
35
36 /* for internal use only, so python can interchange a sequence of strings with flags */
37 typedef struct BPY_flag_def {
38     const char  *name;
39     int                 flag;
40 } BPY_flag_def;
41
42
43 PyObject *BPY_flag_to_list(BPY_flag_def *flagdef, int flag);
44 int BPY_flag_from_seq(BPY_flag_def *flagdef, PyObject *seq, int *flag);
45
46 void PyObSpit(char *name, PyObject *var);
47 void PyLineSpit(void);
48 void BPY_getFileAndNum(char **filename, int *lineno);
49
50 PyObject *BPY_exception_buffer(void);
51
52 /* own python like utility function */
53 PyObject *PyObject_GetAttrStringArgs(PyObject *o, Py_ssize_t n, ...);
54
55
56
57 /* Class type checking, use for checking classes can be added as operators, panels etc */
58 typedef struct BPY_class_attr_check {
59         const char      *name;          /* name of the class attribute */
60     char                type;           /* 's' = string, 'f' = function, 'l' = list, (add as needed) */
61     int                 arg_count;      /* only for function types, -1 for undefined, includes self arg */
62     int                 len;            /* only for string types currently */
63         int                     flag;           /* other options */
64 } BPY_class_attr_check;
65
66 /* BPY_class_attr_check, flag */
67 #define BPY_CLASS_ATTR_OPTIONAL 1
68 #define BPY_CLASS_ATTR_NONE_OK  2
69
70 int BPY_class_validate(const char *class_type, PyObject *class, PyObject *base_class, BPY_class_attr_check* class_attrs, PyObject **py_class_attrs);
71
72 char *BPy_enum_as_string(struct EnumPropertyItem *item);
73
74
75 #define BLANK_PYTHON_TYPE {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}
76
77 /* error reporting */
78 int BPy_reports_to_error(struct ReportList *reports);
79 int BPy_errors_to_report(struct ReportList *reports);
80
81 /* TODO - find a better solution! */
82 struct bContext *BPy_GetContext(void);
83 void BPy_SetContext(struct bContext *C);
84
85 #endif