Py-Driver: add 'self' option
[blender.git] / source / blender / python / intern / bpy_util.c
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_util.c
24  *  \ingroup pythonintern
25  *
26  * This file contains blender/python utility functions for the api's internal
27  * use (unrelated to 'bpy.utils')
28  */
29
30 #include <Python.h>
31
32 #include "BLI_utildefines.h"
33 #include "BLI_dynstr.h"
34
35 #include "bpy_util.h"
36
37 #include "MEM_guardedalloc.h"
38
39 #include "BKE_report.h"
40 #include "BKE_context.h"
41
42 #include "BLT_translation.h"
43
44 #include "../generic/py_capi_utils.h"
45
46 static bContext *__py_context = NULL;
47 bContext   *BPy_GetContext(void) { return __py_context; }
48 void        BPy_SetContext(bContext *C) { __py_context = C; }
49
50 char *BPy_enum_as_string(EnumPropertyItem *item)
51 {
52         DynStr *dynstr = BLI_dynstr_new();
53         EnumPropertyItem *e;
54         char *cstring;
55
56         for (e = item; item->identifier; item++) {
57                 if (item->identifier[0])
58                         BLI_dynstr_appendf(dynstr, (e == item) ? "'%s'" : ", '%s'", item->identifier);
59         }
60
61         cstring = BLI_dynstr_get_cstring(dynstr);
62         BLI_dynstr_free(dynstr);
63         return cstring;
64 }
65
66 short BPy_reports_to_error(ReportList *reports, PyObject *exception, const bool clear)
67 {
68         char *report_str;
69
70         report_str = BKE_reports_string(reports, RPT_ERROR);
71
72         if (clear == true) {
73                 BKE_reports_clear(reports);
74         }
75
76         if (report_str) {
77                 PyErr_SetString(exception, report_str);
78                 MEM_freeN(report_str);
79         }
80
81         return (report_str == NULL) ? 0 : -1;
82 }
83
84
85 bool BPy_errors_to_report_ex(ReportList *reports, const bool use_full, const bool use_location)
86 {
87         PyObject *pystring;
88
89         if (!PyErr_Occurred())
90                 return 1;
91         
92         /* less hassle if we allow NULL */
93         if (reports == NULL) {
94                 PyErr_Print();
95                 PyErr_Clear();
96                 return 1;
97         }
98         
99         if (use_full) {
100                 pystring = PyC_ExceptionBuffer();
101         }
102         else {
103                 pystring = PyC_ExceptionBuffer_Simple();
104         }
105         
106         if (pystring == NULL) {
107                 BKE_report(reports, RPT_ERROR, "Unknown py-exception, could not convert");
108                 return 0;
109         }
110
111         if (use_location) {
112                 const char *filename;
113                 int lineno;
114
115                 PyObject *pystring_format;  /* workaround, see below */
116                 const char *cstring;
117
118                 PyC_FileAndNum(&filename, &lineno);
119                 if (filename == NULL) {
120                         filename = "<unknown location>";
121                 }
122
123 #if 0 /* ARG!. workaround for a bug in blenders use of vsnprintf */
124                 BKE_reportf(reports, RPT_ERROR, "%s\nlocation: %s:%d\n", _PyUnicode_AsString(pystring), filename, lineno);
125 #else
126                 pystring_format = PyUnicode_FromFormat(
127                         TIP_("%s\nlocation: %s:%d\n"),
128                         _PyUnicode_AsString(pystring), filename, lineno);
129
130                 cstring = _PyUnicode_AsString(pystring_format);
131                 BKE_report(reports, RPT_ERROR, cstring);
132
133                 /* not exactly needed. just for testing */
134                 fprintf(stderr, TIP_("%s\nlocation: %s:%d\n"), cstring, filename, lineno);
135
136                 Py_DECREF(pystring_format);  /* workaround */
137 #endif
138         }
139         else {
140                 BKE_report(reports, RPT_ERROR, _PyUnicode_AsString(pystring));
141         }
142
143
144         Py_DECREF(pystring);
145         return 1;
146 }
147
148 bool BPy_errors_to_report(ReportList *reports)
149 {
150         return BPy_errors_to_report_ex(reports, true, true);
151 }