UI: option not to show screen splitting widgets
[blender.git] / source / blender / blenkernel / intern / blender.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) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/blenkernel/intern/blender.c
29  *  \ingroup bke
30  *
31  * Application level startup/shutdown functionality.
32  */
33
34 #include <stdlib.h>
35 #include <stdio.h>
36 #include <string.h>
37
38 #include "MEM_guardedalloc.h"
39
40 #include "BLI_string.h"
41 #include "BLI_listbase.h"
42 #include "BLI_utildefines.h"
43 #include "BLI_callbacks.h"
44
45 #include "IMB_imbuf.h"
46 #include "IMB_moviecache.h"
47
48 #include "BKE_blender.h"  /* own include */
49 #include "BKE_blender_version.h"  /* own include */
50 #include "BKE_blendfile.h"
51 #include "BKE_brush.h"
52 #include "BKE_cachefile.h"
53 #include "BKE_context.h"
54 #include "BKE_depsgraph.h"
55 #include "BKE_global.h"
56 #include "BKE_idprop.h"
57 #include "BKE_image.h"
58 #include "BKE_library.h"
59 #include "BKE_node.h"
60 #include "BKE_report.h"
61 #include "BKE_scene.h"
62 #include "BKE_screen.h"
63 #include "BKE_sequencer.h"
64
65 #include "RE_pipeline.h"
66 #include "RE_render_ext.h"
67
68 #include "BLF_api.h"
69
70
71 Global G;
72 UserDef U;
73
74 char versionstr[48] = "";
75
76 /* ********** free ********** */
77
78 /* only to be called on exit blender */
79 void BKE_blender_free(void)
80 {
81         /* samples are in a global list..., also sets G.main->sound->sample NULL */
82         BKE_main_free(G.main);
83         G.main = NULL;
84
85         BKE_spacetypes_free();      /* after free main, it uses space callbacks */
86         
87         IMB_exit();
88         BKE_cachefiles_exit();
89         BKE_images_exit();
90         DAG_exit();
91
92         BKE_brush_system_exit();
93         RE_texture_rng_exit();  
94
95         BLI_callback_global_finalize();
96
97         BKE_sequencer_cache_destruct();
98         IMB_moviecache_destruct();
99         
100         free_nodesystem();
101 }
102
103 void BKE_blender_version_string(char *version_str, size_t maxncpy, short version, short subversion, bool v_prefix, bool include_subversion)
104 {
105         const char *prefix = v_prefix ? "v" : "";
106
107         if (include_subversion && subversion > 0) {
108                 BLI_snprintf(version_str, maxncpy, "%s%d.%02d.%d", prefix, version / 100, version % 100, subversion);
109         }
110         else {
111                 BLI_snprintf(version_str, maxncpy, "%s%d.%02d", prefix, version / 100, version % 100);
112         }
113 }
114
115 void BKE_blender_globals_init(void)
116 {
117         memset(&G, 0, sizeof(Global));
118         
119         U.savetime = 1;
120
121         G.main = BKE_main_new();
122
123         strcpy(G.ima, "//");
124
125         BKE_blender_version_string(versionstr, sizeof(versionstr), BLENDER_VERSION, BLENDER_SUBVERSION, true, true);
126
127 #ifndef WITH_PYTHON_SECURITY /* default */
128         G.f |= G_SCRIPT_AUTOEXEC;
129 #else
130         G.f &= ~G_SCRIPT_AUTOEXEC;
131 #endif
132 }
133
134 void BKE_blender_globals_clear(void)
135 {
136         BKE_main_free(G.main);          /* free all lib data */
137
138         G.main = NULL;
139 }
140
141 /***/
142
143 static void keymap_item_free(wmKeyMapItem *kmi)
144 {
145         if (kmi->properties) {
146                 IDP_FreeProperty(kmi->properties);
147                 MEM_freeN(kmi->properties);
148         }
149         if (kmi->ptr)
150                 MEM_freeN(kmi->ptr);
151 }
152
153 void BKE_blender_userdef_data_swap(UserDef *userdef_a, UserDef *userdef_b)
154 {
155         SWAP(UserDef, *userdef_a, *userdef_b);
156 }
157
158 void BKE_blender_userdef_data_set(UserDef *userdef)
159 {
160         BKE_blender_userdef_data_swap(&U, userdef);
161         BKE_blender_userdef_data_free(userdef, true);
162 }
163
164 void BKE_blender_userdef_data_set_and_free(UserDef *userdef)
165 {
166         BKE_blender_userdef_data_set(userdef);
167         MEM_freeN(userdef);
168 }
169
170 static void userdef_free_keymaps(UserDef *userdef)
171 {
172         for (wmKeyMap *km = userdef->user_keymaps.first, *km_next; km; km = km_next) {
173                 km_next = km->next;
174                 for (wmKeyMapDiffItem *kmdi = km->diff_items.first; kmdi; kmdi = kmdi->next) {
175                         if (kmdi->add_item) {
176                                 keymap_item_free(kmdi->add_item);
177                                 MEM_freeN(kmdi->add_item);
178                         }
179                         if (kmdi->remove_item) {
180                                 keymap_item_free(kmdi->remove_item);
181                                 MEM_freeN(kmdi->remove_item);
182                         }
183                 }
184
185                 for (wmKeyMapItem *kmi = km->items.first; kmi; kmi = kmi->next) {
186                         keymap_item_free(kmi);
187                 }
188
189                 BLI_freelistN(&km->diff_items);
190                 BLI_freelistN(&km->items);
191
192                 MEM_freeN(km);
193         }
194         BLI_listbase_clear(&userdef->user_keymaps);
195 }
196
197 static void userdef_free_addons(UserDef *userdef)
198 {
199         for (bAddon *addon = userdef->addons.first, *addon_next; addon; addon = addon_next) {
200                 addon_next = addon->next;
201                 if (addon->prop) {
202                         IDP_FreeProperty(addon->prop);
203                         MEM_freeN(addon->prop);
204                 }
205                 MEM_freeN(addon);
206         }
207         BLI_listbase_clear(&userdef->addons);
208 }
209
210 /**
211  * When loading a new userdef from file,
212  * or when exiting Blender.
213  */
214 void BKE_blender_userdef_data_free(UserDef *userdef, bool clear_fonts)
215 {
216 #define U _invalid_access_ /* ensure no accidental global access */
217 #ifdef U  /* quiet warning */
218 #endif
219
220         userdef_free_keymaps(userdef);
221         userdef_free_addons(userdef);
222
223         if (clear_fonts) {
224                 for (uiFont *font = userdef->uifonts.first; font; font = font->next) {
225                         BLF_unload_id(font->blf_id);
226                 }
227                 BLF_default_set(-1);
228         }
229
230         BLI_freelistN(&userdef->autoexec_paths);
231
232         BLI_freelistN(&userdef->uistyles);
233         BLI_freelistN(&userdef->uifonts);
234         BLI_freelistN(&userdef->themes);
235
236 #undef U
237 }
238
239 /**
240  * Write U from userdef.
241  * This function defines which settings a template will override for the user preferences.
242  */
243 void BKE_blender_userdef_app_template_data_swap(UserDef *userdef_a, UserDef *userdef_b)
244 {
245         /* TODO:
246          * - various minor settings (add as needed).
247          */
248
249 #define DATA_SWAP(id) \
250         { \
251                 UserDef userdef_tmp; \
252                 memcpy(&(userdef_tmp.id), &(userdef_a->id), sizeof(userdef_tmp.id)); \
253                 memcpy(&(userdef_a->id), &(userdef_b->id), sizeof(userdef_tmp.id)); \
254                 memcpy(&(userdef_b->id), &(userdef_tmp.id), sizeof(userdef_tmp.id)); \
255         }
256
257 #define LIST_SWAP(id) { \
258         SWAP(ListBase, userdef_a->id, userdef_b->id); \
259 } ((void)0)
260
261 #define FLAG_SWAP(id, ty, flags) { \
262         CHECK_TYPE(&(userdef_a->id), ty *); \
263         const ty f = flags; \
264         const ty a = userdef_a->id; \
265         const ty b = userdef_b->id; \
266          userdef_a->id = (userdef_a->id & ~f) | (b & f); \
267          userdef_b->id = (userdef_b->id & ~f) | (a & f); \
268 } ((void)0)
269
270
271         LIST_SWAP(uistyles);
272         LIST_SWAP(uifonts);
273         LIST_SWAP(themes);
274         LIST_SWAP(addons);
275         LIST_SWAP(user_keymaps);
276
277         DATA_SWAP(light);
278
279         DATA_SWAP(font_path_ui);
280         DATA_SWAP(font_path_ui_mono);
281         DATA_SWAP(keyconfigstr);
282
283         FLAG_SWAP(uiflag, int, USER_LOCK_UI_LAYOUT);
284
285 #undef DATA_SWAP
286 #undef LIST_SWAP
287 #undef FLAG_SWAP
288 }
289
290 void BKE_blender_userdef_app_template_data_set(UserDef *userdef)
291 {
292         BKE_blender_userdef_app_template_data_swap(&U, userdef);
293         BKE_blender_userdef_data_free(userdef, true);
294 }
295
296 void BKE_blender_userdef_app_template_data_set_and_free(UserDef *userdef)
297 {
298         BKE_blender_userdef_app_template_data_set(userdef);
299         MEM_freeN(userdef);
300 }
301
302 /* *****************  testing for break ************* */
303
304 static void (*blender_test_break_cb)(void) = NULL;
305
306 void BKE_blender_callback_test_break_set(void (*func)(void))
307 {
308         blender_test_break_cb = func;
309 }
310
311
312 int BKE_blender_test_break(void)
313 {
314         if (!G.background) {
315                 if (blender_test_break_cb)
316                         blender_test_break_cb();
317         }
318         
319         return (G.is_break == true);
320 }
321
322
323 /** \name Blender's AtExit
324  *
325  * \note Don't use MEM_mallocN so functions can be registered at any time.
326  * \{ */
327
328 static struct AtExitData {
329         struct AtExitData *next;
330
331         void (*func)(void *user_data);
332         void *user_data;
333 } *g_atexit = NULL;
334
335 void BKE_blender_atexit_register(void (*func)(void *user_data), void *user_data)
336 {
337         struct AtExitData *ae = malloc(sizeof(*ae));
338         ae->next = g_atexit;
339         ae->func = func;
340         ae->user_data = user_data;
341         g_atexit = ae;
342 }
343
344 void BKE_blender_atexit_unregister(void (*func)(void *user_data), const void *user_data)
345 {
346         struct AtExitData *ae = g_atexit;
347         struct AtExitData **ae_p = &g_atexit;
348
349         while (ae) {
350                 if ((ae->func == func) && (ae->user_data == user_data)) {
351                         *ae_p = ae->next;
352                         free(ae);
353                         return;
354                 }
355                 ae_p = &ae;
356                 ae = ae->next;
357         }
358 }
359
360 void BKE_blender_atexit(void)
361 {
362         struct AtExitData *ae = g_atexit, *ae_next;
363         while (ae) {
364                 ae_next = ae->next;
365
366                 ae->func(ae->user_data);
367
368                 free(ae);
369                 ae = ae_next;
370         }
371         g_atexit = NULL;
372 }
373
374 /** \} */