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