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