Big i18n commit: add "reports" from bmesh/readfile/tracking/dynapaint (and a few...
[blender.git] / source / blender / editors / space_info / info_ops.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) 2008 Blender Foundation.
19  * All rights reserved.
20  *
21  * 
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/editors/space_info/info_ops.c
28  *  \ingroup spinfo
29  */
30
31
32 #include <string.h>
33 #include <stdio.h>
34
35 #include "DNA_packedFile_types.h"
36 #include "DNA_space_types.h"
37 #include "DNA_windowmanager_types.h"
38
39 #include "MEM_guardedalloc.h"
40
41 #include "BLI_blenlib.h"
42 #include "BLI_math.h"
43 #include "BLI_bpath.h"
44 #include "BLI_utildefines.h"
45
46 #include "BKE_context.h"
47 #include "BKE_global.h"
48 #include "BKE_image.h"
49 #include "BKE_main.h"
50 #include "BKE_packedFile.h"
51 #include "BKE_report.h"
52
53
54 #include "WM_api.h"
55 #include "WM_types.h"
56
57
58 #include "UI_interface.h"
59 #include "UI_resources.h"
60
61 #include "IMB_imbuf_types.h"
62
63 #include "RNA_access.h"
64 #include "RNA_define.h"
65
66
67 #include "info_intern.h"
68
69 /********************* pack all operator *********************/
70
71 static int pack_all_exec(bContext *C, wmOperator *op)
72 {
73         Main *bmain = CTX_data_main(C);
74
75         packAll(bmain, op->reports);
76         G.fileflags |= G_AUTOPACK;
77
78         return OPERATOR_FINISHED;
79 }
80
81 static int pack_all_invoke(bContext *C, wmOperator *op, wmEvent *UNUSED(event))
82 {
83         Main *bmain = CTX_data_main(C);
84         Image *ima;
85         ImBuf *ibuf;
86
87         // first check for dirty images
88         for (ima = bmain->image.first; ima; ima = ima->id.next) {
89                 if (ima->ibufs.first) { /* XXX FIX */
90                         ibuf = BKE_image_get_ibuf(ima, NULL);
91                         
92                         if (ibuf && (ibuf->userflags & IB_BITMAPDIRTY))
93                                 break;
94                 }
95         }
96
97         if (ima) {
98                 uiPupMenuOkee(C, "FILE_OT_pack_all", "Some images are painted on. These changes will be lost. Continue?");
99                 return OPERATOR_CANCELLED;
100         }
101
102         return pack_all_exec(C, op);
103 }
104
105 void FILE_OT_pack_all(wmOperatorType *ot)
106 {
107         /* identifiers */
108         ot->name = "Pack All";
109         ot->idname = "FILE_OT_pack_all";
110         ot->description = "Pack all used external files into the .blend";
111         
112         /* api callbacks */
113         ot->exec = pack_all_exec;
114         ot->invoke = pack_all_invoke;
115
116         /* flags */
117         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
118 }
119
120 /********************* unpack all operator *********************/
121
122 static const EnumPropertyItem unpack_all_method_items[] = {
123         {PF_USE_LOCAL, "USE_LOCAL", 0, "Use files in current directory (create when necessary)", ""},
124         {PF_WRITE_LOCAL, "WRITE_LOCAL", 0, "Write files to current directory (overwrite existing files)", ""},
125         {PF_USE_ORIGINAL, "USE_ORIGINAL", 0, "Use files in original location (create when necessary)", ""},
126         {PF_WRITE_ORIGINAL, "WRITE_ORIGINAL", 0, "Write files to original location (overwrite existing files)", ""},
127         {PF_KEEP, "KEEP", 0, "Disable Auto-pack, keep all packed files", ""},
128         /* {PF_ASK, "ASK", 0, "Ask for each file", ""}, */
129         {0, NULL, 0, NULL, NULL}};
130
131 static int unpack_all_exec(bContext *C, wmOperator *op)
132 {
133         Main *bmain = CTX_data_main(C);
134         int method = RNA_enum_get(op->ptr, "method");
135
136         if (method != PF_KEEP) unpackAll(bmain, op->reports, method);  /* XXX PF_ASK can't work here */
137         G.fileflags &= ~G_AUTOPACK;
138
139         return OPERATOR_FINISHED;
140 }
141
142 static int unpack_all_invoke(bContext *C, wmOperator *op, wmEvent *UNUSED(event))
143 {
144         Main *bmain = CTX_data_main(C);
145         uiPopupMenu *pup;
146         uiLayout *layout;
147         char title[64];
148         int count = 0;
149         
150         count = countPackedFiles(bmain);
151         
152         if (!count) {
153                 BKE_report(op->reports, RPT_WARNING, "No packed files (auto-pack disabled)");
154                 G.fileflags &= ~G_AUTOPACK;
155                 return OPERATOR_CANCELLED;
156         }
157
158         if (count == 1)
159                 strcpy(title, "Unpack 1 file");
160         else
161                 BLI_snprintf(title, sizeof(title), "Unpack %d files", count);
162         
163         pup = uiPupMenuBegin(C, title, ICON_NONE);
164         layout = uiPupMenuLayout(pup);
165
166         uiLayoutSetOperatorContext(layout, WM_OP_EXEC_DEFAULT);
167         uiItemsEnumO(layout, "FILE_OT_unpack_all", "method");
168
169         uiPupMenuEnd(C, pup);
170
171         return OPERATOR_CANCELLED;
172 }
173
174 void FILE_OT_unpack_all(wmOperatorType *ot)
175 {
176         /* identifiers */
177         ot->name = "Unpack All";
178         ot->idname = "FILE_OT_unpack_all";
179         ot->description = "Unpack all files packed into this .blend to external ones";
180         
181         /* api callbacks */
182         ot->exec = unpack_all_exec;
183         ot->invoke = unpack_all_invoke;
184
185         /* flags */
186         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
187
188         /* properties */
189         RNA_def_enum(ot->srna, "method", unpack_all_method_items, PF_USE_LOCAL, "Method", "How to unpack");
190 }
191
192 /********************* make paths relative operator *********************/
193
194 static int make_paths_relative_exec(bContext *C, wmOperator *op)
195 {
196         Main *bmain = CTX_data_main(C);
197
198         if (!G.relbase_valid) {
199                 BKE_report(op->reports, RPT_WARNING, "Cannot set relative paths with an unsaved blend file");
200                 return OPERATOR_CANCELLED;
201         }
202
203         BLI_bpath_relative_convert(bmain, bmain->name, op->reports);
204
205         /* redraw everything so any changed paths register */
206         WM_main_add_notifier(NC_WINDOW, NULL);
207
208         return OPERATOR_FINISHED;
209 }
210
211 void FILE_OT_make_paths_relative(wmOperatorType *ot)
212 {
213         /* identifiers */
214         ot->name = "Make All Paths Relative";
215         ot->idname = "FILE_OT_make_paths_relative";
216         ot->description = "Make all paths to external files relative to current .blend";
217         
218         /* api callbacks */
219         ot->exec = make_paths_relative_exec;
220
221         /* flags */
222         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
223 }
224
225 /********************* make paths absolute operator *********************/
226
227 static int make_paths_absolute_exec(bContext *C, wmOperator *op)
228 {
229         Main *bmain = CTX_data_main(C);
230
231         if (!G.relbase_valid) {
232                 BKE_report(op->reports, RPT_WARNING, "Cannot set absolute paths with an unsaved blend file");
233                 return OPERATOR_CANCELLED;
234         }
235
236         BLI_bpath_absolute_convert(bmain, bmain->name, op->reports);
237
238         /* redraw everything so any changed paths register */
239         WM_main_add_notifier(NC_WINDOW, NULL);
240
241         return OPERATOR_FINISHED;
242 }
243
244 void FILE_OT_make_paths_absolute(wmOperatorType *ot)
245 {
246         /* identifiers */
247         ot->name = "Make All Paths Absolute";
248         ot->idname = "FILE_OT_make_paths_absolute";
249         ot->description = "Make all paths to external files absolute";
250         
251         /* api callbacks */
252         ot->exec = make_paths_absolute_exec;
253
254         /* flags */
255         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
256 }
257
258 /********************* report missing files operator *********************/
259
260 static int report_missing_files_exec(bContext *C, wmOperator *op)
261 {
262         Main *bmain = CTX_data_main(C);
263
264         /* run the missing file check */
265         BLI_bpath_missing_files_check(bmain, op->reports);
266         
267         return OPERATOR_FINISHED;
268 }
269
270 void FILE_OT_report_missing_files(wmOperatorType *ot)
271 {
272         /* identifiers */
273         ot->name = "Report Missing Files";
274         ot->idname = "FILE_OT_report_missing_files";
275         ot->description = "Report all missing external files";
276         
277         /* api callbacks */
278         ot->exec = report_missing_files_exec;
279
280         /* flags */
281         ot->flag = 0; /* only reports so no need to undo/register */
282 }
283
284 /********************* find missing files operator *********************/
285
286 static int find_missing_files_exec(bContext *C, wmOperator *op)
287 {
288         Main *bmain = CTX_data_main(C);
289         const char *searchpath = RNA_string_get_alloc(op->ptr, "filepath", NULL, 0);
290         BLI_bpath_missing_files_find(bmain, searchpath, op->reports);
291         MEM_freeN((void *)searchpath);
292
293         return OPERATOR_FINISHED;
294 }
295
296 static int find_missing_files_invoke(bContext *C, wmOperator *op, wmEvent *UNUSED(event))
297 {
298         /* XXX file open button text "Find Missing Files" */
299         WM_event_add_fileselect(C, op); 
300         return OPERATOR_RUNNING_MODAL;
301 }
302
303 void FILE_OT_find_missing_files(wmOperatorType *ot)
304 {
305         /* identifiers */
306         ot->name = "Find Missing Files";
307         ot->idname = "FILE_OT_find_missing_files";
308         ot->description = "Try to find missing external files";
309         
310         /* api callbacks */
311         ot->exec = find_missing_files_exec;
312         ot->invoke = find_missing_files_invoke;
313
314         /* flags */
315         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
316
317         /* properties */
318         WM_operator_properties_filesel(ot, 0, FILE_SPECIAL, FILE_OPENFILE,
319                                        WM_FILESEL_FILEPATH, FILE_DEFAULTDISPLAY);
320 }
321
322 /********************* report box operator *********************/
323
324 /* Hard to decide whether to keep this as an operator, 
325  * or turn it into a hardcoded ui control feature, 
326  * handling TIMER events for all regions in interface_handlers.c
327  * Not sure how good that is to be accessing UI data from 
328  * inactive regions, so use this for now. --matt
329  */
330
331 #define INFO_TIMEOUT        5.0f
332 #define INFO_COLOR_TIMEOUT  3.0f
333 #define ERROR_TIMEOUT       10.0f
334 #define ERROR_COLOR_TIMEOUT 6.0f
335 #define COLLAPSE_TIMEOUT    0.25f
336 static int update_reports_display_invoke(bContext *C, wmOperator *UNUSED(op), wmEvent *event)
337 {
338         wmWindowManager *wm = CTX_wm_manager(C);
339         ReportList *reports = CTX_wm_reports(C);
340         Report *report;
341         ReportTimerInfo *rti;
342         float progress = 0.0, color_progress = 0.0;
343         float neutral_col[3] = {0.35, 0.35, 0.35};
344         float neutral_gray = 0.6;
345         float timeout = 0.0, color_timeout = 0.0;
346         int send_note = 0;
347         
348         /* escape if not our timer */
349         if ((reports->reporttimer == NULL) ||
350             (reports->reporttimer != event->customdata) ||
351             ((report = BKE_reports_last_displayable(reports)) == NULL) /* may have been deleted */
352             )
353         {
354                 return OPERATOR_PASS_THROUGH;
355         }
356
357         rti = (ReportTimerInfo *)reports->reporttimer->customdata;
358         
359         timeout = (report->type & RPT_ERROR_ALL) ? ERROR_TIMEOUT : INFO_TIMEOUT;
360         color_timeout = (report->type & RPT_ERROR_ALL) ? ERROR_COLOR_TIMEOUT : INFO_COLOR_TIMEOUT;
361         
362         /* clear the report display after timeout */
363         if ((float)reports->reporttimer->duration > timeout) {
364                 WM_event_remove_timer(wm, NULL, reports->reporttimer);
365                 reports->reporttimer = NULL;
366                 
367                 WM_event_add_notifier(C, NC_SPACE | ND_SPACE_INFO, NULL);
368                 
369                 return (OPERATOR_FINISHED | OPERATOR_PASS_THROUGH);
370         }
371
372         if (rti->widthfac == 0.0f) {
373                 /* initialize colors based on report type */
374                 if (report->type & RPT_ERROR_ALL) {
375                         rti->col[0] = 1.0;
376                         rti->col[1] = 0.2;
377                         rti->col[2] = 0.0;
378                 }
379                 else if (report->type & RPT_WARNING_ALL) {
380                         rti->col[0] = 1.0;
381                         rti->col[1] = 1.0;
382                         rti->col[2] = 0.0;
383                 }
384                 else if (report->type & RPT_INFO_ALL) {
385                         rti->col[0] = 0.3;
386                         rti->col[1] = 0.45;
387                         rti->col[2] = 0.7;
388                 }
389                 rti->grayscale = 0.75;
390                 rti->widthfac = 1.0;
391         }
392         
393         progress = (float)reports->reporttimer->duration / timeout;
394         color_progress = (float)reports->reporttimer->duration / color_timeout;
395         
396         /* save us from too many draws */
397         if (color_progress <= 1.0f) {
398                 send_note = 1;
399                 
400                 /* fade colors out sharply according to progress through fade-out duration */
401                 interp_v3_v3v3(rti->col, rti->col, neutral_col, color_progress);
402                 rti->grayscale = interpf(neutral_gray, rti->grayscale, color_progress);
403         }
404
405         /* collapse report at end of timeout */
406         if (progress * timeout > timeout - COLLAPSE_TIMEOUT) {
407                 rti->widthfac = (progress * timeout - (timeout - COLLAPSE_TIMEOUT)) / COLLAPSE_TIMEOUT;
408                 rti->widthfac = 1.0f - rti->widthfac;
409                 send_note = 1;
410         }
411         
412         if (send_note) {
413                 WM_event_add_notifier(C, NC_SPACE | ND_SPACE_INFO, NULL);
414         }
415         
416         return (OPERATOR_FINISHED | OPERATOR_PASS_THROUGH);
417 }
418
419 void INFO_OT_reports_display_update(wmOperatorType *ot)
420 {
421         /* identifiers */
422         ot->name = "Update Reports Display";
423         ot->idname = "INFO_OT_reports_display_update";
424         ot->description = "Update the display of reports in Blender UI (internal use)";
425         
426         /* api callbacks */
427         ot->invoke = update_reports_display_invoke;
428         
429         /* flags */
430         ot->flag = 0;
431         
432         /* properties */
433 }
434
435 /* report operators */