Cleanup: remove unused test break code for handling cancels.
[blender.git] / source / blender / windowmanager / intern / wm_init_exit.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2007 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup wm
22  *
23  * Manage initializing resources and correctly shutting down.
24  */
25
26 #include <stdlib.h>
27 #include <stdio.h>
28 #include <string.h>
29
30 #ifdef _WIN32
31 #  define WIN32_LEAN_AND_MEAN
32 #  include <windows.h>
33 #endif
34
35 #include "MEM_guardedalloc.h"
36
37 #include "CLG_log.h"
38
39 #include "DNA_genfile.h"
40 #include "DNA_scene_types.h"
41 #include "DNA_userdef_types.h"
42 #include "DNA_windowmanager_types.h"
43
44 #include "BLI_callbacks.h"
45 #include "BLI_listbase.h"
46 #include "BLI_path_util.h"
47 #include "BLI_string.h"
48 #include "BLI_threads.h"
49 #include "BLI_utildefines.h"
50 #include "BLI_timer.h"
51
52 #include "BLO_writefile.h"
53 #include "BLO_undofile.h"
54
55 #include "BKE_blender.h"
56 #include "BKE_blender_undo.h"
57 #include "BKE_context.h"
58 #include "BKE_font.h"
59 #include "BKE_global.h"
60 #include "BKE_icons.h"
61 #include "BKE_library_remap.h"
62 #include "BKE_main.h"
63 #include "BKE_mball_tessellate.h"
64 #include "BKE_node.h"
65 #include "BKE_report.h"
66 #include "BKE_screen.h"
67 #include "BKE_keyconfig.h"
68
69 #include "BKE_addon.h"
70 #include "BKE_appdir.h"
71 #include "BKE_sequencer.h" /* free seq clipboard */
72 #include "BKE_studiolight.h"
73 #include "BKE_material.h" /* clear_matcopybuf */
74 #include "BKE_tracking.h" /* free tracking clipboard */
75 #include "BKE_mask.h" /* free mask clipboard */
76
77 #include "RE_engine.h"
78 #include "RE_pipeline.h"        /* RE_ free stuff */
79
80 #ifdef WITH_PYTHON
81 #include "BPY_extern.h"
82 #endif
83
84 #include "GHOST_Path-api.h"
85 #include "GHOST_C-api.h"
86
87 #include "RNA_define.h"
88
89 #include "WM_api.h"
90 #include "WM_types.h"
91 #include "WM_message.h"
92
93 #include "wm_cursors.h"
94 #include "wm_event_system.h"
95 #include "wm.h"
96 #include "wm_files.h"
97 #include "wm_window.h"
98
99 #include "ED_anim_api.h"
100 #include "ED_armature.h"
101 #include "ED_gpencil.h"
102 #include "ED_keyframing.h"
103 #include "ED_keyframes_edit.h"
104 #include "ED_node.h"
105 #include "ED_render.h"
106 #include "ED_space_api.h"
107 #include "ED_screen.h"
108 #include "ED_util.h"
109 #include "ED_undo.h"
110
111 #include "UI_interface.h"
112 #include "UI_resources.h"
113 #include "BLF_api.h"
114 #include "BLT_lang.h"
115
116 #include "GPU_material.h"
117 #include "GPU_draw.h"
118 #include "GPU_immediate.h"
119 #include "GPU_init_exit.h"
120
121 #include "BKE_sound.h"
122 #include "COM_compositor.h"
123
124 #include "DEG_depsgraph.h"
125
126 #include "DRW_engine.h"
127
128 #ifdef WITH_OPENSUBDIV
129 #  include "BKE_subsurf.h"
130 #endif
131
132 CLG_LOGREF_DECLARE_GLOBAL(WM_LOG_OPERATORS, "wm.operator");
133 CLG_LOGREF_DECLARE_GLOBAL(WM_LOG_HANDLERS, "wm.handler");
134 CLG_LOGREF_DECLARE_GLOBAL(WM_LOG_EVENTS, "wm.event");
135 CLG_LOGREF_DECLARE_GLOBAL(WM_LOG_KEYMAPS, "wm.keymap");
136 CLG_LOGREF_DECLARE_GLOBAL(WM_LOG_TOOLS, "wm.tool");
137 CLG_LOGREF_DECLARE_GLOBAL(WM_LOG_MSGBUS_PUB, "wm.msgbus.pub");
138 CLG_LOGREF_DECLARE_GLOBAL(WM_LOG_MSGBUS_SUB, "wm.msgbus.sub");
139
140 static void wm_init_reports(bContext *C)
141 {
142         ReportList *reports = CTX_wm_reports(C);
143
144         BLI_assert(!reports || BLI_listbase_is_empty(&reports->list));
145
146         BKE_reports_init(reports, RPT_STORE);
147 }
148 static void wm_free_reports(bContext *C)
149 {
150         ReportList *reports = CTX_wm_reports(C);
151
152         BKE_reports_clear(reports);
153 }
154
155 static bool wm_start_with_console = false;
156
157 void WM_init_state_start_with_console_set(bool value)
158 {
159         wm_start_with_console = value;
160 }
161
162 /**
163  * Since we cannot know in advance if we will require the draw manager
164  * context when starting blender in background mode (specially true with
165  * scripts) we deferre the ghost initialization the most as possible
166  * so that it does not break anything that can run in headless mode (as in
167  * without display server attached).
168  **/
169 static bool opengl_is_init = false;
170
171 void WM_init_opengl(Main *bmain)
172 {
173         /* must be called only once */
174         BLI_assert(opengl_is_init == false);
175
176         if (G.background) {
177                 /* Ghost is still not init elsewhere in background mode. */
178                 wm_ghost_init(NULL);
179         }
180
181         /* Needs to be first to have an ogl context bound. */
182         DRW_opengl_context_create();
183
184         GPU_init();
185         GPU_set_mipmap(bmain, true);
186         GPU_set_linear_mipmap(true);
187         GPU_set_anisotropic(bmain, U.anisotropic_filter);
188
189         GPU_pass_cache_init();
190
191 #ifdef WITH_OPENSUBDIV
192         BKE_subsurf_osd_init();
193 #endif
194         opengl_is_init = true;
195 }
196
197 /* only called once, for startup */
198 void WM_init(bContext *C, int argc, const char **argv)
199 {
200
201         if (!G.background) {
202                 wm_ghost_init(C);   /* note: it assigns C to ghost! */
203                 wm_init_cursor_data();
204         }
205
206         GHOST_CreateSystemPaths();
207
208         BKE_addon_pref_type_init();
209         BKE_keyconfig_pref_type_init();
210
211         wm_operatortype_init();
212         wm_operatortypes_register();
213
214         WM_paneltype_init();  /* Lookup table only. */
215         WM_menutype_init();
216         WM_uilisttype_init();
217         wm_gizmotype_init();
218         wm_gizmogrouptype_init();
219
220         ED_undosys_type_init();
221
222         BKE_library_callback_free_window_manager_set(wm_close_and_free);   /* library.c */
223         BKE_library_callback_free_notifier_reference_set(WM_main_remove_notifier_reference);   /* library.c */
224         BKE_region_callback_free_gizmomap_set(wm_gizmomap_remove); /* screen.c */
225         BKE_region_callback_refresh_tag_gizmomap_set(WM_gizmomap_tag_refresh);
226         BKE_library_callback_remap_editor_id_reference_set(WM_main_remap_editor_id_reference);   /* library.c */
227         BKE_spacedata_callback_id_remap_set(ED_spacedata_id_remap); /* screen.c */
228         DEG_editors_set_update_cb(ED_render_id_flush_update,
229                                   ED_render_scene_update);
230
231         ED_spacetypes_init();   /* editors/space_api/spacetype.c */
232
233         ED_file_init();         /* for fsmenu */
234         ED_node_init_butfuncs();
235
236         BLF_init();
237
238         BLT_lang_init();
239         /* Must call first before doing any .blend file reading, since versionning code may create new IDs... See T57066. */
240         BLT_lang_set(NULL);
241
242         /* Init icons before reading .blend files for preview icons, which can
243          * get triggered by the depsgraph. This is also done in background mode
244          * for scripts that do background processing with preview icons. */
245         BKE_icons_init(BIFICONID_LAST);
246
247         /* reports cant be initialized before the wm,
248          * but keep before file reading, since that may report errors */
249         wm_init_reports(C);
250
251         WM_msgbus_types_init();
252
253         /* get the default database, plus a wm */
254         bool is_factory_startup = true;
255         wm_homefile_read(
256                 C, NULL, G.factory_startup, false, true, NULL, WM_init_state_app_template_get(),
257                 &is_factory_startup);
258
259         /* Call again to set from userpreferences... */
260         BLT_lang_set(NULL);
261
262         if (!G.background) {
263
264 #ifdef WITH_INPUT_NDOF
265                 /* sets 3D mouse deadzone */
266                 WM_ndof_deadzone_set(U.ndof_deadzone);
267 #endif
268                 WM_init_opengl(G_MAIN);
269
270                 UI_init();
271         }
272
273         BKE_studiolight_init();
274
275         ED_spacemacros_init();
276
277         /* note: there is a bug where python needs initializing before loading the
278          * startup.blend because it may contain PyDrivers. It also needs to be after
279          * initializing space types and other internal data.
280          *
281          * However cant redo this at the moment. Solution is to load python
282          * before wm_homefile_read() or make py-drivers check if python is running.
283          * Will try fix when the crash can be repeated. - campbell. */
284
285 #ifdef WITH_PYTHON
286         BPY_context_set(C); /* necessary evil */
287         BPY_python_start(argc, argv);
288
289         BPY_python_reset(C);
290 #else
291         (void)argc; /* unused */
292         (void)argv; /* unused */
293 #endif
294
295         if (!G.background && !wm_start_with_console)
296                 GHOST_toggleConsole(3);
297
298         clear_matcopybuf();
299         ED_render_clear_mtex_copybuf();
300
301         // glBlendFuncSeparate(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA, GL_ONE, GL_ONE_MINUS_SRC_ALPHA);
302
303         wm_history_file_read();
304
305         /* allow a path of "", this is what happens when making a new file */
306 #if 0
307         if (BKE_main_blendfile_path_from_global()[0] == '\0')
308                 BLI_make_file_string("/", G_MAIN->name, BKE_appdir_folder_default(), "untitled.blend");
309 #endif
310
311         BLI_strncpy(G.lib, BKE_main_blendfile_path_from_global(), sizeof(G.lib));
312
313 #ifdef WITH_COMPOSITOR
314         if (1) {
315                 extern void *COM_linker_hack;
316                 COM_linker_hack = COM_execute;
317         }
318 #endif
319
320         {
321                 Main *bmain = CTX_data_main(C);
322                 /* note, logic here is from wm_file_read_post,
323                  * call functions that depend on Python being initialized. */
324
325                 /* normally 'wm_homefile_read' will do this,
326                  * however python is not initialized when called from this function.
327                  *
328                  * unlikely any handlers are set but its possible,
329                  * note that recovering the last session does its own callbacks. */
330                 CTX_wm_window_set(C, CTX_wm_manager(C)->windows.first);
331
332                 BLI_callback_exec(bmain, NULL, BLI_CB_EVT_VERSION_UPDATE);
333                 BLI_callback_exec(bmain, NULL, BLI_CB_EVT_LOAD_POST);
334                 if (is_factory_startup) {
335                         BLI_callback_exec(bmain, NULL, BLI_CB_EVT_LOAD_FACTORY_STARTUP_POST);
336                 }
337
338                 wm_file_read_report(C, bmain);
339
340                 if (!G.background) {
341                         CTX_wm_window_set(C, NULL);
342                 }
343         }
344 }
345
346 void WM_init_splash(bContext *C)
347 {
348         if ((U.uiflag & USER_SPLASH_DISABLE) == 0) {
349                 wmWindowManager *wm = CTX_wm_manager(C);
350                 wmWindow *prevwin = CTX_wm_window(C);
351
352                 if (wm->windows.first) {
353                         CTX_wm_window_set(C, wm->windows.first);
354                         WM_operator_name_call(C, "WM_OT_splash", WM_OP_INVOKE_DEFAULT, NULL);
355                         CTX_wm_window_set(C, prevwin);
356                 }
357         }
358 }
359
360 /* free strings of open recent files */
361 static void free_openrecent(void)
362 {
363         struct RecentFile *recent;
364
365         for (recent = G.recent_files.first; recent; recent = recent->next)
366                 MEM_freeN(recent->filepath);
367
368         BLI_freelistN(&(G.recent_files));
369 }
370
371
372 #ifdef WIN32
373 /* Read console events until there is a key event.  Also returns on any error. */
374 static void wait_for_console_key(void)
375 {
376         HANDLE hConsoleInput = GetStdHandle(STD_INPUT_HANDLE);
377
378         if (!ELEM(hConsoleInput, NULL, INVALID_HANDLE_VALUE) && FlushConsoleInputBuffer(hConsoleInput)) {
379                 for (;;) {
380                         INPUT_RECORD buffer;
381                         DWORD ignored;
382
383                         if (!ReadConsoleInput(hConsoleInput, &buffer, 1, &ignored)) {
384                                 break;
385                         }
386
387                         if (buffer.EventType == KEY_EVENT) {
388                                 break;
389                         }
390                 }
391         }
392 }
393 #endif
394
395 static int wm_exit_handler(bContext *C, const wmEvent *event, void *userdata)
396 {
397         WM_exit(C);
398
399         UNUSED_VARS(event, userdata);
400         return WM_UI_HANDLER_BREAK;
401 }
402
403 /**
404  * Cause a delayed WM_exit() call to avoid leaking memory when trying to exit from within operators.
405  */
406 void wm_exit_schedule_delayed(const bContext *C)
407 {
408         /* What we do here is a little bit hacky, but quite simple and doesn't require bigger
409          * changes: Add a handler wrapping WM_exit() to cause a delayed call of it. */
410
411         wmWindow *win = CTX_wm_window(C);
412
413         /* Use modal UI handler for now. Could add separate WM handlers or so, but probably not worth it. */
414         WM_event_add_ui_handler(C, &win->modalhandlers, wm_exit_handler, NULL, NULL, 0);
415         WM_event_add_mousemove(C); /* ensure handler actually gets called */
416 }
417
418 /**
419  * \note doesn't run exit() call #WM_exit() for that.
420  */
421 void WM_exit_ext(bContext *C, const bool do_python)
422 {
423         wmWindowManager *wm = C ? CTX_wm_manager(C) : NULL;
424
425         /* first wrap up running stuff, we assume only the active WM is running */
426         /* modal handlers are on window level freed, others too? */
427         /* note; same code copied in wm_files.c */
428         if (C && wm) {
429                 wmWindow *win;
430
431                 if (!G.background) {
432                         struct MemFile *undo_memfile = wm->undo_stack ? ED_undosys_stack_memfile_get_active(wm->undo_stack) : NULL;
433                         if (undo_memfile != NULL) {
434                                 /* save the undo state as quit.blend */
435                                 Main *bmain = CTX_data_main(C);
436                                 char filename[FILE_MAX];
437                                 bool has_edited;
438                                 int fileflags = G.fileflags & ~(G_FILE_COMPRESS | G_FILE_HISTORY);
439
440                                 BLI_make_file_string("/", filename, BKE_tempdir_base(), BLENDER_QUIT_FILE);
441
442                                 has_edited = ED_editors_flush_edits(bmain, false);
443
444                                 if ((has_edited && BLO_write_file(bmain, filename, fileflags, NULL, NULL)) ||
445                                     (undo_memfile && BLO_memfile_write_file(undo_memfile, filename)))
446                                 {
447                                         printf("Saved session recovery to '%s'\n", filename);
448                                 }
449                         }
450                 }
451
452                 WM_jobs_kill_all(wm);
453
454                 for (win = wm->windows.first; win; win = win->next) {
455
456                         CTX_wm_window_set(C, win);  /* needed by operator close callbacks */
457                         WM_event_remove_handlers(C, &win->handlers);
458                         WM_event_remove_handlers(C, &win->modalhandlers);
459                         ED_screen_exit(C, win, WM_window_get_active_screen(win));
460                 }
461         }
462
463         BLI_timer_free();
464
465         WM_paneltype_clear();
466
467         BKE_addon_pref_type_free();
468         BKE_keyconfig_pref_type_free();
469
470         wm_operatortype_free();
471         wm_dropbox_free();
472         WM_menutype_free();
473         WM_uilisttype_free();
474
475         /* all non-screen and non-space stuff editors did, like editmode */
476         if (C) {
477                 Main *bmain = CTX_data_main(C);
478                 ED_editors_exit(bmain, true);
479         }
480
481         ED_undosys_type_free();
482
483         free_openrecent();
484
485         BKE_mball_cubeTable_free();
486
487         /* render code might still access databases */
488         RE_FreeAllRender();
489         RE_engines_exit();
490
491         ED_preview_free_dbase();  /* frees a Main dbase, before BKE_blender_free! */
492
493         if (C && wm)
494                 wm_free_reports(C);  /* before BKE_blender_free! - since the ListBases get freed there */
495
496         BKE_sequencer_free_clipboard(); /* sequencer.c */
497         BKE_tracking_clipboard_free();
498         BKE_mask_clipboard_free();
499         BKE_vfont_clipboard_free();
500
501 #ifdef WITH_COMPOSITOR
502         COM_deinitialize();
503 #endif
504
505         if (opengl_is_init) {
506 #ifdef WITH_OPENSUBDIV
507                 BKE_subsurf_osd_cleanup();
508 #endif
509
510                 GPU_free_unused_buffers(G_MAIN);
511         }
512
513         BKE_blender_free();  /* blender.c, does entire library and spacetypes */
514 //      free_matcopybuf();
515         ANIM_fcurves_copybuf_free();
516         ANIM_drivers_copybuf_free();
517         ANIM_driver_vars_copybuf_free();
518         ANIM_fmodifiers_copybuf_free();
519         ED_gpencil_anim_copybuf_free();
520         ED_gpencil_strokes_copybuf_free();
521         BKE_node_clipboard_clear();
522
523         /* free gizmo-maps after freeing blender, so no deleted data get accessed during cleaning up of areas */
524         wm_gizmomaptypes_free();
525         wm_gizmogrouptype_free();
526         wm_gizmotype_free();
527
528         BLF_exit();
529
530         if (opengl_is_init) {
531                 DRW_opengl_context_enable_ex(false);
532                 GPU_pass_cache_free();
533                 GPU_exit();
534                 DRW_opengl_context_disable_ex(false);
535                 DRW_opengl_context_destroy();
536         }
537
538 #ifdef WITH_INTERNATIONAL
539         BLF_free_unifont();
540         BLF_free_unifont_mono();
541         BLT_lang_free();
542 #endif
543
544         ANIM_keyingset_infos_exit();
545
546 //      free_txt_data();
547
548
549 #ifdef WITH_PYTHON
550         /* option not to close python so we can use 'atexit' */
551         if (do_python && ((C == NULL) || CTX_py_init_get(C))) {
552                 /* XXX - old note */
553                 /* before BKE_blender_free so py's gc happens while library still exists */
554                 /* needed at least for a rare sigsegv that can happen in pydrivers */
555
556                 /* Update for blender 2.5, move after BKE_blender_free because blender now holds references to PyObject's
557                  * so decref'ing them after python ends causes bad problems every time
558                  * the pyDriver bug can be fixed if it happens again we can deal with it then */
559                 BPY_python_end();
560         }
561 #else
562         (void)do_python;
563 #endif
564
565         ED_file_exit(); /* for fsmenu */
566
567         UI_exit();
568         BKE_blender_userdef_data_free(&U, false);
569
570         RNA_exit(); /* should be after BPY_python_end so struct python slots are cleared */
571
572         wm_ghost_exit();
573
574         CTX_free(C);
575
576         GHOST_DisposeSystemPaths();
577
578         DNA_sdna_current_free();
579
580         BLI_threadapi_exit();
581
582         /* No need to call this early, rather do it late so that other pieces of Blender using sound may exit cleanly,
583          * see also T50676. */
584         BKE_sound_exit();
585
586         CLG_exit();
587
588         BKE_blender_atexit();
589
590         if (MEM_get_memory_blocks_in_use() != 0) {
591                 size_t mem_in_use = MEM_get_memory_in_use() + MEM_get_memory_in_use();
592                 printf("Error: Not freed memory blocks: %u, total unfreed memory %f MB\n",
593                        MEM_get_memory_blocks_in_use(),
594                        (double)mem_in_use / 1024 / 1024);
595                 MEM_printmemlist();
596         }
597         wm_autosave_delete();
598
599         BKE_tempdir_session_purge();
600 }
601
602 /**
603  * \brief Main exit function to close Blender ordinarily.
604  * \note Use #wm_exit_schedule_delayed() to close Blender from an operator. Might leak memory otherwise.
605  */
606 void WM_exit(bContext *C)
607 {
608         WM_exit_ext(C, 1);
609
610         printf("\nBlender quit\n");
611
612 #ifdef WIN32
613         /* ask user to press a key when in debug mode */
614         if (G.debug & G_DEBUG) {
615                 printf("Press any key to exit . . .\n\n");
616                 wait_for_console_key();
617         }
618 #endif
619
620         exit(G.is_break == true);
621 }