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