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