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