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