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