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
  67 Global G;
  68 UserDef U;
  69
  70 char versionstr[48] = "";
  71
  72 /* ********** free ********** */
  73
  74 /* only to be called on exit blender */
  75 void BKE_blender_free(void)
  76 {
  77         /* samples are in a global list..., also sets G_MAIN->sound->sample NULL */
  78
  79         BKE_studiolight_free(); /* needs to run before main free as wm is still referenced for icons preview jobs */
  80         BKE_main_free(G_MAIN);
  81         G_MAIN = NULL;
  82
  83         if (G.log.file != NULL) {
  84                 fclose(G.log.file);
  85         }
  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         free_nodesystem();
 103 }
 104
 105 void BKE_blender_version_string(char *version_str, size_t maxncpy, short version, short subversion, bool v_prefix, bool include_subversion)
 106 {
 107         const char *prefix = v_prefix ? "v" : "";
 108
 109         if (include_subversion && subversion > 0) {
 110                 BLI_snprintf(version_str, maxncpy, "%s%d.%02d.%d", prefix, version / 100, version % 100, subversion);
 111         }
 112         else {
 113                 BLI_snprintf(version_str, maxncpy, "%s%d.%02d", prefix, version / 100, version % 100);
 114         }
 115 }
 116
 117 void BKE_blender_globals_init(void)
 118 {
 119         memset(&G, 0, sizeof(Global));
 120
 121         U.savetime = 1;
 122
 123         G_MAIN = BKE_main_new();
 124
 125         strcpy(G.ima, "//");
 126
 127         BKE_blender_version_string(versionstr, sizeof(versionstr), BLENDER_VERSION, BLENDER_SUBVERSION, true, true);
 128
 129 #ifndef WITH_PYTHON_SECURITY /* default */
 130         G.f |= G_FLAG_SCRIPT_AUTOEXEC;
 131 #else
 132         G.f &= ~G_FLAG_SCRIPT_AUTOEXEC;
 133 #endif
 134
 135         G.log.level = 1;
 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_data_swap(UserDef *userdef_a, UserDef *userdef_b)
 158 {
 159         SWAP(UserDef, *userdef_a, *userdef_b);
 160 }
 161
 162 void BKE_blender_userdef_data_set(UserDef *userdef)
 163 {
 164         BKE_blender_userdef_data_swap(&U, userdef);
 165         BKE_blender_userdef_data_free(userdef, true);
 166 }
 167
 168 void BKE_blender_userdef_data_set_and_free(UserDef *userdef)
 169 {
 170         BKE_blender_userdef_data_set(userdef);
 171         MEM_freeN(userdef);
 172 }
 173
 174 static void userdef_free_keymaps(UserDef *userdef)
 175 {
 176         for (wmKeyMap *km = userdef->user_keymaps.first, *km_next; km; km = km_next) {
 177                 km_next = km->next;
 178                 for (wmKeyMapDiffItem *kmdi = km->diff_items.first; kmdi; kmdi = kmdi->next) {
 179                         if (kmdi->add_item) {
 180                                 keymap_item_free(kmdi->add_item);
 181                                 MEM_freeN(kmdi->add_item);
 182                         }
 183                         if (kmdi->remove_item) {
 184                                 keymap_item_free(kmdi->remove_item);
 185                                 MEM_freeN(kmdi->remove_item);
 186                         }
 187                 }
 188
 189                 for (wmKeyMapItem *kmi = km->items.first; kmi; kmi = kmi->next) {
 190                         keymap_item_free(kmi);
 191                 }
 192
 193                 BLI_freelistN(&km->diff_items);
 194                 BLI_freelistN(&km->items);
 195
 196                 MEM_freeN(km);
 197         }
 198         BLI_listbase_clear(&userdef->user_keymaps);
 199 }
 200
 201 static void userdef_free_keyconfig_prefs(UserDef *userdef)
 202 {
 203         for (wmKeyConfigPref *kpt = userdef->user_keyconfig_prefs.first, *kpt_next; kpt; kpt = kpt_next) {
 204                 kpt_next = kpt->next;
 205                 IDP_FreeProperty(kpt->prop);
 206                 MEM_freeN(kpt->prop);
 207                 MEM_freeN(kpt);
 208         }
 209         BLI_listbase_clear(&userdef->user_keyconfig_prefs);
 210 }
 211
 212 static void userdef_free_user_menus(UserDef *userdef)
 213 {
 214         for (bUserMenu *um = userdef->user_menus.first, *um_next; um; um = um_next) {
 215                 um_next = um->next;
 216                 BKE_blender_user_menu_item_free_list(&um->items);
 217                 MEM_freeN(um);
 218         }
 219 }
 220
 221 static void userdef_free_addons(UserDef *userdef)
 222 {
 223         for (bAddon *addon = userdef->addons.first, *addon_next; addon; addon = addon_next) {
 224                 addon_next = addon->next;
 225                 BKE_addon_free(addon);
 226         }
 227         BLI_listbase_clear(&userdef->addons);
 228 }
 229
 230 /**
 231  * When loading a new userdef from file,
 232  * or when exiting Blender.
 233  */
 234 void BKE_blender_userdef_data_free(UserDef *userdef, bool clear_fonts)
 235 {
 236 #define U _invalid_access_ /* ensure no accidental global access */
 237 #ifdef U  /* quiet warning */
 238 #endif
 239
 240         userdef_free_keymaps(userdef);
 241         userdef_free_keyconfig_prefs(userdef);
 242         userdef_free_user_menus(userdef);
 243         userdef_free_addons(userdef);
 244
 245         if (clear_fonts) {
 246                 for (uiFont *font = userdef->uifonts.first; font; font = font->next) {
 247                         BLF_unload_id(font->blf_id);
 248                 }
 249                 BLF_default_set(-1);
 250         }
 251
 252         BLI_freelistN(&userdef->autoexec_paths);
 253
 254         BLI_freelistN(&userdef->uistyles);
 255         BLI_freelistN(&userdef->uifonts);
 256         BLI_freelistN(&userdef->themes);
 257
 258
 259 #undef U
 260 }
 261
 262 /**
 263  * Write U from userdef.
 264  * This function defines which settings a template will override for the user preferences.
 265  */
 266 void BKE_blender_userdef_app_template_data_swap(UserDef *userdef_a, UserDef *userdef_b)
 267 {
 268         /* TODO:
 269          * - various minor settings (add as needed).
 270          */
 271
 272 #define DATA_SWAP(id) \
 273         { \
 274                 UserDef userdef_tmp; \
 275                 memcpy(&(userdef_tmp.id), &(userdef_a->id), sizeof(userdef_tmp.id)); \
 276                 memcpy(&(userdef_a->id), &(userdef_b->id), sizeof(userdef_tmp.id)); \
 277                 memcpy(&(userdef_b->id), &(userdef_tmp.id), sizeof(userdef_tmp.id)); \
 278         }
 279
 280 #define LIST_SWAP(id) { \
 281         SWAP(ListBase, userdef_a->id, userdef_b->id); \
 282 } ((void)0)
 283
 284 #define FLAG_SWAP(id, ty, flags) { \
 285         CHECK_TYPE(&(userdef_a->id), ty *); \
 286         const ty f = flags; \
 287         const ty a = userdef_a->id; \
 288         const ty b = userdef_b->id; \
 289         userdef_a->id = (userdef_a->id & ~f) | (b & f); \
 290         userdef_b->id = (userdef_b->id & ~f) | (a & f); \
 291 } ((void)0)
 292
 293
 294         LIST_SWAP(uistyles);
 295         LIST_SWAP(uifonts);
 296         LIST_SWAP(themes);
 297         LIST_SWAP(addons);
 298         LIST_SWAP(user_keymaps);
 299
 300         DATA_SWAP(font_path_ui);
 301         DATA_SWAP(font_path_ui_mono);
 302         DATA_SWAP(keyconfigstr);
 303
 304         DATA_SWAP(gizmo_flag);
 305         DATA_SWAP(app_flag);
 306
 307         /* We could add others. */
 308         FLAG_SWAP(uiflag, int, USER_SAVE_PROMPT);
 309
 310 #undef SWAP_TYPELESS
 311 #undef DATA_SWAP
 312 #undef LIST_SWAP
 313 #undef FLAG_SWAP
 314 }
 315
 316 void BKE_blender_userdef_app_template_data_set(UserDef *userdef)
 317 {
 318         BKE_blender_userdef_app_template_data_swap(&U, userdef);
 319         BKE_blender_userdef_data_free(userdef, true);
 320 }
 321
 322 void BKE_blender_userdef_app_template_data_set_and_free(UserDef *userdef)
 323 {
 324         BKE_blender_userdef_app_template_data_set(userdef);
 325         MEM_freeN(userdef);
 326 }
 327
 328 /* *****************  testing for break ************* */
 329
 330 static void (*blender_test_break_cb)(void) = NULL;
 331
 332 void BKE_blender_callback_test_break_set(void (*func)(void))
 333 {
 334         blender_test_break_cb = func;
 335 }
 336
 337
 338 int BKE_blender_test_break(void)
 339 {
 340         if (!G.background) {
 341                 if (blender_test_break_cb)
 342                         blender_test_break_cb();
 343         }
 344
 345         return (G.is_break == true);
 346 }
 347
 348
 349 /** \name Blender's AtExit
 350  *
 351  * \note Don't use MEM_mallocN so functions can be registered at any time.
 352  * \{ */
 353
 354 static struct AtExitData {
 355         struct AtExitData *next;
 356
 357         void (*func)(void *user_data);
 358         void *user_data;
 359 } *g_atexit = NULL;
 360
 361 void BKE_blender_atexit_register(void (*func)(void *user_data), void *user_data)
 362 {
 363         struct AtExitData *ae = malloc(sizeof(*ae));
 364         ae->next = g_atexit;
 365         ae->func = func;
 366         ae->user_data = user_data;
 367         g_atexit = ae;
 368 }
 369
 370 void BKE_blender_atexit_unregister(void (*func)(void *user_data), const void *user_data)
 371 {
 372         struct AtExitData *ae = g_atexit;
 373         struct AtExitData **ae_p = &g_atexit;
 374
 375         while (ae) {
 376                 if ((ae->func == func) && (ae->user_data == user_data)) {
 377                         *ae_p = ae->next;
 378                         free(ae);
 379                         return;
 380                 }
 381                 ae_p = &ae;
 382                 ae = ae->next;
 383         }
 384 }
 385
 386 void BKE_blender_atexit(void)
 387 {
 388         struct AtExitData *ae = g_atexit, *ae_next;
 389         while (ae) {
 390                 ae_next = ae->next;
 391
 392                 ae->func(ae->user_data);
 393
 394                 free(ae);
 395                 ae = ae_next;
 396         }
 397         g_atexit = NULL;
 398 }
 399
 400 /** \} */