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