Merged changes in the trunk up to revision 46787.
[blender.git] / source / blender / blenkernel / intern / report.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  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * Contributor(s): Blender Foundation (2008).
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file blender/blenkernel/intern/report.c
27  *  \ingroup bke
28  */
29
30
31 #include "MEM_guardedalloc.h"
32
33 #include "BLI_blenlib.h"
34 #include "BLI_dynstr.h"
35 #include "BLI_utildefines.h"
36
37 #include "BKE_report.h"
38 #include "BKE_global.h" /* G.background only */
39
40 #include <stdarg.h>
41 #include <stdio.h>
42 #include <string.h>
43
44 static const char *report_type_str(int type)
45 {
46         switch (type) {
47                 case RPT_DEBUG: return "Debug";
48                 case RPT_INFO: return "Info";
49                 case RPT_OPERATOR: return "Operator";
50                 case RPT_WARNING: return "Warning";
51                 case RPT_ERROR: return "Error";
52                 case RPT_ERROR_INVALID_INPUT: return "Invalid Input Error";
53                 case RPT_ERROR_INVALID_CONTEXT: return "Invalid Context Error";
54                 case RPT_ERROR_OUT_OF_MEMORY: return "Out Of Memory Error";
55                 default: return "Undefined Type";
56         }
57 }
58
59 void BKE_reports_init(ReportList *reports, int flag)
60 {
61         if (!reports)
62                 return;
63
64         memset(reports, 0, sizeof(ReportList));
65
66         reports->storelevel = RPT_INFO;
67         reports->printlevel = RPT_ERROR;
68         reports->flag = flag;
69 }
70
71 void BKE_reports_clear(ReportList *reports)
72 {
73         Report *report, *report_next;
74
75         if (!reports)
76                 return;
77
78         report = reports->list.first;
79
80         while (report) {
81                 report_next = report->next;
82                 MEM_freeN((void *)report->message);
83                 MEM_freeN(report);
84                 report = report_next;
85         }
86
87         reports->list.first = reports->list.last = NULL;
88 }
89
90 void BKE_report(ReportList *reports, ReportType type, const char *message)
91 {
92         Report *report;
93         int len;
94
95         /* in background mode always print otherwise there are cases the errors wont be displayed,
96          * but still add to the report list since this is used for python exception handling */
97         if (G.background || !reports || ((reports->flag & RPT_PRINT) && (type >= reports->printlevel))) {
98                 printf("%s: %s\n", report_type_str(type), message);
99                 fflush(stdout); /* this ensures the message is printed before a crash */
100         }
101
102         if (reports && (reports->flag & RPT_STORE) && (type >= reports->storelevel)) {
103                 char *message_alloc;
104                 report = MEM_callocN(sizeof(Report), "Report");
105                 report->type = type;
106                 report->typestr = report_type_str(type);
107
108                 len = strlen(message);
109                 message_alloc = MEM_callocN(sizeof(char) * (len + 1), "ReportMessage");
110                 memcpy(message_alloc, message, sizeof(char) * (len + 1));
111                 report->message = message_alloc;
112                 report->len = len;
113                 BLI_addtail(&reports->list, report);
114         }
115 }
116
117 void BKE_reportf(ReportList *reports, ReportType type, const char *format, ...)
118 {
119         DynStr *ds;
120         Report *report;
121         va_list args;
122
123         if (G.background || !reports || ((reports->flag & RPT_PRINT) && (type >= reports->printlevel))) {
124                 va_start(args, format);
125                 vprintf(format, args);
126                 va_end(args);
127                 fprintf(stdout, "\n"); /* otherise each report needs to include a \n */
128                 fflush(stdout); /* this ensures the message is printed before a crash */
129         }
130
131         if (reports && (reports->flag & RPT_STORE) && (type >= reports->storelevel)) {
132                 report = MEM_callocN(sizeof(Report), "Report");
133
134                 ds = BLI_dynstr_new();
135                 va_start(args, format);
136                 BLI_dynstr_vappendf(ds, format, args);
137                 va_end(args);
138
139                 report->message = BLI_dynstr_get_cstring(ds);
140                 report->len = BLI_dynstr_get_len(ds);
141                 BLI_dynstr_free(ds);
142
143                 report->type = type;
144                 report->typestr = report_type_str(type);
145
146                 BLI_addtail(&reports->list, report);
147         }
148 }
149
150 void BKE_reports_prepend(ReportList *reports, const char *prepend)
151 {
152         Report *report;
153         DynStr *ds;
154
155         if (!reports)
156                 return;
157
158         for (report = reports->list.first; report; report = report->next) {
159                 ds = BLI_dynstr_new();
160
161                 BLI_dynstr_append(ds, prepend);
162                 BLI_dynstr_append(ds, report->message);
163                 MEM_freeN((void *)report->message);
164
165                 report->message = BLI_dynstr_get_cstring(ds);
166                 report->len = BLI_dynstr_get_len(ds);
167
168                 BLI_dynstr_free(ds);
169         }
170 }
171
172 void BKE_reports_prependf(ReportList *reports, const char *prepend, ...)
173 {
174         Report *report;
175         DynStr *ds;
176         va_list args;
177
178         if (!reports)
179                 return;
180
181         for (report = reports->list.first; report; report = report->next) {
182                 ds = BLI_dynstr_new();
183                 va_start(args, prepend);
184                 BLI_dynstr_vappendf(ds, prepend, args);
185                 va_end(args);
186
187                 BLI_dynstr_append(ds, report->message);
188                 MEM_freeN((void *)report->message);
189
190                 report->message = BLI_dynstr_get_cstring(ds);
191                 report->len = BLI_dynstr_get_len(ds);
192
193                 BLI_dynstr_free(ds);
194         }
195 }
196
197 ReportType BKE_report_print_level(ReportList *reports)
198 {
199         if (!reports)
200                 return RPT_ERROR;
201
202         return reports->printlevel;
203 }
204
205 void BKE_report_print_level_set(ReportList *reports, ReportType level)
206 {
207         if (!reports)
208                 return;
209
210         reports->printlevel = level;
211 }
212
213 ReportType BKE_report_store_level(ReportList *reports)
214 {
215         if (!reports)
216                 return RPT_ERROR;
217
218         return reports->storelevel;
219 }
220
221 void BKE_report_store_level_set(ReportList *reports, ReportType level)
222 {
223         if (!reports)
224                 return;
225
226         reports->storelevel = level;
227 }
228
229 char *BKE_reports_string(ReportList *reports, ReportType level)
230 {
231         Report *report;
232         DynStr *ds;
233         char *cstring;
234
235         if (!reports || !reports->list.first)
236                 return NULL;
237
238         ds = BLI_dynstr_new();
239         for (report = reports->list.first; report; report = report->next)
240                 if (report->type >= level)
241                         BLI_dynstr_appendf(ds, "%s: %s\n", report->typestr, report->message);
242
243         if (BLI_dynstr_get_len(ds))
244                 cstring = BLI_dynstr_get_cstring(ds);
245         else
246                 cstring = NULL;
247
248         BLI_dynstr_free(ds);
249         return cstring;
250 }
251
252 void BKE_reports_print(ReportList *reports, ReportType level)
253 {
254         char *cstring = BKE_reports_string(reports, level);
255         
256         if (cstring == NULL)
257                 return;
258         
259         puts(cstring);
260         fflush(stdout);
261         MEM_freeN(cstring);
262 }
263
264 Report *BKE_reports_last_displayable(ReportList *reports)
265 {
266         Report *report;
267         
268         for (report = reports->list.last; report; report = report->prev) {
269                 if (ELEM3(report->type, RPT_ERROR, RPT_WARNING, RPT_INFO))
270                         return report;
271         }
272         
273         return NULL;
274 }
275
276 int BKE_reports_contain(ReportList *reports, ReportType level)
277 {
278         Report *report;
279         if (reports != NULL) {
280                 for (report = reports->list.first; report; report = report->next)
281                         if (report->type >= level)
282                                 return TRUE;
283         }
284         return FALSE;
285 }
286