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