Cleanup: comment line length (windowmanager)
[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(
224       WM_main_remove_notifier_reference);                    /* library.c */
225   BKE_region_callback_free_gizmomap_set(wm_gizmomap_remove); /* screen.c */
226   BKE_region_callback_refresh_tag_gizmomap_set(WM_gizmomap_tag_refresh);
227   BKE_library_callback_remap_editor_id_reference_set(
228       WM_main_remap_editor_id_reference);                     /* library.c */
229   BKE_spacedata_callback_id_remap_set(ED_spacedata_id_remap); /* screen.c */
230   DEG_editors_set_update_cb(ED_render_id_flush_update, ED_render_scene_update);
231
232   ED_spacetypes_init(); /* editors/space_api/spacetype.c */
233
234   ED_file_init(); /* for fsmenu */
235   ED_node_init_butfuncs();
236
237   BLF_init();
238
239   BLT_lang_init();
240   /* Must call first before doing any '.blend' file reading,
241    * since versionning code may create new IDs... See T57066. */
242   BLT_lang_set(NULL);
243
244   /* Init icons before reading .blend files for preview icons, which can
245    * get triggered by the depsgraph. This is also done in background mode
246    * for scripts that do background processing with preview icons. */
247   BKE_icons_init(BIFICONID_LAST);
248
249   /* reports cant be initialized before the wm,
250    * but keep before file reading, since that may report errors */
251   wm_init_reports(C);
252
253   WM_msgbus_types_init();
254
255   /* get the default database, plus a wm */
256   bool is_factory_startup = true;
257   wm_homefile_read(C,
258                    NULL,
259                    G.factory_startup,
260                    false,
261                    true,
262                    NULL,
263                    WM_init_state_app_template_get(),
264                    &is_factory_startup);
265
266   /* Call again to set from userpreferences... */
267   BLT_lang_set(NULL);
268
269   if (!G.background) {
270
271 #ifdef WITH_INPUT_NDOF
272     /* sets 3D mouse deadzone */
273     WM_ndof_deadzone_set(U.ndof_deadzone);
274 #endif
275     WM_init_opengl(G_MAIN);
276
277     UI_init();
278   }
279
280   BKE_studiolight_init();
281
282   ED_spacemacros_init();
283
284   /* note: there is a bug where python needs initializing before loading the
285    * startup.blend because it may contain PyDrivers. It also needs to be after
286    * initializing space types and other internal data.
287    *
288    * However cant redo this at the moment. Solution is to load python
289    * before wm_homefile_read() or make py-drivers check if python is running.
290    * Will try fix when the crash can be repeated. - campbell. */
291
292 #ifdef WITH_PYTHON
293   BPY_context_set(C); /* necessary evil */
294   BPY_python_start(argc, argv);
295
296   BPY_python_reset(C);
297 #else
298   (void)argc; /* unused */
299   (void)argv; /* unused */
300 #endif
301
302   if (!G.background && !wm_start_with_console) {
303     GHOST_toggleConsole(3);
304   }
305
306   clear_matcopybuf();
307   ED_render_clear_mtex_copybuf();
308
309   // glBlendFuncSeparate(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA, GL_ONE, GL_ONE_MINUS_SRC_ALPHA);
310
311   wm_history_file_read();
312
313   /* allow a path of "", this is what happens when making a new file */
314 #if 0
315   if (BKE_main_blendfile_path_from_global()[0] == '\0')
316     BLI_make_file_string("/", G_MAIN->name, BKE_appdir_folder_default(), "untitled.blend");
317 #endif
318
319   BLI_strncpy(G.lib, BKE_main_blendfile_path_from_global(), sizeof(G.lib));
320
321 #ifdef WITH_COMPOSITOR
322   if (1) {
323     extern void *COM_linker_hack;
324     COM_linker_hack = COM_execute;
325   }
326 #endif
327
328   {
329     Main *bmain = CTX_data_main(C);
330     /* note, logic here is from wm_file_read_post,
331      * call functions that depend on Python being initialized. */
332
333     /* normally 'wm_homefile_read' will do this,
334      * however python is not initialized when called from this function.
335      *
336      * unlikely any handlers are set but its possible,
337      * note that recovering the last session does its own callbacks. */
338     CTX_wm_window_set(C, CTX_wm_manager(C)->windows.first);
339
340     BLI_callback_exec(bmain, NULL, BLI_CB_EVT_VERSION_UPDATE);
341     BLI_callback_exec(bmain, NULL, BLI_CB_EVT_LOAD_POST);
342     if (is_factory_startup) {
343       BLI_callback_exec(bmain, NULL, BLI_CB_EVT_LOAD_FACTORY_STARTUP_POST);
344     }
345
346     wm_file_read_report(C, bmain);
347
348     if (!G.background) {
349       CTX_wm_window_set(C, NULL);
350     }
351   }
352 }
353
354 void WM_init_splash(bContext *C)
355 {
356   if ((U.uiflag & USER_SPLASH_DISABLE) == 0) {
357     wmWindowManager *wm = CTX_wm_manager(C);
358     wmWindow *prevwin = CTX_wm_window(C);
359
360     if (wm->windows.first) {
361       CTX_wm_window_set(C, wm->windows.first);
362       WM_operator_name_call(C, "WM_OT_splash", WM_OP_INVOKE_DEFAULT, NULL);
363       CTX_wm_window_set(C, prevwin);
364     }
365   }
366 }
367
368 /* free strings of open recent files */
369 static void free_openrecent(void)
370 {
371   struct RecentFile *recent;
372
373   for (recent = G.recent_files.first; recent; recent = recent->next) {
374     MEM_freeN(recent->filepath);
375   }
376
377   BLI_freelistN(&(G.recent_files));
378 }
379
380 #ifdef WIN32
381 /* Read console events until there is a key event.  Also returns on any error. */
382 static void wait_for_console_key(void)
383 {
384   HANDLE hConsoleInput = GetStdHandle(STD_INPUT_HANDLE);
385
386   if (!ELEM(hConsoleInput, NULL, INVALID_HANDLE_VALUE) && FlushConsoleInputBuffer(hConsoleInput)) {
387     for (;;) {
388       INPUT_RECORD buffer;
389       DWORD ignored;
390
391       if (!ReadConsoleInput(hConsoleInput, &buffer, 1, &ignored)) {
392         break;
393       }
394
395       if (buffer.EventType == KEY_EVENT) {
396         break;
397       }
398     }
399   }
400 }
401 #endif
402
403 static int wm_exit_handler(bContext *C, const wmEvent *event, void *userdata)
404 {
405   WM_exit(C);
406
407   UNUSED_VARS(event, userdata);
408   return WM_UI_HANDLER_BREAK;
409 }
410
411 /**
412  * Cause a delayed #WM_exit()
413  * call to avoid leaking memory when trying to exit from within operators.
414  */
415 void wm_exit_schedule_delayed(const bContext *C)
416 {
417   /* What we do here is a little bit hacky, but quite simple and doesn't require bigger
418    * changes: Add a handler wrapping WM_exit() to cause a delayed call of it. */
419
420   wmWindow *win = CTX_wm_window(C);
421
422   /* Use modal UI handler for now.
423    * Could add separate WM handlers or so, but probably not worth it. */
424   WM_event_add_ui_handler(C, &win->modalhandlers, wm_exit_handler, NULL, NULL, 0);
425   WM_event_add_mousemove(C); /* ensure handler actually gets called */
426 }
427
428 /**
429  * \note doesn't run exit() call #WM_exit() for that.
430  */
431 void WM_exit_ext(bContext *C, const bool do_python)
432 {
433   wmWindowManager *wm = C ? CTX_wm_manager(C) : NULL;
434
435   /* first wrap up running stuff, we assume only the active WM is running */
436   /* modal handlers are on window level freed, others too? */
437   /* note; same code copied in wm_files.c */
438   if (C && wm) {
439     wmWindow *win;
440
441     if (!G.background) {
442       struct MemFile *undo_memfile = wm->undo_stack ?
443                                          ED_undosys_stack_memfile_get_active(wm->undo_stack) :
444                                          NULL;
445       if (undo_memfile != NULL) {
446         /* save the undo state as quit.blend */
447         Main *bmain = CTX_data_main(C);
448         char filename[FILE_MAX];
449         bool has_edited;
450         int fileflags = G.fileflags & ~(G_FILE_COMPRESS | G_FILE_HISTORY);
451
452         BLI_make_file_string("/", filename, BKE_tempdir_base(), BLENDER_QUIT_FILE);
453
454         has_edited = ED_editors_flush_edits(bmain, false);
455
456         if ((has_edited && BLO_write_file(bmain, filename, fileflags, NULL, NULL)) ||
457             (undo_memfile && BLO_memfile_write_file(undo_memfile, filename))) {
458           printf("Saved session recovery to '%s'\n", filename);
459         }
460       }
461     }
462
463     WM_jobs_kill_all(wm);
464
465     for (win = wm->windows.first; win; win = win->next) {
466
467       CTX_wm_window_set(C, win); /* needed by operator close callbacks */
468       WM_event_remove_handlers(C, &win->handlers);
469       WM_event_remove_handlers(C, &win->modalhandlers);
470       ED_screen_exit(C, win, WM_window_get_active_screen(win));
471     }
472   }
473
474   BLI_timer_free();
475
476   WM_paneltype_clear();
477
478   BKE_addon_pref_type_free();
479   BKE_keyconfig_pref_type_free();
480
481   wm_operatortype_free();
482   wm_dropbox_free();
483   WM_menutype_free();
484   WM_uilisttype_free();
485
486   /* all non-screen and non-space stuff editors did, like editmode */
487   if (C) {
488     Main *bmain = CTX_data_main(C);
489     ED_editors_exit(bmain, true);
490   }
491
492   ED_undosys_type_free();
493
494   free_openrecent();
495
496   BKE_mball_cubeTable_free();
497
498   /* render code might still access databases */
499   RE_FreeAllRender();
500   RE_engines_exit();
501
502   ED_preview_free_dbase(); /* frees a Main dbase, before BKE_blender_free! */
503
504   if (C && wm) {
505     /* Before BKE_blender_free! - since the ListBases get freed there. */
506     wm_free_reports(C);
507   }
508
509   BKE_sequencer_free_clipboard(); /* sequencer.c */
510   BKE_tracking_clipboard_free();
511   BKE_mask_clipboard_free();
512   BKE_vfont_clipboard_free();
513   BKE_node_clipboard_free();
514
515 #ifdef WITH_COMPOSITOR
516   COM_deinitialize();
517 #endif
518
519   if (opengl_is_init) {
520 #ifdef WITH_OPENSUBDIV
521     BKE_subsurf_osd_cleanup();
522 #endif
523
524     GPU_free_unused_buffers(G_MAIN);
525   }
526
527   BKE_blender_free(); /* blender.c, does entire library and spacetypes */
528                       //  free_matcopybuf();
529   ANIM_fcurves_copybuf_free();
530   ANIM_drivers_copybuf_free();
531   ANIM_driver_vars_copybuf_free();
532   ANIM_fmodifiers_copybuf_free();
533   ED_gpencil_anim_copybuf_free();
534   ED_gpencil_strokes_copybuf_free();
535
536   /* free gizmo-maps after freeing blender,
537    * so no deleted data get accessed during cleaning up of areas. */
538   wm_gizmomaptypes_free();
539   wm_gizmogrouptype_free();
540   wm_gizmotype_free();
541
542   BLF_exit();
543
544   if (opengl_is_init) {
545     DRW_opengl_context_enable_ex(false);
546     GPU_pass_cache_free();
547     GPU_exit();
548     DRW_opengl_context_disable_ex(false);
549     DRW_opengl_context_destroy();
550   }
551
552 #ifdef WITH_INTERNATIONAL
553   BLF_free_unifont();
554   BLF_free_unifont_mono();
555   BLT_lang_free();
556 #endif
557
558   ANIM_keyingset_infos_exit();
559
560   //  free_txt_data();
561
562 #ifdef WITH_PYTHON
563   /* option not to close python so we can use 'atexit' */
564   if (do_python && ((C == NULL) || CTX_py_init_get(C))) {
565     /* XXX - old note */
566     /* before BKE_blender_free so py's gc happens while library still exists */
567     /* needed at least for a rare sigsegv that can happen in pydrivers */
568
569     /* Update for blender 2.5, move after BKE_blender_free because Blender now holds references to
570      * PyObject's so decref'ing them after python ends causes bad problems every time
571      * the py-driver bug can be fixed if it happens again we can deal with it then. */
572     BPY_python_end();
573   }
574 #else
575   (void)do_python;
576 #endif
577
578   ED_file_exit(); /* for fsmenu */
579
580   UI_exit();
581   BKE_blender_userdef_data_free(&U, false);
582
583   RNA_exit(); /* should be after BPY_python_end so struct python slots are cleared */
584
585   wm_ghost_exit();
586
587   CTX_free(C);
588
589   GHOST_DisposeSystemPaths();
590
591   DNA_sdna_current_free();
592
593   BLI_threadapi_exit();
594
595   /* No need to call this early, rather do it late so that other
596    * pieces of Blender using sound may exit cleanly, see also T50676. */
597   BKE_sound_exit();
598
599   CLG_exit();
600
601   BKE_blender_atexit();
602
603   if (MEM_get_memory_blocks_in_use() != 0) {
604     size_t mem_in_use = MEM_get_memory_in_use() + MEM_get_memory_in_use();
605     printf("Error: Not freed memory blocks: %u, total unfreed memory %f MB\n",
606            MEM_get_memory_blocks_in_use(),
607            (double)mem_in_use / 1024 / 1024);
608     MEM_printmemlist();
609   }
610   wm_autosave_delete();
611
612   BKE_tempdir_session_purge();
613 }
614
615 /**
616  * \brief Main exit function to close Blender ordinarily.
617  * \note Use #wm_exit_schedule_delayed() to close Blender from an operator.
618  * Might leak memory otherwise.
619  */
620 void WM_exit(bContext *C)
621 {
622   WM_exit_ext(C, 1);
623
624   printf("\nBlender quit\n");
625
626 #ifdef WIN32
627   /* ask user to press a key when in debug mode */
628   if (G.debug & G_DEBUG) {
629     printf("Press any key to exit . . .\n\n");
630     wait_for_console_key();
631   }
632 #endif
633
634   exit(G.is_break == true);
635 }