Merge branch 'master' into blender2.8
[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_global.h"
55 #include "BKE_idprop.h"
56 #include "BKE_image.h"
57 #include "BKE_layer.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 "DEG_depsgraph.h"
66
67 #include "RE_pipeline.h"
68 #include "RE_render_ext.h"
69
70 #include "BLF_api.h"
71
72
73 Global G;
74 UserDef U;
75
76 char versionstr[48] = "";
77
78 /* ********** free ********** */
79
80 /* only to be called on exit blender */
81 void BKE_blender_free(void)
82 {
83         /* samples are in a global list..., also sets G.main->sound->sample NULL */
84         BKE_main_free(G.main);
85         G.main = NULL;
86
87         BKE_spacetypes_free();      /* after free main, it uses space callbacks */
88         
89         IMB_exit();
90         BKE_cachefiles_exit();
91         BKE_images_exit();
92         DEG_free_node_types();
93
94         BKE_brush_system_exit();
95         RE_texture_rng_exit();  
96
97         BLI_callback_global_finalize();
98
99         BKE_sequencer_cache_destruct();
100         IMB_moviecache_destruct();
101
102         BKE_layer_exit();
103         
104         free_nodesystem();
105 }
106
107 void BKE_blender_version_string(char *version_str, size_t maxncpy, short version, short subversion, bool v_prefix, bool include_subversion)
108 {
109         const char *prefix = v_prefix ? "v" : "";
110
111         if (include_subversion && subversion > 0) {
112                 BLI_snprintf(version_str, maxncpy, "%s%d.%02d.%d", prefix, version / 100, version % 100, subversion);
113         }
114         else {
115                 BLI_snprintf(version_str, maxncpy, "%s%d.%02d", prefix, version / 100, version % 100);
116         }
117 }
118
119 void BKE_blender_globals_init(void)
120 {
121         memset(&G, 0, sizeof(Global));
122         
123         U.savetime = 1;
124
125         G.main = BKE_main_new();
126
127         strcpy(G.ima, "//");
128
129         BKE_blender_version_string(versionstr, sizeof(versionstr), BLENDER_VERSION, BLENDER_SUBVERSION, true, true);
130
131 #ifndef WITH_PYTHON_SECURITY /* default */
132         G.f |= G_SCRIPT_AUTOEXEC;
133 #else
134         G.f &= ~G_SCRIPT_AUTOEXEC;
135 #endif
136 }
137
138 void BKE_blender_globals_clear(void)
139 {
140         BKE_main_free(G.main);          /* free all lib data */
141
142         G.main = NULL;
143 }
144
145 /***/
146
147 static void keymap_item_free(wmKeyMapItem *kmi)
148 {
149         if (kmi->properties) {
150                 IDP_FreeProperty(kmi->properties);
151                 MEM_freeN(kmi->properties);
152         }
153         if (kmi->ptr)
154                 MEM_freeN(kmi->ptr);
155 }
156
157 void BKE_blender_userdef_set_data(UserDef *userdef)
158 {
159         /* only here free userdef themes... */
160         BKE_blender_userdef_free_data(&U);
161         U = *userdef;
162 }
163
164 static void userdef_free_keymaps(UserDef *userdef)
165 {
166         for (wmKeyMap *km = userdef->user_keymaps.first, *km_next; km; km = km_next) {
167                 km_next = km->next;
168                 for (wmKeyMapDiffItem *kmdi = km->diff_items.first; kmdi; kmdi = kmdi->next) {
169                         if (kmdi->add_item) {
170                                 keymap_item_free(kmdi->add_item);
171                                 MEM_freeN(kmdi->add_item);
172                         }
173                         if (kmdi->remove_item) {
174                                 keymap_item_free(kmdi->remove_item);
175                                 MEM_freeN(kmdi->remove_item);
176                         }
177                 }
178
179                 for (wmKeyMapItem *kmi = km->items.first; kmi; kmi = kmi->next) {
180                         keymap_item_free(kmi);
181                 }
182
183                 BLI_freelistN(&km->diff_items);
184                 BLI_freelistN(&km->items);
185
186                 MEM_freeN(km);
187         }
188         BLI_listbase_clear(&userdef->user_keymaps);
189 }
190
191 static void userdef_free_addons(UserDef *userdef)
192 {
193         for (bAddon *addon = userdef->addons.first, *addon_next; addon; addon = addon_next) {
194                 addon_next = addon->next;
195                 if (addon->prop) {
196                         IDP_FreeProperty(addon->prop);
197                         MEM_freeN(addon->prop);
198                 }
199                 MEM_freeN(addon);
200         }
201         BLI_listbase_clear(&userdef->addons);
202 }
203
204 /**
205  * When loading a new userdef from file,
206  * or when exiting Blender.
207  */
208 void BKE_blender_userdef_free_data(UserDef *userdef)
209 {
210 #define U _invalid_access_ /* ensure no accidental global access */
211 #ifdef U  /* quiet warning */
212 #endif
213
214         userdef_free_keymaps(userdef);
215         userdef_free_addons(userdef);
216
217         for (uiFont *font = userdef->uifonts.first; font; font = font->next) {
218                 BLF_unload_id(font->blf_id);
219         }
220
221         BLF_default_set(-1);
222
223         BLI_freelistN(&userdef->autoexec_paths);
224
225         BLI_freelistN(&userdef->uistyles);
226         BLI_freelistN(&userdef->uifonts);
227         BLI_freelistN(&userdef->themes);
228
229 #undef U
230 }
231
232 /**
233  * Write U from userdef.
234  * This function defines which settings a template will override for the user preferences.
235  */
236 void BKE_blender_userdef_set_app_template(UserDef *userdef)
237 {
238         /* TODO:
239          * - keymaps
240          * - various minor settings (add as needed).
241          */
242
243 #define LIST_OVERRIDE(id) { \
244         BLI_freelistN(&U.id); \
245         BLI_movelisttolist(&U.id, &userdef->id); \
246 } ((void)0)
247
248 #define MEMCPY_OVERRIDE(id) \
249         memcpy(U.id, userdef->id, sizeof(U.id));
250
251         /* for some types we need custom free functions */
252         userdef_free_addons(&U);
253         userdef_free_keymaps(&U);
254
255         LIST_OVERRIDE(uistyles);
256         LIST_OVERRIDE(uifonts);
257         LIST_OVERRIDE(themes);
258         LIST_OVERRIDE(addons);
259         LIST_OVERRIDE(user_keymaps);
260
261         MEMCPY_OVERRIDE(light);
262
263         MEMCPY_OVERRIDE(font_path_ui);
264         MEMCPY_OVERRIDE(font_path_ui_mono);
265
266 #undef LIST_OVERRIDE
267 #undef MEMCPY_OVERRIDE
268 }
269
270 /* *****************  testing for break ************* */
271
272 static void (*blender_test_break_cb)(void) = NULL;
273
274 void BKE_blender_callback_test_break_set(void (*func)(void))
275 {
276         blender_test_break_cb = func;
277 }
278
279
280 int BKE_blender_test_break(void)
281 {
282         if (!G.background) {
283                 if (blender_test_break_cb)
284                         blender_test_break_cb();
285         }
286         
287         return (G.is_break == true);
288 }
289
290
291 /** \name Blender's AtExit
292  *
293  * \note Don't use MEM_mallocN so functions can be registered at any time.
294  * \{ */
295
296 static struct AtExitData {
297         struct AtExitData *next;
298
299         void (*func)(void *user_data);
300         void *user_data;
301 } *g_atexit = NULL;
302
303 void BKE_blender_atexit_register(void (*func)(void *user_data), void *user_data)
304 {
305         struct AtExitData *ae = malloc(sizeof(*ae));
306         ae->next = g_atexit;
307         ae->func = func;
308         ae->user_data = user_data;
309         g_atexit = ae;
310 }
311
312 void BKE_blender_atexit_unregister(void (*func)(void *user_data), const void *user_data)
313 {
314         struct AtExitData *ae = g_atexit;
315         struct AtExitData **ae_p = &g_atexit;
316
317         while (ae) {
318                 if ((ae->func == func) && (ae->user_data == user_data)) {
319                         *ae_p = ae->next;
320                         free(ae);
321                         return;
322                 }
323                 ae_p = &ae;
324                 ae = ae->next;
325         }
326 }
327
328 void BKE_blender_atexit(void)
329 {
330         struct AtExitData *ae = g_atexit, *ae_next;
331         while (ae) {
332                 ae_next = ae->next;
333
334                 ae->func(ae->user_data);
335
336                 free(ae);
337                 ae = ae_next;
338         }
339         g_atexit = NULL;
340 }
341
342 /** \} */