code cleanup: use const events for modal and invoke operators.
[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_utildefines.h"
44
45 #include "BLF_translation.h"
46
47 #include "BKE_bpath.h"
48 #include "BKE_context.h"
49 #include "BKE_global.h"
50 #include "BKE_image.h"
51 #include "BKE_library.h"
52 #include "BKE_main.h"
53 #include "BKE_packedFile.h"
54 #include "BKE_report.h"
55 #include "BKE_screen.h"
56
57
58 #include "WM_api.h"
59 #include "WM_types.h"
60
61
62 #include "UI_interface.h"
63 #include "UI_resources.h"
64
65 #include "IMB_imbuf_types.h"
66
67 #include "RNA_access.h"
68 #include "RNA_define.h"
69
70
71 #include "info_intern.h"
72
73 /********************* pack blend file libararies operator *********************/
74
75 static int pack_libraries_exec(bContext *C, wmOperator *op)
76 {
77         Main *bmain = CTX_data_main(C);
78
79         packLibraries(bmain, op->reports);
80
81         return OPERATOR_FINISHED;
82 }
83
84 void FILE_OT_pack_libraries(wmOperatorType *ot)
85 {
86         /* identifiers */
87         ot->name = "Pack Blender Libraries";
88         ot->idname = "FILE_OT_pack_libraries";
89         ot->description = "Pack all used Blender library files into the current .blend";
90         
91         /* api callbacks */
92         ot->exec = pack_libraries_exec;
93
94         /* flags */
95         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
96 }
97
98 static int unpack_libraries_exec(bContext *C, wmOperator *op)
99 {
100         Main *bmain = CTX_data_main(C);
101         
102         unpackLibraries(bmain, op->reports);
103         
104         return OPERATOR_FINISHED;
105 }
106
107 static int unpack_libraries_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
108 {
109         return WM_operator_confirm_message(C, op, "Unpack Blender Libraries - creates directories, all new paths should work");
110 }
111
112 void FILE_OT_unpack_libraries(wmOperatorType *ot)
113 {
114         /* identifiers */
115         ot->name = "Unpack Blender Libraries";
116         ot->idname = "FILE_OT_unpack_libraries";
117         ot->description = "Unpack all used Blender library files from this .blend file";
118         
119         /* api callbacks */
120         ot->invoke = unpack_libraries_invoke;
121         ot->exec = unpack_libraries_exec;
122         
123         /* flags */
124         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
125 }
126
127
128 /********************* pack all operator *********************/
129
130 static int pack_all_exec(bContext *C, wmOperator *op)
131 {
132         Main *bmain = CTX_data_main(C);
133         
134         packAll(bmain, op->reports);
135         G.fileflags |= G_AUTOPACK;
136         
137         return OPERATOR_FINISHED;
138 }
139
140 static int pack_all_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
141 {
142         Main *bmain = CTX_data_main(C);
143         Image *ima;
144         ImBuf *ibuf;
145         
146         // first check for dirty images
147         for (ima = bmain->image.first; ima; ima = ima->id.next) {
148                 if (ima->ibufs.first) { /* XXX FIX */
149                         ibuf = BKE_image_acquire_ibuf(ima, NULL, NULL);
150                         
151                         if (ibuf && (ibuf->userflags & IB_BITMAPDIRTY)) {
152                                 BKE_image_release_ibuf(ima, ibuf, NULL);
153                                 break;
154                         }
155                         
156                         BKE_image_release_ibuf(ima, ibuf, NULL);
157                 }
158         }
159         
160         if (ima) {
161                 uiPupMenuOkee(C, "FILE_OT_pack_all", "Some images are painted on. These changes will be lost. Continue?");
162                 return OPERATOR_CANCELLED;
163         }
164         
165         return pack_all_exec(C, op);
166 }
167
168 void FILE_OT_pack_all(wmOperatorType *ot)
169 {
170         /* identifiers */
171         ot->name = "Pack All";
172         ot->idname = "FILE_OT_pack_all";
173         ot->description = "Pack all used external files into the .blend";
174         
175         /* api callbacks */
176         ot->exec = pack_all_exec;
177         ot->invoke = pack_all_invoke;
178         
179         /* flags */
180         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
181 }
182
183
184 /********************* unpack all operator *********************/
185
186 static const EnumPropertyItem unpack_all_method_items[] = {
187         {PF_USE_LOCAL, "USE_LOCAL", 0, "Use files in current directory (create when necessary)", ""},
188         {PF_WRITE_LOCAL, "WRITE_LOCAL", 0, "Write files to current directory (overwrite existing files)", ""},
189         {PF_USE_ORIGINAL, "USE_ORIGINAL", 0, "Use files in original location (create when necessary)", ""},
190         {PF_WRITE_ORIGINAL, "WRITE_ORIGINAL", 0, "Write files to original location (overwrite existing files)", ""},
191         {PF_KEEP, "KEEP", 0, "Disable Auto-pack, keep all packed files", ""},
192         /* {PF_ASK, "ASK", 0, "Ask for each file", ""}, */
193         {0, NULL, 0, NULL, NULL}};
194
195 static int unpack_all_exec(bContext *C, wmOperator *op)
196 {
197         Main *bmain = CTX_data_main(C);
198         int method = RNA_enum_get(op->ptr, "method");
199
200         if (method != PF_KEEP) unpackAll(bmain, op->reports, method);  /* XXX PF_ASK can't work here */
201         G.fileflags &= ~G_AUTOPACK;
202
203         return OPERATOR_FINISHED;
204 }
205
206 static int unpack_all_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
207 {
208         Main *bmain = CTX_data_main(C);
209         uiPopupMenu *pup;
210         uiLayout *layout;
211         char title[64];
212         int count = 0;
213         
214         count = countPackedFiles(bmain);
215         
216         if (!count) {
217                 BKE_report(op->reports, RPT_WARNING, "No packed files (auto-pack disabled)");
218                 G.fileflags &= ~G_AUTOPACK;
219                 return OPERATOR_CANCELLED;
220         }
221
222         if (count == 1)
223                 strcpy(title, IFACE_("Unpack 1 File"));
224         else
225                 BLI_snprintf(title, sizeof(title), IFACE_("Unpack %d Files"), count);
226         
227         pup = uiPupMenuBegin(C, title, ICON_NONE);
228         layout = uiPupMenuLayout(pup);
229
230         uiLayoutSetOperatorContext(layout, WM_OP_EXEC_DEFAULT);
231         uiItemsEnumO(layout, "FILE_OT_unpack_all", "method");
232
233         uiPupMenuEnd(C, pup);
234
235         return OPERATOR_CANCELLED;
236 }
237
238 void FILE_OT_unpack_all(wmOperatorType *ot)
239 {
240         /* identifiers */
241         ot->name = "Unpack All";
242         ot->idname = "FILE_OT_unpack_all";
243         ot->description = "Unpack all files packed into this .blend to external ones";
244         
245         /* api callbacks */
246         ot->exec = unpack_all_exec;
247         ot->invoke = unpack_all_invoke;
248
249         /* flags */
250         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
251
252         /* properties */
253         RNA_def_enum(ot->srna, "method", unpack_all_method_items, PF_USE_LOCAL, "Method", "How to unpack");
254 }
255
256 /********************* unpack single item operator *********************/
257
258 static const EnumPropertyItem unpack_item_method_items[] = {
259         {PF_USE_LOCAL, "USE_LOCAL", 0, "Use file from current directory (create when necessary)", ""},
260         {PF_WRITE_LOCAL, "WRITE_LOCAL", 0, "Write file to current directory (overwrite existing file)", ""},
261         {PF_USE_ORIGINAL, "USE_ORIGINAL", 0, "Use file in original location (create when necessary)", ""},
262         {PF_WRITE_ORIGINAL, "WRITE_ORIGINAL", 0, "Write file to original location (overwrite existing file)", ""},
263         /* {PF_ASK, "ASK", 0, "Ask for each file", ""}, */
264         {0, NULL, 0, NULL, NULL}};
265
266
267 static int unpack_item_exec(bContext *C, wmOperator *op)
268 {
269         Main *bmain = CTX_data_main(C);
270         ID *id;
271         char idname[MAX_ID_NAME - 2];
272         int type = RNA_int_get(op->ptr, "id_type");
273         int method = RNA_enum_get(op->ptr, "method");
274
275         RNA_string_get(op->ptr, "id_name", idname);
276         id = BKE_libblock_find_name(type, idname);
277
278         if (id == NULL) {
279                 BKE_report(op->reports, RPT_WARNING, "No packed file");
280                 return OPERATOR_CANCELLED;
281         }
282         
283         if (method != PF_KEEP)
284                 BKE_unpack_id(bmain, id, op->reports, method);  /* XXX PF_ASK can't work here */
285         
286         G.fileflags &= ~G_AUTOPACK;
287         
288         return OPERATOR_FINISHED;
289 }
290
291 static int unpack_item_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
292 {
293         uiPopupMenu *pup;
294         uiLayout *layout;
295         
296         pup = uiPupMenuBegin(C, IFACE_("Unpack"), ICON_NONE);
297         layout = uiPupMenuLayout(pup);
298         
299         uiLayoutSetOperatorContext(layout, WM_OP_EXEC_DEFAULT);
300         uiItemsFullEnumO(layout, op->type->idname, "method", op->ptr->data, WM_OP_EXEC_REGION_WIN, 0);
301         
302         uiPupMenuEnd(C, pup);
303         
304         return OPERATOR_CANCELLED;
305 }
306
307 void FILE_OT_unpack_item(wmOperatorType *ot)
308 {
309         /* identifiers */
310         ot->name = "Unpack Item";
311         ot->idname = "FILE_OT_unpack_item";
312         ot->description = "Unpack this file to an external file";
313         
314         /* api callbacks */
315         ot->exec = unpack_item_exec;
316         ot->invoke = unpack_item_invoke;
317         
318         /* flags */
319         ot->flag = OPTYPE_UNDO;
320         
321         /* properties */
322         RNA_def_enum(ot->srna, "method", unpack_item_method_items, PF_USE_LOCAL, "Method", "How to unpack");
323         RNA_def_string(ot->srna, "id_name", "", BKE_ST_MAXNAME, "ID name", "Name of ID block to unpack");
324         RNA_def_int(ot->srna, "id_type", ID_IM, 0, INT_MAX, "ID Type", "Identifier type of ID block", 0, INT_MAX);
325 }
326
327
328 /********************* make paths relative operator *********************/
329
330 static int make_paths_relative_exec(bContext *C, wmOperator *op)
331 {
332         Main *bmain = CTX_data_main(C);
333
334         if (!G.relbase_valid) {
335                 BKE_report(op->reports, RPT_WARNING, "Cannot set relative paths with an unsaved blend file");
336                 return OPERATOR_CANCELLED;
337         }
338
339         BKE_bpath_relative_convert(bmain, bmain->name, op->reports);
340
341         /* redraw everything so any changed paths register */
342         WM_main_add_notifier(NC_WINDOW, NULL);
343
344         return OPERATOR_FINISHED;
345 }
346
347 void FILE_OT_make_paths_relative(wmOperatorType *ot)
348 {
349         /* identifiers */
350         ot->name = "Make All Paths Relative";
351         ot->idname = "FILE_OT_make_paths_relative";
352         ot->description = "Make all paths to external files relative to current .blend";
353         
354         /* api callbacks */
355         ot->exec = make_paths_relative_exec;
356
357         /* flags */
358         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
359 }
360
361 /********************* make paths absolute operator *********************/
362
363 static int make_paths_absolute_exec(bContext *C, wmOperator *op)
364 {
365         Main *bmain = CTX_data_main(C);
366
367         if (!G.relbase_valid) {
368                 BKE_report(op->reports, RPT_WARNING, "Cannot set absolute paths with an unsaved blend file");
369                 return OPERATOR_CANCELLED;
370         }
371
372         BKE_bpath_absolute_convert(bmain, bmain->name, op->reports);
373
374         /* redraw everything so any changed paths register */
375         WM_main_add_notifier(NC_WINDOW, NULL);
376
377         return OPERATOR_FINISHED;
378 }
379
380 void FILE_OT_make_paths_absolute(wmOperatorType *ot)
381 {
382         /* identifiers */
383         ot->name = "Make All Paths Absolute";
384         ot->idname = "FILE_OT_make_paths_absolute";
385         ot->description = "Make all paths to external files absolute";
386         
387         /* api callbacks */
388         ot->exec = make_paths_absolute_exec;
389
390         /* flags */
391         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
392 }
393
394 /********************* report missing files operator *********************/
395
396 static int report_missing_files_exec(bContext *C, wmOperator *op)
397 {
398         Main *bmain = CTX_data_main(C);
399
400         /* run the missing file check */
401         BKE_bpath_missing_files_check(bmain, op->reports);
402         
403         return OPERATOR_FINISHED;
404 }
405
406 void FILE_OT_report_missing_files(wmOperatorType *ot)
407 {
408         /* identifiers */
409         ot->name = "Report Missing Files";
410         ot->idname = "FILE_OT_report_missing_files";
411         ot->description = "Report all missing external files";
412         
413         /* api callbacks */
414         ot->exec = report_missing_files_exec;
415
416         /* flags */
417         ot->flag = 0; /* only reports so no need to undo/register */
418 }
419
420 /********************* find missing files operator *********************/
421
422 static int find_missing_files_exec(bContext *C, wmOperator *op)
423 {
424         Main *bmain = CTX_data_main(C);
425         const char *searchpath = RNA_string_get_alloc(op->ptr, "filepath", NULL, 0);
426         BKE_bpath_missing_files_find(bmain, searchpath, op->reports);
427         MEM_freeN((void *)searchpath);
428
429         return OPERATOR_FINISHED;
430 }
431
432 static int find_missing_files_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
433 {
434         /* XXX file open button text "Find Missing Files" */
435         WM_event_add_fileselect(C, op); 
436         return OPERATOR_RUNNING_MODAL;
437 }
438
439 void FILE_OT_find_missing_files(wmOperatorType *ot)
440 {
441         /* identifiers */
442         ot->name = "Find Missing Files";
443         ot->idname = "FILE_OT_find_missing_files";
444         ot->description = "Try to find missing external files";
445         
446         /* api callbacks */
447         ot->exec = find_missing_files_exec;
448         ot->invoke = find_missing_files_invoke;
449
450         /* flags */
451         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
452
453         /* properties */
454         WM_operator_properties_filesel(ot, 0, FILE_SPECIAL, FILE_OPENFILE,
455                                        WM_FILESEL_FILEPATH, FILE_DEFAULTDISPLAY);
456 }
457
458 /********************* report box operator *********************/
459
460 /* Hard to decide whether to keep this as an operator, 
461  * or turn it into a hardcoded ui control feature, 
462  * handling TIMER events for all regions in interface_handlers.c
463  * Not sure how good that is to be accessing UI data from 
464  * inactive regions, so use this for now. --matt
465  */
466
467 #define INFO_TIMEOUT        5.0f
468 #define INFO_COLOR_TIMEOUT  3.0f
469 #define ERROR_TIMEOUT       10.0f
470 #define ERROR_COLOR_TIMEOUT 6.0f
471 #define COLLAPSE_TIMEOUT    0.25f
472 static int update_reports_display_invoke(bContext *C, wmOperator *UNUSED(op), const wmEvent *event)
473 {
474         wmWindowManager *wm = CTX_wm_manager(C);
475         ReportList *reports = CTX_wm_reports(C);
476         Report *report;
477         ReportTimerInfo *rti;
478         float progress = 0.0, color_progress = 0.0;
479         float neutral_col[3] = {0.35, 0.35, 0.35};
480         float neutral_gray = 0.6;
481         float timeout = 0.0, color_timeout = 0.0;
482         int send_note = 0;
483         
484         /* escape if not our timer */
485         if ((reports->reporttimer == NULL) ||
486             (reports->reporttimer != event->customdata) ||
487             ((report = BKE_reports_last_displayable(reports)) == NULL) /* may have been deleted */
488             )
489         {
490                 return OPERATOR_PASS_THROUGH;
491         }
492
493         rti = (ReportTimerInfo *)reports->reporttimer->customdata;
494         
495         timeout = (report->type & RPT_ERROR_ALL) ? ERROR_TIMEOUT : INFO_TIMEOUT;
496         color_timeout = (report->type & RPT_ERROR_ALL) ? ERROR_COLOR_TIMEOUT : INFO_COLOR_TIMEOUT;
497         
498         /* clear the report display after timeout */
499         if ((float)reports->reporttimer->duration > timeout) {
500                 WM_event_remove_timer(wm, NULL, reports->reporttimer);
501                 reports->reporttimer = NULL;
502                 
503                 WM_event_add_notifier(C, NC_SPACE | ND_SPACE_INFO, NULL);
504                 
505                 return (OPERATOR_FINISHED | OPERATOR_PASS_THROUGH);
506         }
507
508         if (rti->widthfac == 0.0f) {
509                 /* initialize colors based on report type */
510                 if (report->type & RPT_ERROR_ALL) {
511                         rti->col[0] = 1.0;
512                         rti->col[1] = 0.2;
513                         rti->col[2] = 0.0;
514                 }
515                 else if (report->type & RPT_WARNING_ALL) {
516                         rti->col[0] = 1.0;
517                         rti->col[1] = 1.0;
518                         rti->col[2] = 0.0;
519                 }
520                 else if (report->type & RPT_INFO_ALL) {
521                         rti->col[0] = 0.3;
522                         rti->col[1] = 0.45;
523                         rti->col[2] = 0.7;
524                 }
525                 rti->grayscale = 0.75;
526                 rti->widthfac = 1.0;
527         }
528         
529         progress = (float)reports->reporttimer->duration / timeout;
530         color_progress = (float)reports->reporttimer->duration / color_timeout;
531         
532         /* save us from too many draws */
533         if (color_progress <= 1.0f) {
534                 send_note = 1;
535                 
536                 /* fade colors out sharply according to progress through fade-out duration */
537                 interp_v3_v3v3(rti->col, rti->col, neutral_col, color_progress);
538                 rti->grayscale = interpf(neutral_gray, rti->grayscale, color_progress);
539         }
540
541         /* collapse report at end of timeout */
542         if (progress * timeout > timeout - COLLAPSE_TIMEOUT) {
543                 rti->widthfac = (progress * timeout - (timeout - COLLAPSE_TIMEOUT)) / COLLAPSE_TIMEOUT;
544                 rti->widthfac = 1.0f - rti->widthfac;
545                 send_note = 1;
546         }
547         
548         if (send_note) {
549                 WM_event_add_notifier(C, NC_SPACE | ND_SPACE_INFO, NULL);
550         }
551         
552         return (OPERATOR_FINISHED | OPERATOR_PASS_THROUGH);
553 }
554
555 void INFO_OT_reports_display_update(wmOperatorType *ot)
556 {
557         /* identifiers */
558         ot->name = "Update Reports Display";
559         ot->idname = "INFO_OT_reports_display_update";
560         ot->description = "Update the display of reports in Blender UI (internal use)";
561         
562         /* api callbacks */
563         ot->invoke = update_reports_display_invoke;
564         
565         /* flags */
566         ot->flag = 0;
567         
568         /* properties */
569 }
570
571 /* report operators */