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