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