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