9bafe72d80546b5f99018d0ca90e178df3871e94
[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 "DNA_genfile.h"
44 #include "DNA_scene_types.h"
45 #include "DNA_userdef_types.h"
46 #include "DNA_windowmanager_types.h"
47
48 #include "BLI_callbacks.h"
49 #include "BLI_listbase.h"
50 #include "BLI_path_util.h"
51 #include "BLI_string.h"
52 #include "BLI_threads.h"
53 #include "BLI_utildefines.h"
54
55 #include "BLO_writefile.h"
56
57 #include "BKE_blender.h"
58 #include "BKE_blender_undo.h"
59 #include "BKE_context.h"
60 #include "BKE_screen.h"
61 #include "BKE_DerivedMesh.h"
62 #include "BKE_global.h"
63 #include "BKE_icons.h"
64 #include "BKE_library.h"
65 #include "BKE_library_remap.h"
66 #include "BKE_main.h"
67 #include "BKE_mball_tessellate.h"
68 #include "BKE_node.h"
69 #include "BKE_report.h"
70 #include "BKE_font.h"
71
72 #include "BKE_addon.h"
73 #include "BKE_appdir.h"
74 #include "BKE_sequencer.h" /* free seq clipboard */
75 #include "BKE_material.h" /* clear_matcopybuf */
76 #include "BKE_tracking.h" /* free tracking clipboard */
77 #include "BKE_mask.h" /* free mask clipboard */
78
79 #include "RE_engine.h"
80 #include "RE_pipeline.h"        /* RE_ free stuff */
81
82 #ifdef WITH_PYTHON
83 #include "BPY_extern.h"
84 #endif
85
86 #ifdef WITH_GAMEENGINE
87 #  include "BL_System.h"
88 #endif
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
97 #include "wm_cursors.h"
98 #include "wm_event_system.h"
99 #include "wm.h"
100 #include "wm_files.h"
101 #include "wm_window.h"
102
103 #include "ED_anim_api.h"
104 #include "ED_armature.h"
105 #include "ED_gpencil.h"
106 #include "ED_keyframing.h"
107 #include "ED_keyframes_edit.h"
108 #include "ED_node.h"
109 #include "ED_render.h"
110 #include "ED_space_api.h"
111 #include "ED_screen.h"
112 #include "ED_util.h"
113
114 #include "UI_interface.h"
115 #include "BLF_api.h"
116 #include "BLT_lang.h"
117
118 #include "GPU_buffers.h"
119 #include "GPU_draw.h"
120 #include "GPU_init_exit.h"
121
122 #include "BKE_depsgraph.h"
123 #include "BKE_sound.h"
124 #include "COM_compositor.h"
125
126 #ifdef WITH_OPENSUBDIV
127 #  include "BKE_subsurf.h"
128 #endif
129
130 static void wm_init_reports(bContext *C)
131 {
132         ReportList *reports = CTX_wm_reports(C);
133
134         BLI_assert(!reports || BLI_listbase_is_empty(&reports->list));
135
136         BKE_reports_init(reports, RPT_STORE);
137 }
138 static void wm_free_reports(bContext *C)
139 {
140         ReportList *reports = CTX_wm_reports(C);
141
142         BKE_reports_clear(reports);
143 }
144
145 static void wm_undo_kill_callback(bContext *C)
146 {
147         WM_jobs_kill_all_except(CTX_wm_manager(C), CTX_wm_screen(C));
148 }
149
150 bool wm_start_with_console = false; /* used in creator.c */
151
152 /* only called once, for startup */
153 void WM_init(bContext *C, int argc, const char **argv)
154 {
155         
156         if (!G.background) {
157                 wm_ghost_init(C);   /* note: it assigns C to ghost! */
158                 wm_init_cursor_data();
159         }
160         GHOST_CreateSystemPaths();
161
162         BKE_addon_pref_type_init();
163
164         wm_operatortype_init();
165         WM_menutype_init();
166         WM_uilisttype_init();
167
168         BKE_undo_callback_wm_kill_jobs_set(wm_undo_kill_callback);
169
170         BKE_library_callback_free_window_manager_set(wm_close_and_free);   /* library.c */
171         BKE_library_callback_free_notifier_reference_set(WM_main_remove_notifier_reference);   /* library.c */
172         BKE_library_callback_remap_editor_id_reference_set(WM_main_remap_editor_id_reference);   /* library.c */
173         BKE_blender_callback_test_break_set(wm_window_testbreak); /* blender.c */
174         BKE_spacedata_callback_id_remap_set(ED_spacedata_id_remap); /* screen.c */
175         DAG_editors_update_cb(ED_render_id_flush_update,
176                               ED_render_scene_update,
177                               ED_render_scene_update_pre); /* depsgraph.c */
178         
179         ED_spacetypes_init();   /* editors/space_api/spacetype.c */
180         
181         ED_file_init();         /* for fsmenu */
182         ED_node_init_butfuncs();
183         
184         BLF_init(11, U.dpi); /* Please update source/gamengine/GamePlayer/GPG_ghost.cpp if you change this */
185         BLT_lang_init();
186
187         /* Enforce loading the UI for the initial homefile */
188         G.fileflags &= ~G_FILE_NO_UI;
189
190         /* reports cant be initialized before the wm,
191          * but keep before file reading, since that may report errors */
192         wm_init_reports(C);
193
194         /* get the default database, plus a wm */
195         wm_homefile_read(C, NULL, G.factory_startup, false, NULL, NULL);
196         
197
198         BLT_lang_set(NULL);
199
200         if (!G.background) {
201
202 #ifdef WITH_INPUT_NDOF
203                 /* sets 3D mouse deadzone */
204                 WM_ndof_deadzone_set(U.ndof_deadzone);
205 #endif
206
207                 GPU_init();
208
209                 GPU_set_mipmap(!(U.gameflags & USER_DISABLE_MIPMAP));
210                 GPU_set_linear_mipmap(true);
211                 GPU_set_anisotropic(U.anisotropic_filter);
212                 GPU_set_gpu_mipmapping(U.use_gpu_mipmap);
213
214 #ifdef WITH_OPENSUBDIV
215                 BKE_subsurf_osd_init();
216 #endif
217
218                 UI_init();
219         }
220         else {
221                 /* Note: Currently only inits icons, which we now want in background mode too
222                  * (scripts could use those in background processing...).
223                  * In case we do more later, we may need to pass a 'background' flag.
224                  * Called from 'UI_init' above */
225                 BKE_icons_init(1);
226         }
227
228
229         ED_spacemacros_init();
230
231         /* note: there is a bug where python needs initializing before loading the
232          * startup.blend because it may contain PyDrivers. It also needs to be after
233          * initializing space types and other internal data.
234          *
235          * However cant redo this at the moment. Solution is to load python
236          * before wm_homefile_read() or make py-drivers check if python is running.
237          * Will try fix when the crash can be repeated. - campbell. */
238
239 #ifdef WITH_PYTHON
240         BPY_context_set(C); /* necessary evil */
241         BPY_python_start(argc, argv);
242
243         BPY_python_reset(C);
244 #else
245         (void)argc; /* unused */
246         (void)argv; /* unused */
247 #endif
248
249         if (!G.background && !wm_start_with_console)
250                 GHOST_toggleConsole(3);
251
252         clear_matcopybuf();
253         ED_render_clear_mtex_copybuf();
254
255         // glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
256
257         wm_history_file_read();
258
259         /* allow a path of "", this is what happens when making a new file */
260 #if 0
261         if (G.main->name[0] == 0)
262                 BLI_make_file_string("/", G.main->name, BKE_appdir_folder_default(), "untitled.blend");
263 #endif
264
265         BLI_strncpy(G.lib, G.main->name, FILE_MAX);
266
267 #ifdef WITH_COMPOSITOR
268         if (1) {
269                 extern void *COM_linker_hack;
270                 COM_linker_hack = COM_execute;
271         }
272 #endif
273         
274         /* load last session, uses regular file reading so it has to be in end (after init py etc) */
275         if (U.uiflag2 & USER_KEEP_SESSION) {
276                 /* calling WM_recover_last_session(C, NULL) has been moved to creator.c */
277                 /* that prevents loading both the kept session, and the file on the command line */
278         }
279         else {
280                 /* note, logic here is from wm_file_read_post,
281                  * call functions that depend on Python being initialized. */
282
283                 /* normally 'wm_homefile_read' will do this,
284                  * however python is not initialized when called from this function.
285                  *
286                  * unlikely any handlers are set but its possible,
287                  * note that recovering the last session does its own callbacks. */
288                 CTX_wm_window_set(C, CTX_wm_manager(C)->windows.first);
289
290                 BLI_callback_exec(CTX_data_main(C), NULL, BLI_CB_EVT_VERSION_UPDATE);
291                 BLI_callback_exec(CTX_data_main(C), NULL, BLI_CB_EVT_LOAD_POST);
292
293                 wm_file_read_report(C);
294
295                 if (!G.background) {
296                         CTX_wm_window_set(C, NULL);
297                 }
298         }
299 }
300
301 void WM_init_splash(bContext *C)
302 {
303         if ((U.uiflag & USER_SPLASH_DISABLE) == 0) {
304                 wmWindowManager *wm = CTX_wm_manager(C);
305                 wmWindow *prevwin = CTX_wm_window(C);
306         
307                 if (wm->windows.first) {
308                         CTX_wm_window_set(C, wm->windows.first);
309                         WM_operator_name_call(C, "WM_OT_splash", WM_OP_INVOKE_DEFAULT, NULL);
310                         CTX_wm_window_set(C, prevwin);
311                 }
312         }
313 }
314
315 bool WM_init_game(bContext *C)
316 {
317         wmWindowManager *wm = CTX_wm_manager(C);
318         wmWindow *win;
319
320         ScrArea *sa;
321         ARegion *ar = NULL;
322
323         Scene *scene = CTX_data_scene(C);
324
325         if (!scene) {
326                 /* XXX, this should not be needed. */
327                 Main *bmain = CTX_data_main(C);
328                 scene = bmain->scene.first;
329         }
330
331         win = wm->windows.first;
332
333         /* first to get a valid window */
334         if (win)
335                 CTX_wm_window_set(C, win);
336
337         sa = BKE_screen_find_big_area(CTX_wm_screen(C), SPACE_VIEW3D, 0);
338         ar = BKE_area_find_region_type(sa, RGN_TYPE_WINDOW);
339
340         /* if we have a valid 3D view */
341         if (sa && ar) {
342                 ARegion *arhide;
343
344                 CTX_wm_area_set(C, sa);
345                 CTX_wm_region_set(C, ar);
346
347                 /* disable quad view */
348                 if (ar->alignment == RGN_ALIGN_QSPLIT)
349                         WM_operator_name_call(C, "SCREEN_OT_region_quadview", WM_OP_EXEC_DEFAULT, NULL);
350
351                 /* toolbox, properties panel and header are hidden */
352                 for (arhide = sa->regionbase.first; arhide; arhide = arhide->next) {
353                         if (arhide->regiontype != RGN_TYPE_WINDOW) {
354                                 if (!(arhide->flag & RGN_FLAG_HIDDEN)) {
355                                         ED_region_toggle_hidden(C, arhide);
356                                 }
357                         }
358                 }
359
360                 /* full screen the area */
361                 if (!sa->full) {
362                         ED_screen_state_toggle(C, win, sa, SCREENMAXIMIZED);
363                 }
364
365                 /* Fullscreen */
366                 if ((scene->gm.playerflag & GAME_PLAYER_FULLSCREEN)) {
367                         WM_operator_name_call(C, "WM_OT_window_fullscreen_toggle", WM_OP_EXEC_DEFAULT, NULL);
368                         wm_get_screensize(&ar->winrct.xmax, &ar->winrct.ymax);
369                         ar->winx = ar->winrct.xmax + 1;
370                         ar->winy = ar->winrct.ymax + 1;
371                 }
372                 else {
373                         GHOST_RectangleHandle rect = GHOST_GetClientBounds(win->ghostwin);
374                         ar->winrct.ymax = GHOST_GetHeightRectangle(rect);
375                         ar->winrct.xmax = GHOST_GetWidthRectangle(rect);
376                         ar->winx = ar->winrct.xmax + 1;
377                         ar->winy = ar->winrct.ymax + 1;
378                         GHOST_DisposeRectangle(rect);
379                 }
380
381                 WM_operator_name_call(C, "VIEW3D_OT_game_start", WM_OP_EXEC_DEFAULT, NULL);
382
383                 BKE_sound_exit();
384
385                 return true;
386         }
387         else {
388                 ReportTimerInfo *rti;
389
390                 BKE_report(&wm->reports, RPT_ERROR, "No valid 3D View found, game auto start is not possible");
391
392                 /* After adding the report to the global list, reset the report timer. */
393                 WM_event_remove_timer(wm, NULL, wm->reports.reporttimer);
394
395                 /* Records time since last report was added */
396                 wm->reports.reporttimer = WM_event_add_timer(wm, CTX_wm_window(C), TIMER, 0.02);
397
398                 rti = MEM_callocN(sizeof(ReportTimerInfo), "ReportTimerInfo");
399                 wm->reports.reporttimer->customdata = rti;
400
401                 return false;
402         }
403 }
404
405 /* free strings of open recent files */
406 static void free_openrecent(void)
407 {
408         struct RecentFile *recent;
409         
410         for (recent = G.recent_files.first; recent; recent = recent->next)
411                 MEM_freeN(recent->filepath);
412         
413         BLI_freelistN(&(G.recent_files));
414 }
415
416
417 #ifdef WIN32
418 /* Read console events until there is a key event.  Also returns on any error. */
419 static void wait_for_console_key(void)
420 {
421         HANDLE hConsoleInput = GetStdHandle(STD_INPUT_HANDLE);
422
423         if (!ELEM(hConsoleInput, NULL, INVALID_HANDLE_VALUE) && FlushConsoleInputBuffer(hConsoleInput)) {
424                 for (;;) {
425                         INPUT_RECORD buffer;
426                         DWORD ignored;
427
428                         if (!ReadConsoleInput(hConsoleInput, &buffer, 1, &ignored)) {
429                                 break;
430                         }
431
432                         if (buffer.EventType == KEY_EVENT) {
433                                 break;
434                         }
435                 }
436         }
437 }
438 #endif
439
440 /**
441  * \note doesn't run exit() call #WM_exit() for that.
442  */
443 void WM_exit_ext(bContext *C, const bool do_python)
444 {
445         wmWindowManager *wm = C ? CTX_wm_manager(C) : NULL;
446
447         /* first wrap up running stuff, we assume only the active WM is running */
448         /* modal handlers are on window level freed, others too? */
449         /* note; same code copied in wm_files.c */
450         if (C && wm) {
451                 wmWindow *win;
452
453                 if (!G.background) {
454                         if ((U.uiflag2 & USER_KEEP_SESSION) || BKE_undo_is_valid(NULL)) {
455                                 /* save the undo state as quit.blend */
456                                 char filename[FILE_MAX];
457                                 bool has_edited;
458                                 int fileflags = G.fileflags & ~(G_FILE_COMPRESS | G_FILE_AUTOPLAY | G_FILE_HISTORY);
459
460                                 BLI_make_file_string("/", filename, BKE_tempdir_base(), BLENDER_QUIT_FILE);
461
462                                 has_edited = ED_editors_flush_edits(C, false);
463
464                                 if ((has_edited && BLO_write_file(CTX_data_main(C), filename, fileflags, NULL, NULL)) ||
465                                     BKE_undo_save_file(filename))
466                                 {
467                                         printf("Saved session recovery to '%s'\n", filename);
468                                 }
469                         }
470                 }
471                 
472                 WM_jobs_kill_all(wm);
473
474                 for (win = wm->windows.first; win; win = win->next) {
475                         
476                         CTX_wm_window_set(C, win);  /* needed by operator close callbacks */
477                         WM_event_remove_handlers(C, &win->handlers);
478                         WM_event_remove_handlers(C, &win->modalhandlers);
479                         ED_screen_exit(C, win, win->screen);
480                 }
481         }
482
483         BKE_addon_pref_type_free();
484         wm_operatortype_free();
485         wm_dropbox_free();
486         WM_menutype_free();
487         WM_uilisttype_free();
488         
489         /* all non-screen and non-space stuff editors did, like editmode */
490         if (C)
491                 ED_editors_exit(C);
492
493 //      XXX     
494 //      BIF_GlobalReebFree();
495 //      BIF_freeRetarget();
496         BIF_freeTemplates(C);
497
498         free_openrecent();
499         
500         BKE_mball_cubeTable_free();
501         
502         /* render code might still access databases */
503         RE_FreeAllRender();
504         RE_engines_exit();
505         
506         ED_preview_free_dbase();  /* frees a Main dbase, before BKE_blender_free! */
507
508         if (C && wm)
509                 wm_free_reports(C);  /* before BKE_blender_free! - since the ListBases get freed there */
510
511         BKE_sequencer_free_clipboard(); /* sequencer.c */
512         BKE_tracking_clipboard_free();
513         BKE_mask_clipboard_free();
514         BKE_vfont_clipboard_free();
515                 
516 #ifdef WITH_COMPOSITOR
517         COM_deinitialize();
518 #endif
519         
520         BKE_blender_free();  /* blender.c, does entire library and spacetypes */
521 //      free_matcopybuf();
522         ANIM_fcurves_copybuf_free();
523         ANIM_drivers_copybuf_free();
524         ANIM_driver_vars_copybuf_free();
525         ANIM_fmodifiers_copybuf_free();
526         ED_gpencil_anim_copybuf_free();
527         ED_gpencil_strokes_copybuf_free();
528         BKE_node_clipboard_clear();
529
530         BLF_exit();
531
532 #ifdef WITH_INTERNATIONAL
533         BLF_free_unifont();
534         BLF_free_unifont_mono();
535         BLT_lang_free();
536 #endif
537         
538         ANIM_keyingset_infos_exit();
539         
540 //      free_txt_data();
541         
542
543 #ifdef WITH_PYTHON
544         /* option not to close python so we can use 'atexit' */
545         if (do_python && ((C == NULL) || CTX_py_init_get(C))) {
546                 /* XXX - old note */
547                 /* before BKE_blender_free so py's gc happens while library still exists */
548                 /* needed at least for a rare sigsegv that can happen in pydrivers */
549
550                 /* Update for blender 2.5, move after BKE_blender_free because blender now holds references to PyObject's
551                  * so decref'ing them after python ends causes bad problems every time
552                  * the pyDriver bug can be fixed if it happens again we can deal with it then */
553                 BPY_python_end();
554         }
555 #else
556         (void)do_python;
557 #endif
558
559         if (!G.background) {
560 #ifdef WITH_OPENSUBDIV
561                 BKE_subsurf_osd_cleanup();
562 #endif
563
564                 GPU_global_buffer_pool_free();
565                 GPU_free_unused_buffers();
566
567                 GPU_exit();
568         }
569
570         BKE_undo_reset();
571         
572         ED_file_exit(); /* for fsmenu */
573
574         UI_exit();
575         BKE_blender_userdef_free_data(&U);
576
577         RNA_exit(); /* should be after BPY_python_end so struct python slots are cleared */
578         
579         wm_ghost_exit();
580
581         CTX_free(C);
582 #ifdef WITH_GAMEENGINE
583         SYS_DeleteSystem(SYS_GetSystem());
584 #endif
585         
586         GHOST_DisposeSystemPaths();
587
588         DNA_sdna_current_free();
589
590         BLI_threadapi_exit();
591
592         /* No need to call this early, rather do it late so that other pieces of Blender using sound may exit cleanly,
593          * see also T50676. */
594         BKE_sound_exit();
595
596         BKE_blender_atexit();
597
598         if (MEM_get_memory_blocks_in_use() != 0) {
599                 size_t mem_in_use = MEM_get_memory_in_use() + MEM_get_memory_in_use();
600                 printf("Error: Not freed memory blocks: %u, total unfreed memory %f MB\n",
601                        MEM_get_memory_blocks_in_use(),
602                        (double)mem_in_use / 1024 / 1024);
603                 MEM_printmemlist();
604         }
605         wm_autosave_delete();
606
607         BKE_tempdir_session_purge();
608 }
609
610 void WM_exit(bContext *C)
611 {
612         WM_exit_ext(C, 1);
613
614         printf("\nBlender quit\n");
615
616 #ifdef WIN32
617         /* ask user to press a key when in debug mode */
618         if (G.debug & G_DEBUG) {
619                 printf("Press any key to exit . . .\n\n");
620                 wait_for_console_key();
621         }
622 #endif
623
624         exit(G.is_break == true);
625 }