Fix build error on Windows 32 bit.
[blender-staging.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(); /* Please update source/gamengine/GamePlayer/GPG_ghost.cpp if you change this */
185         BLT_lang_init();
186
187         /* reports cant be initialized before the wm,
188          * but keep before file reading, since that may report errors */
189         wm_init_reports(C);
190
191         /* get the default database, plus a wm */
192         wm_homefile_read(C, NULL, G.factory_startup, false, true, NULL, NULL);
193         
194
195         BLT_lang_set(NULL);
196
197         if (!G.background) {
198
199 #ifdef WITH_INPUT_NDOF
200                 /* sets 3D mouse deadzone */
201                 WM_ndof_deadzone_set(U.ndof_deadzone);
202 #endif
203
204                 GPU_init();
205
206                 GPU_set_mipmap(!(U.gameflags & USER_DISABLE_MIPMAP));
207                 GPU_set_linear_mipmap(true);
208                 GPU_set_anisotropic(U.anisotropic_filter);
209                 GPU_set_gpu_mipmapping(U.use_gpu_mipmap);
210
211 #ifdef WITH_OPENSUBDIV
212                 BKE_subsurf_osd_init();
213 #endif
214
215                 UI_init();
216         }
217         else {
218                 /* Note: Currently only inits icons, which we now want in background mode too
219                  * (scripts could use those in background processing...).
220                  * In case we do more later, we may need to pass a 'background' flag.
221                  * Called from 'UI_init' above */
222                 BKE_icons_init(1);
223         }
224
225
226         ED_spacemacros_init();
227
228         /* note: there is a bug where python needs initializing before loading the
229          * startup.blend because it may contain PyDrivers. It also needs to be after
230          * initializing space types and other internal data.
231          *
232          * However cant redo this at the moment. Solution is to load python
233          * before wm_homefile_read() or make py-drivers check if python is running.
234          * Will try fix when the crash can be repeated. - campbell. */
235
236 #ifdef WITH_PYTHON
237         BPY_context_set(C); /* necessary evil */
238         BPY_python_start(argc, argv);
239
240         BPY_python_reset(C);
241 #else
242         (void)argc; /* unused */
243         (void)argv; /* unused */
244 #endif
245
246         if (!G.background && !wm_start_with_console)
247                 GHOST_toggleConsole(3);
248
249         clear_matcopybuf();
250         ED_render_clear_mtex_copybuf();
251
252         // glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
253
254         wm_history_file_read();
255
256         /* allow a path of "", this is what happens when making a new file */
257 #if 0
258         if (G.main->name[0] == 0)
259                 BLI_make_file_string("/", G.main->name, BKE_appdir_folder_default(), "untitled.blend");
260 #endif
261
262         BLI_strncpy(G.lib, G.main->name, FILE_MAX);
263
264 #ifdef WITH_COMPOSITOR
265         if (1) {
266                 extern void *COM_linker_hack;
267                 COM_linker_hack = COM_execute;
268         }
269 #endif
270         
271         /* load last session, uses regular file reading so it has to be in end (after init py etc) */
272         if (U.uiflag2 & USER_KEEP_SESSION) {
273                 /* calling WM_recover_last_session(C, NULL) has been moved to creator.c */
274                 /* that prevents loading both the kept session, and the file on the command line */
275         }
276         else {
277                 /* note, logic here is from wm_file_read_post,
278                  * call functions that depend on Python being initialized. */
279
280                 /* normally 'wm_homefile_read' will do this,
281                  * however python is not initialized when called from this function.
282                  *
283                  * unlikely any handlers are set but its possible,
284                  * note that recovering the last session does its own callbacks. */
285                 CTX_wm_window_set(C, CTX_wm_manager(C)->windows.first);
286
287                 BLI_callback_exec(CTX_data_main(C), NULL, BLI_CB_EVT_VERSION_UPDATE);
288                 BLI_callback_exec(CTX_data_main(C), NULL, BLI_CB_EVT_LOAD_POST);
289
290                 wm_file_read_report(C);
291
292                 if (!G.background) {
293                         CTX_wm_window_set(C, NULL);
294                 }
295         }
296 }
297
298 void WM_init_splash(bContext *C)
299 {
300         if ((U.uiflag & USER_SPLASH_DISABLE) == 0) {
301                 wmWindowManager *wm = CTX_wm_manager(C);
302                 wmWindow *prevwin = CTX_wm_window(C);
303         
304                 if (wm->windows.first) {
305                         CTX_wm_window_set(C, wm->windows.first);
306                         WM_operator_name_call(C, "WM_OT_splash", WM_OP_INVOKE_DEFAULT, NULL);
307                         CTX_wm_window_set(C, prevwin);
308                 }
309         }
310 }
311
312 bool WM_init_game(bContext *C)
313 {
314         wmWindowManager *wm = CTX_wm_manager(C);
315         wmWindow *win;
316
317         ScrArea *sa;
318         ARegion *ar = NULL;
319
320         Scene *scene = CTX_data_scene(C);
321
322         if (!scene) {
323                 /* XXX, this should not be needed. */
324                 Main *bmain = CTX_data_main(C);
325                 scene = bmain->scene.first;
326         }
327
328         win = wm->windows.first;
329
330         /* first to get a valid window */
331         if (win)
332                 CTX_wm_window_set(C, win);
333
334         sa = BKE_screen_find_big_area(CTX_wm_screen(C), SPACE_VIEW3D, 0);
335         ar = BKE_area_find_region_type(sa, RGN_TYPE_WINDOW);
336
337         /* if we have a valid 3D view */
338         if (sa && ar) {
339                 ARegion *arhide;
340
341                 CTX_wm_area_set(C, sa);
342                 CTX_wm_region_set(C, ar);
343
344                 /* disable quad view */
345                 if (ar->alignment == RGN_ALIGN_QSPLIT)
346                         WM_operator_name_call(C, "SCREEN_OT_region_quadview", WM_OP_EXEC_DEFAULT, NULL);
347
348                 /* toolbox, properties panel and header are hidden */
349                 for (arhide = sa->regionbase.first; arhide; arhide = arhide->next) {
350                         if (arhide->regiontype != RGN_TYPE_WINDOW) {
351                                 if (!(arhide->flag & RGN_FLAG_HIDDEN)) {
352                                         ED_region_toggle_hidden(C, arhide);
353                                 }
354                         }
355                 }
356
357                 /* full screen the area */
358                 if (!sa->full) {
359                         ED_screen_state_toggle(C, win, sa, SCREENMAXIMIZED);
360                 }
361
362                 /* Fullscreen */
363                 if ((scene->gm.playerflag & GAME_PLAYER_FULLSCREEN)) {
364                         WM_operator_name_call(C, "WM_OT_window_fullscreen_toggle", WM_OP_EXEC_DEFAULT, NULL);
365                         wm_get_screensize(&ar->winrct.xmax, &ar->winrct.ymax);
366                         ar->winx = ar->winrct.xmax + 1;
367                         ar->winy = ar->winrct.ymax + 1;
368                 }
369                 else {
370                         GHOST_RectangleHandle rect = GHOST_GetClientBounds(win->ghostwin);
371                         ar->winrct.ymax = GHOST_GetHeightRectangle(rect);
372                         ar->winrct.xmax = GHOST_GetWidthRectangle(rect);
373                         ar->winx = ar->winrct.xmax + 1;
374                         ar->winy = ar->winrct.ymax + 1;
375                         GHOST_DisposeRectangle(rect);
376                 }
377
378                 WM_operator_name_call(C, "VIEW3D_OT_game_start", WM_OP_EXEC_DEFAULT, NULL);
379
380                 BKE_sound_exit();
381
382                 return true;
383         }
384         else {
385                 ReportTimerInfo *rti;
386
387                 BKE_report(&wm->reports, RPT_ERROR, "No valid 3D View found, game auto start is not possible");
388
389                 /* After adding the report to the global list, reset the report timer. */
390                 WM_event_remove_timer(wm, NULL, wm->reports.reporttimer);
391
392                 /* Records time since last report was added */
393                 wm->reports.reporttimer = WM_event_add_timer(wm, CTX_wm_window(C), TIMER, 0.02);
394
395                 rti = MEM_callocN(sizeof(ReportTimerInfo), "ReportTimerInfo");
396                 wm->reports.reporttimer->customdata = rti;
397
398                 return false;
399         }
400 }
401
402 /* free strings of open recent files */
403 static void free_openrecent(void)
404 {
405         struct RecentFile *recent;
406         
407         for (recent = G.recent_files.first; recent; recent = recent->next)
408                 MEM_freeN(recent->filepath);
409         
410         BLI_freelistN(&(G.recent_files));
411 }
412
413
414 #ifdef WIN32
415 /* Read console events until there is a key event.  Also returns on any error. */
416 static void wait_for_console_key(void)
417 {
418         HANDLE hConsoleInput = GetStdHandle(STD_INPUT_HANDLE);
419
420         if (!ELEM(hConsoleInput, NULL, INVALID_HANDLE_VALUE) && FlushConsoleInputBuffer(hConsoleInput)) {
421                 for (;;) {
422                         INPUT_RECORD buffer;
423                         DWORD ignored;
424
425                         if (!ReadConsoleInput(hConsoleInput, &buffer, 1, &ignored)) {
426                                 break;
427                         }
428
429                         if (buffer.EventType == KEY_EVENT) {
430                                 break;
431                         }
432                 }
433         }
434 }
435 #endif
436
437 /**
438  * \note doesn't run exit() call #WM_exit() for that.
439  */
440 void WM_exit_ext(bContext *C, const bool do_python)
441 {
442         wmWindowManager *wm = C ? CTX_wm_manager(C) : NULL;
443
444         /* first wrap up running stuff, we assume only the active WM is running */
445         /* modal handlers are on window level freed, others too? */
446         /* note; same code copied in wm_files.c */
447         if (C && wm) {
448                 wmWindow *win;
449
450                 if (!G.background) {
451                         if ((U.uiflag2 & USER_KEEP_SESSION) || BKE_undo_is_valid(NULL)) {
452                                 /* save the undo state as quit.blend */
453                                 char filename[FILE_MAX];
454                                 bool has_edited;
455                                 int fileflags = G.fileflags & ~(G_FILE_COMPRESS | G_FILE_AUTOPLAY | G_FILE_HISTORY);
456
457                                 BLI_make_file_string("/", filename, BKE_tempdir_base(), BLENDER_QUIT_FILE);
458
459                                 has_edited = ED_editors_flush_edits(C, false);
460
461                                 if ((has_edited && BLO_write_file(CTX_data_main(C), filename, fileflags, NULL, NULL)) ||
462                                     BKE_undo_save_file(filename))
463                                 {
464                                         printf("Saved session recovery to '%s'\n", filename);
465                                 }
466                         }
467                 }
468                 
469                 WM_jobs_kill_all(wm);
470
471                 for (win = wm->windows.first; win; win = win->next) {
472                         
473                         CTX_wm_window_set(C, win);  /* needed by operator close callbacks */
474                         WM_event_remove_handlers(C, &win->handlers);
475                         WM_event_remove_handlers(C, &win->modalhandlers);
476                         ED_screen_exit(C, win, win->screen);
477                 }
478         }
479
480         BKE_addon_pref_type_free();
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                 ED_editors_exit(C);
489
490 //      XXX     
491 //      BIF_GlobalReebFree();
492 //      BIF_freeRetarget();
493         BIF_freeTemplates(C);
494
495         free_openrecent();
496         
497         BKE_mball_cubeTable_free();
498         
499         /* render code might still access databases */
500         RE_FreeAllRender();
501         RE_engines_exit();
502         
503         ED_preview_free_dbase();  /* frees a Main dbase, before BKE_blender_free! */
504
505         if (C && wm)
506                 wm_free_reports(C);  /* before BKE_blender_free! - since the ListBases get freed there */
507
508         BKE_sequencer_free_clipboard(); /* sequencer.c */
509         BKE_tracking_clipboard_free();
510         BKE_mask_clipboard_free();
511         BKE_vfont_clipboard_free();
512                 
513 #ifdef WITH_COMPOSITOR
514         COM_deinitialize();
515 #endif
516         
517         BKE_blender_free();  /* blender.c, does entire library and spacetypes */
518 //      free_matcopybuf();
519         ANIM_fcurves_copybuf_free();
520         ANIM_drivers_copybuf_free();
521         ANIM_driver_vars_copybuf_free();
522         ANIM_fmodifiers_copybuf_free();
523         ED_gpencil_anim_copybuf_free();
524         ED_gpencil_strokes_copybuf_free();
525         BKE_node_clipboard_clear();
526
527         BLF_exit();
528
529 #ifdef WITH_INTERNATIONAL
530         BLF_free_unifont();
531         BLF_free_unifont_mono();
532         BLT_lang_free();
533 #endif
534         
535         ANIM_keyingset_infos_exit();
536         
537 //      free_txt_data();
538         
539
540 #ifdef WITH_PYTHON
541         /* option not to close python so we can use 'atexit' */
542         if (do_python && ((C == NULL) || CTX_py_init_get(C))) {
543                 /* XXX - old note */
544                 /* before BKE_blender_free so py's gc happens while library still exists */
545                 /* needed at least for a rare sigsegv that can happen in pydrivers */
546
547                 /* Update for blender 2.5, move after BKE_blender_free because blender now holds references to PyObject's
548                  * so decref'ing them after python ends causes bad problems every time
549                  * the pyDriver bug can be fixed if it happens again we can deal with it then */
550                 BPY_python_end();
551         }
552 #else
553         (void)do_python;
554 #endif
555
556         if (!G.background) {
557 #ifdef WITH_OPENSUBDIV
558                 BKE_subsurf_osd_cleanup();
559 #endif
560
561                 GPU_global_buffer_pool_free();
562                 GPU_free_unused_buffers();
563
564                 GPU_exit();
565         }
566
567         BKE_undo_reset();
568         
569         ED_file_exit(); /* for fsmenu */
570
571         UI_exit();
572         BKE_blender_userdef_data_free(&U, false);
573
574         RNA_exit(); /* should be after BPY_python_end so struct python slots are cleared */
575         
576         wm_ghost_exit();
577
578         CTX_free(C);
579 #ifdef WITH_GAMEENGINE
580         SYS_DeleteSystem(SYS_GetSystem());
581 #endif
582         
583         GHOST_DisposeSystemPaths();
584
585         DNA_sdna_current_free();
586
587         BLI_threadapi_exit();
588
589         /* No need to call this early, rather do it late so that other pieces of Blender using sound may exit cleanly,
590          * see also T50676. */
591         BKE_sound_exit();
592
593         BKE_blender_atexit();
594
595         if (MEM_get_memory_blocks_in_use() != 0) {
596                 size_t mem_in_use = MEM_get_memory_in_use() + MEM_get_memory_in_use();
597                 printf("Error: Not freed memory blocks: %u, total unfreed memory %f MB\n",
598                        MEM_get_memory_blocks_in_use(),
599                        (double)mem_in_use / 1024 / 1024);
600                 MEM_printmemlist();
601         }
602         wm_autosave_delete();
603
604         BKE_tempdir_session_purge();
605 }
606
607 void WM_exit(bContext *C)
608 {
609         WM_exit_ext(C, 1);
610
611         printf("\nBlender quit\n");
612
613 #ifdef WIN32
614         /* ask user to press a key when in debug mode */
615         if (G.debug & G_DEBUG) {
616                 printf("Press any key to exit . . .\n\n");
617                 wait_for_console_key();
618         }
619 #endif
620
621         exit(G.is_break == true);
622 }