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