Big i18n commit: add "reports" from bmesh/readfile/tracking/dynapaint (and a few...
[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 "bpy_util.h"
33 #include "BLI_dynstr.h"
34 #include "MEM_guardedalloc.h"
35 #include "BKE_report.h"
36 #include "BKE_context.h"
37
38 #include "BLF_translation.h"
39
40 #include "../generic/py_capi_utils.h"
41
42 static bContext *__py_context = NULL;
43 bContext   *BPy_GetContext(void) { return __py_context; }
44 void        BPy_SetContext(bContext *C) { __py_context = C; }
45
46 char *BPy_enum_as_string(EnumPropertyItem *item)
47 {
48         DynStr *dynstr = BLI_dynstr_new();
49         EnumPropertyItem *e;
50         char *cstring;
51
52         for (e = item; item->identifier; item++) {
53                 if (item->identifier[0])
54                         BLI_dynstr_appendf(dynstr, (e == item) ? "'%s'" : ", '%s'", item->identifier);
55         }
56
57         cstring = BLI_dynstr_get_cstring(dynstr);
58         BLI_dynstr_free(dynstr);
59         return cstring;
60 }
61
62 short BPy_reports_to_error(ReportList *reports, PyObject *exception, const short clear)
63 {
64         char *report_str;
65
66         report_str = BKE_reports_string(reports, RPT_ERROR);
67
68         if (clear) {
69                 BKE_reports_clear(reports);
70         }
71
72         if (report_str) {
73                 PyErr_SetString(exception, report_str);
74                 MEM_freeN(report_str);
75         }
76
77         return (report_str == NULL) ? 0 : -1;
78 }
79
80
81 short BPy_errors_to_report(ReportList *reports)
82 {
83         PyObject *pystring;
84         PyObject *pystring_format = NULL;  /* workaround, see below */
85         char *cstring;
86
87         const char *filename;
88         int lineno;
89
90         if (!PyErr_Occurred())
91                 return 1;
92         
93         /* less hassle if we allow NULL */
94         if (reports == NULL) {
95                 PyErr_Print();
96                 PyErr_Clear();
97                 return 1;
98         }
99         
100         pystring = PyC_ExceptionBuffer();
101         
102         if (pystring == NULL) {
103                 BKE_report(reports, RPT_ERROR, "Unknown py-exception, could not convert");
104                 return 0;
105         }
106         
107         PyC_FileAndNum(&filename, &lineno);
108         if (filename == NULL)
109                 filename = "<unknown location>";
110         
111         cstring = _PyUnicode_AsString(pystring);
112
113 #if 0 /* ARG!. workaround for a bug in blenders use of vsnprintf */
114         BKE_reportf(reports, RPT_ERROR, "%s\nlocation: %s:%d\n", cstring, filename, lineno);
115 #else
116         pystring_format = PyUnicode_FromFormat(TIP_("%s\nlocation: %s:%d\n"), cstring, filename, lineno);
117         cstring = _PyUnicode_AsString(pystring_format);
118         BKE_report(reports, RPT_ERROR, cstring);
119 #endif
120
121         /* not exactly needed. just for testing */
122         fprintf(stderr, TIP_("%s\nlocation: %s:%d\n"), cstring, filename, lineno);
123
124         Py_DECREF(pystring);
125         Py_DECREF(pystring_format);  /* workaround */
126         return 1;
127 }