source/blender/blenkernel/intern/library.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/library.c
  29  *  \ingroup bke
  30  *
  31  * Contains management of ID's and libraries
  32  * allocate and free of all library data
  33  */
  34
  35 #include <stdio.h>
  36 #include <ctype.h>
  37 #include <string.h>
  38 #include <stdlib.h>
  39 #include <stddef.h>
  40 #include <assert.h>
  41
  42 #include "MEM_guardedalloc.h"
  43
  44 /* all types are needed here, in order to do memory operations */
  45 #include "DNA_anim_types.h"
  46 #include "DNA_armature_types.h"
  47 #include "DNA_brush_types.h"
  48 #include "DNA_camera_types.h"
  49 #include "DNA_group_types.h"
  50 #include "DNA_gpencil_types.h"
  51 #include "DNA_ipo_types.h"
  52 #include "DNA_key_types.h"
  53 #include "DNA_lamp_types.h"
  54 #include "DNA_lattice_types.h"
  55 #include "DNA_linestyle_types.h"
  56 #include "DNA_material_types.h"
  57 #include "DNA_mesh_types.h"
  58 #include "DNA_meta_types.h"
  59 #include "DNA_movieclip_types.h"
  60 #include "DNA_mask_types.h"
  61 #include "DNA_node_types.h"
  62 #include "DNA_object_types.h"
  63 #include "DNA_scene_types.h"
  64 #include "DNA_screen_types.h"
  65 #include "DNA_speaker_types.h"
  66 #include "DNA_sound_types.h"
  67 #include "DNA_text_types.h"
  68 #include "DNA_vfont_types.h"
  69 #include "DNA_windowmanager_types.h"
  70 #include "DNA_world_types.h"
  71
  72 #include "BLI_blenlib.h"
  73 #include "BLI_utildefines.h"
  74
  75 #include "BLI_threads.h"
  76 #include "BLT_translation.h"
  77
  78 #include "BKE_action.h"
  79 #include "BKE_animsys.h"
  80 #include "BKE_armature.h"
  81 #include "BKE_bpath.h"
  82 #include "BKE_brush.h"
  83 #include "BKE_camera.h"
  84 #include "BKE_context.h"
  85 #include "BKE_curve.h"
  86 #include "BKE_depsgraph.h"
  87 #include "BKE_font.h"
  88 #include "BKE_global.h"
  89 #include "BKE_group.h"
  90 #include "BKE_gpencil.h"
  91 #include "BKE_idcode.h"
  92 #include "BKE_idprop.h"
  93 #include "BKE_image.h"
  94 #include "BKE_key.h"
  95 #include "BKE_lamp.h"
  96 #include "BKE_lattice.h"
  97 #include "BKE_library.h"
  98 #include "BKE_library_query.h"
  99 #include "BKE_linestyle.h"
 100 #include "BKE_mesh.h"
 101 #include "BKE_material.h"
 102 #include "BKE_main.h"
 103 #include "BKE_mball.h"
 104 #include "BKE_mask.h"
 105 #include "BKE_node.h"
 106 #include "BKE_object.h"
 107 #include "BKE_particle.h"
 108 #include "BKE_packedFile.h"
 109 #include "BKE_speaker.h"
 110 #include "BKE_scene.h"
 111 #include "BKE_text.h"
 112 #include "BKE_texture.h"
 113 #include "BKE_world.h"
 114
 115 #include "DEG_depsgraph.h"
 116
 117 #include "RNA_access.h"
 118
 119 #include "IMB_imbuf.h"
 120 #include "IMB_imbuf_types.h"
 121
 122 /* GS reads the memory pointed at in a specific ordering.
 123  * only use this definition, makes little and big endian systems
 124  * work fine, in conjunction with MAKE_ID */
 125
 126 /* ************* general ************************ */
 127
 128
 129 /* this has to be called from each make_local_* func, we could call
 130  * from id_make_local() but then the make local functions would not be self
 131  * contained.
 132  * also note that the id _must_ have a library - campbell */
 133 void BKE_id_lib_local_paths(Main *bmain, Library *lib, ID *id)
 134 {
 135         const char *bpath_user_data[2] = {bmain->name, lib->filepath};
 136
 137         BKE_bpath_traverse_id(bmain, id,
 138                               BKE_bpath_relocate_visitor,
 139                               BKE_BPATH_TRAVERSE_SKIP_MULTIFILE,
 140                               (void *)bpath_user_data);
 141 }
 142
 143 void id_lib_extern(ID *id)
 144 {
 145         if (id && ID_IS_LINKED_DATABLOCK(id)) {
 146                 BLI_assert(BKE_idcode_is_linkable(GS(id->name)));
 147                 if (id->tag & LIB_TAG_INDIRECT) {
 148                         id->tag -= LIB_TAG_INDIRECT;
 149                         id->tag |= LIB_TAG_EXTERN;
 150                 }
 151         }
 152 }
 153
 154 /* ensure we have a real user */
 155 /* Note: Now that we have flags, we could get rid of the 'fake_user' special case, flags are enough to ensure
 156  *       we always have a real user.
 157  *       However, ID_REAL_USERS is used in several places outside of core library.c, so think we can wait later
 158  *       to make this change... */
 159 void id_us_ensure_real(ID *id)
 160 {
 161         if (id) {
 162                 const int limit = ID_FAKE_USERS(id);
 163                 id->tag |= LIB_TAG_EXTRAUSER;
 164                 if (id->us <= limit) {
 165                         if (id->us < limit || ((id->us == limit) && (id->tag & LIB_TAG_EXTRAUSER_SET))) {
 166                                 printf("ID user count error: %s (from '%s')\n", id->name, id->lib ? id->lib->filepath : "[Main]");
 167                                 BLI_assert(0);
 168                         }
 169                         id->us = limit + 1;
 170                         id->tag |= LIB_TAG_EXTRAUSER_SET;
 171                 }
 172         }
 173 }
 174
 175 void id_us_clear_real(ID *id)
 176 {
 177         if (id && (id->tag & LIB_TAG_EXTRAUSER)) {
 178                 if (id->tag & LIB_TAG_EXTRAUSER_SET) {
 179                         id->us--;
 180                         BLI_assert(id->us >= ID_FAKE_USERS(id));
 181                 }
 182                 id->tag &= ~(LIB_TAG_EXTRAUSER | LIB_TAG_EXTRAUSER_SET);
 183         }
 184 }
 185
 186 /**
 187  * Same as \a id_us_plus, but does not handle lib indirect -> extern.
 188  * Only used by readfile.c so far, but simpler/safer to keep it here nonetheless.
 189  */
 190 void id_us_plus_no_lib(ID *id)
 191 {
 192         if (id) {
 193                 if ((id->tag & LIB_TAG_EXTRAUSER) && (id->tag & LIB_TAG_EXTRAUSER_SET)) {
 194                         BLI_assert(id->us >= 1);
 195                         /* No need to increase count, just tag extra user as no more set.
 196                          * Avoids annoying & inconsistent +1 in user count. */
 197                         id->tag &= ~LIB_TAG_EXTRAUSER_SET;
 198                 }
 199                 else {
 200                         BLI_assert(id->us >= 0);
 201                         id->us++;
 202                 }
 203         }
 204 }
 205
 206
 207 void id_us_plus(ID *id)
 208 {
 209         if (id) {
 210                 id_us_plus_no_lib(id);
 211                 id_lib_extern(id);
 212         }
 213 }
 214
 215 /* decrements the user count for *id. */
 216 void id_us_min(ID *id)
 217 {
 218         if (id) {
 219                 const int limit = ID_FAKE_USERS(id);
 220
 221                 if (id->us <= limit) {
 222                         printf("ID user decrement error: %s (from '%s'): %d <= %d\n",
 223                                id->name, id->lib ? id->lib->filepath : "[Main]", id->us, limit);
 224                         BLI_assert(0);
 225                         id->us = limit;
 226                 }
 227                 else {
 228                         id->us--;
 229                 }
 230
 231                 if ((id->us == limit) && (id->tag & LIB_TAG_EXTRAUSER)) {
 232                         /* We need an extra user here, but never actually incremented user count for it so far, do it now. */
 233                         id_us_ensure_real(id);
 234                 }
 235         }
 236 }
 237
 238 void id_fake_user_set(ID *id)
 239 {
 240         if (id && !(id->flag & LIB_FAKEUSER)) {
 241                 id->flag |= LIB_FAKEUSER;
 242                 id_us_plus(id);
 243         }
 244 }
 245
 246 void id_fake_user_clear(ID *id)
 247 {
 248         if (id && (id->flag & LIB_FAKEUSER)) {
 249                 id->flag &= ~LIB_FAKEUSER;
 250                 id_us_min(id);
 251         }
 252 }
 253
 254 static int id_expand_local_callback(
 255         void *UNUSED(user_data), struct ID *UNUSED(id_self), struct ID **id_pointer, int UNUSED(cd_flag))
 256 {
 257         if (*id_pointer) {
 258                 id_lib_extern(*id_pointer);
 259         }
 260
 261         return IDWALK_RET_NOP;
 262 }
 263
 264 /**
 265  * Expand ID usages of given id as 'extern' (and no more indirect) linked data. Used by ID copy/make_local functions.
 266  */
 267 void BKE_id_expand_local(ID *id)
 268 {
 269         BKE_library_foreach_ID_link(id, id_expand_local_callback, NULL, 0);
 270 }
 271
 272 /* calls the appropriate make_local method for the block, unless test. Returns true
 273  * if the block can be made local. */
 274 bool id_make_local(Main *bmain, ID *id, const bool test, const bool force_local)
 275 {
 276         if (id->tag & LIB_TAG_INDIRECT)
 277                 return false;
 278
 279         switch (GS(id->name)) {
 280                 case ID_SCE:
 281                         return false; /* not implemented */
 282                 case ID_LI:
 283                         return false; /* can't be linked */
 284                 case ID_OB:
 285                         if (!test) BKE_object_make_local(bmain, (Object *)id, force_local);
 286                         return true;
 287                 case ID_ME:
 288                         if (!test) BKE_mesh_make_local(bmain, (Mesh *)id, force_local);
 289                         return true;
 290                 case ID_CU:
 291                         if (!test) BKE_curve_make_local(bmain, (Curve *)id, force_local);
 292                         return true;
 293                 case ID_MB:
 294                         if (!test) BKE_mball_make_local(bmain, (MetaBall *)id, force_local);
 295                         return true;
 296                 case ID_MA:
 297                         if (!test) BKE_material_make_local(bmain, (Material *)id, force_local);
 298                         return true;
 299                 case ID_TE:
 300                         if (!test) BKE_texture_make_local(bmain, (Tex *)id, force_local);
 301                         return true;
 302                 case ID_IM:
 303                         if (!test) BKE_image_make_local(bmain, (Image *)id, force_local);
 304                         return true;
 305                 case ID_LT:
 306                         if (!test) BKE_lattice_make_local(bmain, (Lattice *)id, force_local);
 307                         return true;
 308                 case ID_LA:
 309                         if (!test) BKE_lamp_make_local(bmain, (Lamp *)id, force_local);
 310                         return true;
 311                 case ID_CA:
 312                         if (!test) BKE_camera_make_local(bmain, (Camera *)id, force_local);
 313                         return true;
 314                 case ID_SPK:
 315                         if (!test) BKE_speaker_make_local(bmain, (Speaker *)id, force_local);
 316                         return true;
 317                 case ID_IP:
 318                         return false; /* deprecated */
 319                 case ID_KE:
 320                         return false; /* can't be linked */
 321                 case ID_WO:
 322                         if (!test) BKE_world_make_local(bmain, (World *)id, force_local);
 323                         return true;
 324                 case ID_SCR:
 325                         return false; /* can't be linked */
 326                 case ID_VF:
 327                         return false; /* not implemented */
 328                 case ID_TXT:
 329                         return false; /* not implemented */
 330                 case ID_SO:
 331                         return false; /* not implemented */
 332                 case ID_GR:
 333                         return false; /* not implemented */
 334                 case ID_AR:
 335                         if (!test) BKE_armature_make_local(bmain, (bArmature *)id, force_local);
 336                         return true;
 337                 case ID_AC:
 338                         if (!test) BKE_action_make_local(bmain, (bAction *)id, force_local);
 339                         return true;
 340                 case ID_NT:
 341                         if (!test) ntreeMakeLocal(bmain, (bNodeTree *)id, true, force_local);
 342                         return true;
 343                 case ID_BR:
 344                         if (!test) BKE_brush_make_local(bmain, (Brush *)id, force_local);
 345                         return true;
 346                 case ID_PA:
 347                         if (!test) BKE_particlesettings_make_local(bmain, (ParticleSettings *)id, force_local);
 348                         return true;
 349                 case ID_WM:
 350                         return false; /* can't be linked */
 351                 case ID_GD:
 352                         return false; /* not implemented */
 353                 case ID_LS:
 354                         return false; /* not implemented */
 355         }
 356
 357         return false;
 358 }
 359
 360 /**
 361  * Invokes the appropriate copy method for the block and returns the result in
 362  * newid, unless test. Returns true if the block can be copied.
 363  */
 364 bool id_copy(Main *bmain, ID *id, ID **newid, bool test)
 365 {
 366         if (!test) {
 367                 *newid = NULL;
 368         }
 369
 370         /* conventions:
 371          * - make shallow copy, only this ID block
 372          * - id.us of the new ID is set to 1 */
 373         switch (GS(id->name)) {
 374                 case ID_SCE:
 375                         return false;  /* can't be copied from here */
 376                 case ID_LI:
 377                         return false;  /* can't be copied from here */
 378                 case ID_OB:
 379                         if (!test) *newid = (ID *)BKE_object_copy(bmain, (Object *)id);
 380                         return true;
 381                 case ID_ME:
 382                         if (!test) *newid = (ID *)BKE_mesh_copy(bmain, (Mesh *)id);
 383                         return true;
 384                 case ID_CU:
 385                         if (!test) *newid = (ID *)BKE_curve_copy(bmain, (Curve *)id);
 386                         return true;
 387                 case ID_MB:
 388                         if (!test) *newid = (ID *)BKE_mball_copy(bmain, (MetaBall *)id);
 389                         return true;
 390                 case ID_MA:
 391                         if (!test) *newid = (ID *)BKE_material_copy(bmain, (Material *)id);
 392                         return true;
 393                 case ID_TE:
 394                         if (!test) *newid = (ID *)BKE_texture_copy(bmain, (Tex *)id);
 395                         return true;
 396                 case ID_IM:
 397                         if (!test) *newid = (ID *)BKE_image_copy(bmain, (Image *)id);
 398                         return true;
 399                 case ID_LT:
 400                         if (!test) *newid = (ID *)BKE_lattice_copy(bmain, (Lattice *)id);
 401                         return true;
 402                 case ID_LA:
 403                         if (!test) *newid = (ID *)BKE_lamp_copy(bmain, (Lamp *)id);
 404                         return true;
 405                 case ID_SPK:
 406                         if (!test) *newid = (ID *)BKE_speaker_copy(bmain, (Speaker *)id);
 407                         return true;
 408                 case ID_CA:
 409                         if (!test) *newid = (ID *)BKE_camera_copy(bmain, (Camera *)id);
 410                         return true;
 411                 case ID_IP:
 412                         return false;  /* deprecated */
 413                 case ID_KE:
 414                         if (!test) *newid = (ID *)BKE_key_copy(bmain, (Key *)id);
 415                         return true;
 416                 case ID_WO:
 417                         if (!test) *newid = (ID *)BKE_world_copy(bmain, (World *)id);
 418                         return true;
 419                 case ID_SCR:
 420                         return false;  /* can't be copied from here */
 421                 case ID_VF:
 422                         return false;  /* not implemented */
 423                 case ID_TXT:
 424                         if (!test) *newid = (ID *)BKE_text_copy(bmain, (Text *)id);
 425                         return true;
 426                 case ID_SO:
 427                         return false;  /* not implemented */
 428                 case ID_GR:
 429                         if (!test) *newid = (ID *)BKE_group_copy(bmain, (Group *)id);
 430                         return true;
 431                 case ID_AR:
 432                         if (!test) *newid = (ID *)BKE_armature_copy(bmain, (bArmature *)id);
 433                         return true;
 434                 case ID_AC:
 435                         if (!test) *newid = (ID *)BKE_action_copy(bmain, (bAction *)id);
 436                         return true;
 437                 case ID_NT:
 438                         if (!test) *newid = (ID *)ntreeCopyTree(bmain, (bNodeTree *)id);
 439                         return true;
 440                 case ID_BR:
 441                         if (!test) *newid = (ID *)BKE_brush_copy(bmain, (Brush *)id);
 442                         return true;
 443                 case ID_PA:
 444                         if (!test) *newid = (ID *)BKE_particlesettings_copy(bmain, (ParticleSettings *)id);
 445                         return true;
 446                 case ID_WM:
 447                         return false;  /* can't be copied from here */
 448                 case ID_GD:
 449                         if (!test) *newid = (ID *)gpencil_data_duplicate(bmain, (bGPdata *)id, false);
 450                         return true;
 451                 case ID_MSK:
 452                         if (!test) *newid = (ID *)BKE_mask_copy(bmain, (Mask *)id);
 453                         return true;
 454                 case ID_LS:
 455                         if (!test) *newid = (ID *)BKE_linestyle_copy(bmain, (FreestyleLineStyle *)id);
 456                         return true;
 457         }
 458
 459         return false;
 460 }
 461
 462 bool id_single_user(bContext *C, ID *id, PointerRNA *ptr, PropertyRNA *prop)
 463 {
 464         ID *newid = NULL;
 465         PointerRNA idptr;
 466
 467         if (id) {
 468                 /* if property isn't editable, we're going to have an extra block hanging around until we save */
 469                 if (RNA_property_editable(ptr, prop)) {
 470                         if (id_copy(CTX_data_main(C), id, &newid, false) && newid) {
 471                                 /* copy animation actions too */
 472                                 BKE_animdata_copy_id_action(id);
 473                                 /* us is 1 by convention, but RNA_property_pointer_set
 474                                  * will also increment it, so set it to zero */
 475                                 newid->us = 0;
 476
 477                                 /* assign copy */
 478                                 RNA_id_pointer_create(newid, &idptr);
 479                                 RNA_property_pointer_set(ptr, prop, idptr);
 480                                 RNA_property_update(C, ptr, prop);
 481
 482                                 return true;
 483                         }
 484                 }
 485         }
 486
 487         return false;
 488 }
 489
 490 ListBase *which_libbase(Main *mainlib, short type)
 491 {
 492         switch (type) {
 493                 case ID_SCE:
 494                         return &(mainlib->scene);
 495                 case ID_LI:
 496                         return &(mainlib->library);
 497                 case ID_OB:
 498                         return &(mainlib->object);
 499                 case ID_ME:
 500                         return &(mainlib->mesh);
 501                 case ID_CU:
 502                         return &(mainlib->curve);
 503                 case ID_MB:
 504                         return &(mainlib->mball);
 505                 case ID_MA:
 506                         return &(mainlib->mat);
 507                 case ID_TE:
 508                         return &(mainlib->tex);
 509                 case ID_IM:
 510                         return &(mainlib->image);
 511                 case ID_LT:
 512                         return &(mainlib->latt);
 513                 case ID_LA:
 514                         return &(mainlib->lamp);
 515                 case ID_CA:
 516                         return &(mainlib->camera);
 517                 case ID_IP:
 518                         return &(mainlib->ipo);
 519                 case ID_KE:
 520                         return &(mainlib->key);
 521                 case ID_WO:
 522                         return &(mainlib->world);
 523                 case ID_SCR:
 524                         return &(mainlib->screen);
 525                 case ID_VF:
 526                         return &(mainlib->vfont);
 527                 case ID_TXT:
 528                         return &(mainlib->text);
 529                 case ID_SPK:
 530                         return &(mainlib->speaker);
 531                 case ID_SO:
 532                         return &(mainlib->sound);
 533                 case ID_GR:
 534                         return &(mainlib->group);
 535                 case ID_AR:
 536                         return &(mainlib->armature);
 537                 case ID_AC:
 538                         return &(mainlib->action);
 539                 case ID_NT:
 540                         return &(mainlib->nodetree);
 541                 case ID_BR:
 542                         return &(mainlib->brush);
 543                 case ID_PA:
 544                         return &(mainlib->particle);
 545                 case ID_WM:
 546                         return &(mainlib->wm);
 547                 case ID_GD:
 548                         return &(mainlib->gpencil);
 549                 case ID_MC:
 550                         return &(mainlib->movieclip);
 551                 case ID_MSK:
 552                         return &(mainlib->mask);
 553                 case ID_LS:
 554                         return &(mainlib->linestyle);
 555                 case ID_PAL:
 556                         return &(mainlib->palettes);
 557                 case ID_PC:
 558                         return &(mainlib->paintcurves);
 559         }
 560         return NULL;
 561 }
 562
 563 /**
 564  * Clear or set given tags for all ids in listbase (runtime tags).
 565  */
 566 void BKE_main_id_tag_listbase(ListBase *lb, const int tag, const bool value)
 567 {
 568         ID *id;
 569         if (value) {
 570                 for (id = lb->first; id; id = id->next) {
 571                         id->tag |= tag;
 572                 }
 573         }
 574         else {
 575                 const int ntag = ~tag;
 576                 for (id = lb->first; id; id = id->next) {
 577                         id->tag &= ntag;
 578                 }
 579         }
 580 }
 581
 582 /**
 583  * Clear or set given tags for all ids of given type in bmain (runtime tags).
 584  */
 585 void BKE_main_id_tag_idcode(struct Main *mainvar, const short type, const int tag, const bool value)
 586 {
 587         ListBase *lb = which_libbase(mainvar, type);
 588
 589         BKE_main_id_tag_listbase(lb, tag, value);
 590 }
 591
 592 /**
 593  * Clear or set given tags for all ids in bmain (runtime tags).
 594  */
 595 void BKE_main_id_tag_all(struct Main *mainvar, const int tag, const bool value)
 596 {
 597         ListBase *lbarray[MAX_LIBARRAY];
 598         int a;
 599
 600         a = set_listbasepointers(mainvar, lbarray);
 601         while (a--) {
 602                 BKE_main_id_tag_listbase(lbarray[a], tag, value);
 603         }
 604 }
 605
 606
 607 /**
 608  * Clear or set given flags for all ids in listbase (persistent flags).
 609  */
 610 void BKE_main_id_flag_listbase(ListBase *lb, const int flag, const bool value)
 611 {
 612         ID *id;
 613         if (value) {
 614                 for (id = lb->first; id; id = id->next)
 615                         id->tag |= flag;
 616         }
 617         else {
 618                 const int nflag = ~flag;
 619                 for (id = lb->first; id; id = id->next)
 620                         id->tag &= nflag;
 621         }
 622 }
 623
 624 /**
 625  * Clear or set given flags for all ids in bmain (persistent flags).
 626  */
 627 void BKE_main_id_flag_all(Main *bmain, const int flag, const bool value)
 628 {
 629         ListBase *lbarray[MAX_LIBARRAY];
 630         int a;
 631         a = set_listbasepointers(bmain, lbarray);
 632         while (a--) {
 633                 BKE_main_id_flag_listbase(lbarray[a], flag, value);
 634         }
 635 }
 636
 637 void BKE_main_lib_objects_recalc_all(Main *bmain)
 638 {
 639         Object *ob;
 640
 641         /* flag for full recalc */
 642         for (ob = bmain->object.first; ob; ob = ob->id.next) {
 643                 if (ID_IS_LINKED_DATABLOCK(ob)) {
 644                         DAG_id_tag_update(&ob->id, OB_RECALC_OB | OB_RECALC_DATA | OB_RECALC_TIME);
 645                 }
 646         }
 647
 648         DAG_id_type_tag(bmain, ID_OB);
 649 }
 650
 651 /**
 652  * puts into array *lb pointers to all the ListBase structs in main,
 653  * and returns the number of them as the function result. This is useful for
 654  * generic traversal of all the blocks in a Main (by traversing all the
 655  * lists in turn), without worrying about block types.
 656  *
 657  * \note MAX_LIBARRAY define should match this code */
 658 int set_listbasepointers(Main *main, ListBase **lb)
 659 {
 660         int a = 0;
 661
 662         /* BACKWARDS! also watch order of free-ing! (mesh<->mat), first items freed last.
 663          * This is important because freeing data decreases usercounts of other datablocks,
 664          * if this data is its self freed it can crash. */
 665         lb[a++] = &(main->library);  /* Libraries may be accessed from pretty much any other ID... */
 666         lb[a++] = &(main->ipo);
 667         lb[a++] = &(main->action); /* moved here to avoid problems when freeing with animato (aligorith) */
 668         lb[a++] = &(main->key);
 669         lb[a++] = &(main->gpencil); /* referenced by nodes, objects, view, scene etc, before to free after. */
 670         lb[a++] = &(main->nodetree);
 671         lb[a++] = &(main->image);
 672         lb[a++] = &(main->tex);
 673         lb[a++] = &(main->mat);
 674         lb[a++] = &(main->vfont);
 675
 676         /* Important!: When adding a new object type,
 677          * the specific data should be inserted here
 678          */
 679
 680         lb[a++] = &(main->armature);
 681
 682         lb[a++] = &(main->mesh);
 683         lb[a++] = &(main->curve);
 684         lb[a++] = &(main->mball);
 685
 686         lb[a++] = &(main->latt);
 687         lb[a++] = &(main->lamp);
 688         lb[a++] = &(main->camera);
 689
 690         lb[a++] = &(main->text);
 691         lb[a++] = &(main->sound);
 692         lb[a++] = &(main->group);
 693         lb[a++] = &(main->palettes);
 694         lb[a++] = &(main->paintcurves);
 695         lb[a++] = &(main->brush);
 696         lb[a++] = &(main->particle);
 697         lb[a++] = &(main->speaker);
 698
 699         lb[a++] = &(main->world);
 700         lb[a++] = &(main->movieclip);
 701         lb[a++] = &(main->screen);
 702         lb[a++] = &(main->object);
 703         lb[a++] = &(main->linestyle); /* referenced by scenes */
 704         lb[a++] = &(main->scene);
 705         lb[a++] = &(main->wm);
 706         lb[a++] = &(main->mask);
 707
 708         lb[a] = NULL;
 709
 710         BLI_assert(a + 1 == MAX_LIBARRAY);
 711
 712         return a;
 713 }
 714
 715 /* *********** ALLOC AND FREE *****************
 716  *
 717  * BKE_libblock_free(ListBase *lb, ID *id )
 718  * provide a list-basis and datablock, but only ID is read
 719  *
 720  * void *BKE_libblock_alloc(ListBase *lb, type, name)
 721  * inserts in list and returns a new ID
 722  *
 723  * **************************** */
 724
 725 /**
 726  * Allocates and returns memory of the right size for the specified block type,
 727  * initialized to zero.
 728  */
 729 void *BKE_libblock_alloc_notest(short type)
 730 {
 731         ID *id = NULL;
 732
 733         switch (type) {
 734                 case ID_SCE:
 735                         id = MEM_callocN(sizeof(Scene), "scene");
 736                         break;
 737                 case ID_LI:
 738                         id = MEM_callocN(sizeof(Library), "library");
 739                         break;
 740                 case ID_OB:
 741                         id = MEM_callocN(sizeof(Object), "object");
 742                         break;
 743                 case ID_ME:
 744                         id = MEM_callocN(sizeof(Mesh), "mesh");
 745                         break;
 746                 case ID_CU:
 747                         id = MEM_callocN(sizeof(Curve), "curve");
 748                         break;
 749                 case ID_MB:
 750                         id = MEM_callocN(sizeof(MetaBall), "mball");
 751                         break;
 752                 case ID_MA:
 753                         id = MEM_callocN(sizeof(Material), "mat");
 754                         break;
 755                 case ID_TE:
 756                         id = MEM_callocN(sizeof(Tex), "tex");
 757                         break;
 758                 case ID_IM:
 759                         id = MEM_callocN(sizeof(Image), "image");
 760                         break;
 761                 case ID_LT:
 762                         id = MEM_callocN(sizeof(Lattice), "latt");
 763                         break;
 764                 case ID_LA:
 765                         id = MEM_callocN(sizeof(Lamp), "lamp");
 766                         break;
 767                 case ID_CA:
 768                         id = MEM_callocN(sizeof(Camera), "camera");
 769                         break;
 770                 case ID_IP:
 771                         id = MEM_callocN(sizeof(Ipo), "ipo");
 772                         break;
 773                 case ID_KE:
 774                         id = MEM_callocN(sizeof(Key), "key");
 775                         break;
 776                 case ID_WO:
 777                         id = MEM_callocN(sizeof(World), "world");
 778                         break;
 779                 case ID_SCR:
 780                         id = MEM_callocN(sizeof(bScreen), "screen");
 781                         break;
 782                 case ID_VF:
 783                         id = MEM_callocN(sizeof(VFont), "vfont");
 784                         break;
 785                 case ID_TXT:
 786                         id = MEM_callocN(sizeof(Text), "text");
 787                         break;
 788                 case ID_SPK:
 789                         id = MEM_callocN(sizeof(Speaker), "speaker");
 790                         break;
 791                 case ID_SO:
 792                         id = MEM_callocN(sizeof(bSound), "sound");
 793                         break;
 794                 case ID_GR:
 795                         id = MEM_callocN(sizeof(Group), "group");
 796                         break;
 797                 case ID_AR:
 798                         id = MEM_callocN(sizeof(bArmature), "armature");
 799                         break;
 800                 case ID_AC:
 801                         id = MEM_callocN(sizeof(bAction), "action");
 802                         break;
 803                 case ID_NT:
 804                         id = MEM_callocN(sizeof(bNodeTree), "nodetree");
 805                         break;
 806                 case ID_BR:
 807                         id = MEM_callocN(sizeof(Brush), "brush");
 808                         break;
 809                 case ID_PA:
 810                         id = MEM_callocN(sizeof(ParticleSettings), "ParticleSettings");
 811                         break;
 812                 case ID_WM:
 813                         id = MEM_callocN(sizeof(wmWindowManager), "Window manager");
 814                         break;
 815                 case ID_GD:
 816                         id = MEM_callocN(sizeof(bGPdata), "Grease Pencil");
 817                         break;
 818                 case ID_MC:
 819                         id = MEM_callocN(sizeof(MovieClip), "Movie Clip");
 820                         break;
 821                 case ID_MSK:
 822                         id = MEM_callocN(sizeof(Mask), "Mask");
 823                         break;
 824                 case ID_LS:
 825                         id = MEM_callocN(sizeof(FreestyleLineStyle), "Freestyle Line Style");
 826                         break;
 827                 case ID_PAL:
 828                         id = MEM_callocN(sizeof(Palette), "Palette");
 829                         break;
 830                 case ID_PC:
 831                         id = MEM_callocN(sizeof(PaintCurve), "Paint Curve");
 832                         break;
 833         }
 834         return id;
 835 }
 836
 837 /**
 838  * Allocates and returns a block of the specified type, with the specified name
 839  * (adjusted as necessary to ensure uniqueness), and appended to the specified list.
 840  * The user count is set to 1, all other content (apart from name and links) being
 841  * initialized to zero.
 842  */
 843 void *BKE_libblock_alloc(Main *bmain, short type, const char *name)
 844 {
 845         ID *id = NULL;
 846         ListBase *lb = which_libbase(bmain, type);
 847
 848         id = BKE_libblock_alloc_notest(type);
 849         if (id) {
 850                 BKE_main_lock(bmain);
 851                 BLI_addtail(lb, id);
 852                 id->us = 1;
 853                 id->icon_id = 0;
 854                 *( (short *)id->name) = type;
 855                 new_id(lb, id, name);
 856                 /* alphabetic insertion: is in new_id */
 857                 BKE_main_unlock(bmain);
 858         }
 859         DAG_id_type_tag(bmain, type);
 860         return id;
 861 }
 862
 863 /**
 864  * Initialize an ID of given type, such that it has valid 'empty' data.
 865  * ID is assumed to be just calloc'ed.
 866  */
 867 void BKE_libblock_init_empty(ID *id)
 868 {
 869         /* Note that only ID types that are not valid when filled of zero should have a callback here. */
 870         switch (GS(id->name)) {
 871                 case ID_SCE:
 872                         BKE_scene_init((Scene *)id);
 873                         break;
 874                 case ID_LI:
 875                         /* Nothing to do. */
 876                         break;
 877                 case ID_OB:
 878                 {
 879                         Object *ob = (Object *)id;
 880                         ob->type = OB_EMPTY;
 881                         BKE_object_init(ob);
 882                         break;
 883                 }
 884                 case ID_ME:
 885                         BKE_mesh_init((Mesh *)id);
 886                         break;
 887                 case ID_CU:
 888                         BKE_curve_init((Curve *)id);
 889                         break;
 890                 case ID_MB:
 891                         BKE_mball_init((MetaBall *)id);
 892                         break;
 893                 case ID_MA:
 894                         BKE_material_init((Material *)id);
 895                         break;
 896                 case ID_TE:
 897                         BKE_texture_default((Tex *)id);
 898                         break;
 899                 case ID_IM:
 900                         BKE_image_init((Image *)id);
 901                         break;
 902                 case ID_LT:
 903                         BKE_lattice_init((Lattice *)id);
 904                         break;
 905                 case ID_LA:
 906                         BKE_lamp_init((Lamp *)id);
 907                         break;
 908                 case ID_SPK:
 909                         BKE_speaker_init((Speaker *)id);
 910                         break;
 911                 case ID_CA:
 912                         BKE_camera_init((Camera *)id);
 913                         break;
 914                 case ID_IP:
 915                         /* Should not be needed - animation from lib pre-2.5 is broken anyway. */
 916                         BLI_assert(0);
 917                         break;
 918                 case ID_KE:
 919                         /* Shapekeys are a complex topic too - they depend on their 'user' data type...
 920                          * They are not linkable, though, so it should never reach here anyway. */
 921                         BLI_assert(0);
 922                         break;
 923                 case ID_WO:
 924                         BKE_world_init((World *)id);
 925                         break;
 926                 case ID_SCR:
 927                         /* Nothing to do. */
 928                         break;
 929                 case ID_VF:
 930                         BKE_vfont_init((VFont *)id);
 931                         break;
 932                 case ID_TXT:
 933                         BKE_text_init((Text *)id);
 934                         break;
 935                 case ID_SO:
 936                         /* Another fuzzy case, think NULLified content is OK here... */
 937                         break;
 938                 case ID_GR:
 939                         /* Nothing to do. */
 940                         break;
 941                 case ID_AR:
 942                         /* Nothing to do. */
 943                         break;
 944                 case ID_AC:
 945                         /* Nothing to do. */
 946                         break;
 947                 case ID_NT:
 948                         ntreeInitDefault((bNodeTree *)id);
 949                         break;
 950                 case ID_BR:
 951                         BKE_brush_init((Brush *)id);
 952                         break;
 953                 case ID_PA:
 954                         /* Nothing to do. */
 955                         break;
 956                 case ID_PC:
 957                         /* Nothing to do. */
 958                         break;
 959                 case ID_WM:
 960                         /* We should never reach this. */
 961                         BLI_assert(0);
 962                         break;
 963                 case ID_GD:
 964                         /* Nothing to do. */
 965                         break;
 966                 case ID_MSK:
 967                         /* Nothing to do. */
 968                         break;
 969                 case ID_LS:
 970                         BKE_linestyle_init((FreestyleLineStyle *)id);
 971                         break;
 972         }
 973 }
 974
 975 /* by spec, animdata is first item after ID */
 976 /* and, trust that BKE_animdata_from_id() will only find AnimData for valid ID-types */
 977 static void id_copy_animdata(ID *id, const bool do_action)
 978 {
 979         AnimData *adt = BKE_animdata_from_id(id);
 980
 981         if (adt) {
 982                 IdAdtTemplate *iat = (IdAdtTemplate *)id;
 983                 iat->adt = BKE_animdata_copy(iat->adt, do_action); /* could be set to false, need to investigate */
 984         }
 985 }
 986
 987 /* material nodes use this since they are not treated as libdata */
 988 void BKE_libblock_copy_data(ID *id, const ID *id_from, const bool do_action)
 989 {
 990         if (id_from->properties)
 991                 id->properties = IDP_CopyProperty(id_from->properties);
 992
 993         /* the duplicate should get a copy of the animdata */
 994         id_copy_animdata(id, do_action);
 995 }
 996
 997 /* used everywhere in blenkernel */
 998 void *BKE_libblock_copy(Main *bmain, ID *id)
 999 {
1000         ID *idn;
1001         size_t idn_len;
1002
1003         idn = BKE_libblock_alloc(bmain, GS(id->name), id->name + 2);
1004
1005         assert(idn != NULL);
1006
1007         idn_len = MEM_allocN_len(idn);
1008         if ((int)idn_len - (int)sizeof(ID) > 0) { /* signed to allow neg result */
1009                 const char *cp = (const char *)id;
1010                 char *cpn = (char *)idn;
1011
1012                 memcpy(cpn + sizeof(ID), cp + sizeof(ID), idn_len - sizeof(ID));
1013         }
1014
1015         id->newid = idn;
1016         idn->tag |= LIB_TAG_NEW;
1017
1018         BKE_libblock_copy_data(idn, id, false);
1019
1020         return idn;
1021 }
1022
1023 void *BKE_libblock_copy_nolib(ID *id, const bool do_action)
1024 {
1025         ID *idn;
1026         size_t idn_len;
1027
1028         idn = BKE_libblock_alloc_notest(GS(id->name));
1029         assert(idn != NULL);
1030
1031         BLI_strncpy(idn->name, id->name, sizeof(idn->name));
1032
1033         idn_len = MEM_allocN_len(idn);
1034         if ((int)idn_len - (int)sizeof(ID) > 0) { /* signed to allow neg result */
1035                 const char *cp = (const char *)id;
1036                 char *cpn = (char *)idn;
1037
1038                 memcpy(cpn + sizeof(ID), cp + sizeof(ID), idn_len - sizeof(ID));
1039         }
1040
1041         id->newid = idn;
1042         idn->tag |= LIB_TAG_NEW;
1043         idn->us = 1;
1044
1045         BKE_libblock_copy_data(idn, id, do_action);
1046
1047         return idn;
1048 }
1049
1050 static int id_relink_looper(void *UNUSED(user_data), ID *UNUSED(self_id), ID **id_pointer, const int cd_flag)
1051 {
1052         ID *id = *id_pointer;
1053         if (id) {
1054                 /* See: NEW_ID macro */
1055                 if (id->newid) {
1056                         BKE_library_update_ID_link_user(id->newid, id, cd_flag);
1057                         *id_pointer = id->newid;
1058                 }
1059                 else if (id->tag & LIB_TAG_NEW) {
1060                         id->tag &= ~LIB_TAG_NEW;
1061                         BKE_libblock_relink(id);
1062                 }
1063         }
1064         return IDWALK_RET_NOP;
1065 }
1066
1067 void BKE_libblock_relink(ID *id)
1068 {
1069         if (ID_IS_LINKED_DATABLOCK(id))
1070                 return;
1071
1072         BKE_library_foreach_ID_link(id, id_relink_looper, NULL, 0);
1073 }
1074
1075 void BKE_library_free(Library *lib)
1076 {
1077         if (lib->packedfile)
1078                 freePackedFile(lib->packedfile);
1079 }
1080
1081 Main *BKE_main_new(void)
1082 {
1083         Main *bmain = MEM_callocN(sizeof(Main), "new main");
1084         bmain->eval_ctx = DEG_evaluation_context_new(DAG_EVAL_VIEWPORT);
1085         bmain->lock = MEM_mallocN(sizeof(SpinLock), "main lock");
1086         BLI_spin_init((SpinLock *)bmain->lock);
1087         return bmain;
1088 }
1089
1090 void BKE_main_free(Main *mainvar)
1091 {
1092         /* also call when reading a file, erase all, etc */
1093         ListBase *lbarray[MAX_LIBARRAY];
1094         int a;
1095
1096         MEM_SAFE_FREE(mainvar->blen_thumb);
1097
1098         a = set_listbasepointers(mainvar, lbarray);
1099         while (a--) {
1100                 ListBase *lb = lbarray[a];
1101                 ID *id;
1102
1103                 while ( (id = lb->first) ) {
1104 #if 1
1105                         BKE_libblock_free_ex(mainvar, id, false);
1106 #else
1107                         /* errors freeing ID's can be hard to track down,
1108                          * enable this so valgrind will give the line number in its error log */
1109                         switch (a) {
1110                                 case   0: BKE_libblock_free_ex(mainvar, id, false); break;
1111                                 case   1: BKE_libblock_free_ex(mainvar, id, false); break;
1112                                 case   2: BKE_libblock_free_ex(mainvar, id, false); break;
1113                                 case   3: BKE_libblock_free_ex(mainvar, id, false); break;
1114                                 case   4: BKE_libblock_free_ex(mainvar, id, false); break;
1115                                 case   5: BKE_libblock_free_ex(mainvar, id, false); break;
1116                                 case   6: BKE_libblock_free_ex(mainvar, id, false); break;
1117                                 case   7: BKE_libblock_free_ex(mainvar, id, false); break;
1118                                 case   8: BKE_libblock_free_ex(mainvar, id, false); break;
1119                                 case   9: BKE_libblock_free_ex(mainvar, id, false); break;
1120                                 case  10: BKE_libblock_free_ex(mainvar, id, false); break;
1121                                 case  11: BKE_libblock_free_ex(mainvar, id, false); break;
1122                                 case  12: BKE_libblock_free_ex(mainvar, id, false); break;
1123                                 case  13: BKE_libblock_free_ex(mainvar, id, false); break;
1124                                 case  14: BKE_libblock_free_ex(mainvar, id, false); break;
1125                                 case  15: BKE_libblock_free_ex(mainvar, id, false); break;
1126                                 case  16: BKE_libblock_free_ex(mainvar, id, false); break;
1127                                 case  17: BKE_libblock_free_ex(mainvar, id, false); break;
1128                                 case  18: BKE_libblock_free_ex(mainvar, id, false); break;
1129                                 case  19: BKE_libblock_free_ex(mainvar, id, false); break;
1130                                 case  20: BKE_libblock_free_ex(mainvar, id, false); break;
1131                                 case  21: BKE_libblock_free_ex(mainvar, id, false); break;
1132                                 case  22: BKE_libblock_free_ex(mainvar, id, false); break;
1133                                 case  23: BKE_libblock_free_ex(mainvar, id, false); break;
1134                                 case  24: BKE_libblock_free_ex(mainvar, id, false); break;
1135                                 case  25: BKE_libblock_free_ex(mainvar, id, false); break;
1136                                 case  26: BKE_libblock_free_ex(mainvar, id, false); break;
1137                                 case  27: BKE_libblock_free_ex(mainvar, id, false); break;
1138                                 case  28: BKE_libblock_free_ex(mainvar, id, false); break;
1139                                 case  29: BKE_libblock_free_ex(mainvar, id, false); break;
1140                                 case  30: BKE_libblock_free_ex(mainvar, id, false); break;
1141                                 case  31: BKE_libblock_free_ex(mainvar, id, false); break;
1142                                 case  32: BKE_libblock_free_ex(mainvar, id, false); break;
1143                                 case  33: BKE_libblock_free_ex(mainvar, id, false); break;
1144                                 default:
1145                                         BLI_assert(0);
1146                                         break;
1147                         }
1148 #endif
1149                 }
1150         }
1151
1152         BLI_spin_end((SpinLock *)mainvar->lock);
1153         MEM_freeN(mainvar->lock);
1154         DEG_evaluation_context_free(mainvar->eval_ctx);
1155         MEM_freeN(mainvar);
1156 }
1157
1158 void BKE_main_lock(struct Main *bmain)
1159 {
1160         BLI_spin_lock((SpinLock *) bmain->lock);
1161 }
1162
1163 void BKE_main_unlock(struct Main *bmain)
1164 {
1165         BLI_spin_unlock((SpinLock *) bmain->lock);
1166 }
1167
1168 /**
1169  * Generates a raw .blend file thumbnail data from given image.
1170  *
1171  * \param bmain If not NULL, also store generated data in this Main.
1172  * \param img ImBuf image to generate thumbnail data from.
1173  * \return The generated .blend file raw thumbnail data.
1174  */
1175 BlendThumbnail *BKE_main_thumbnail_from_imbuf(Main *bmain, ImBuf *img)
1176 {
1177         BlendThumbnail *data = NULL;
1178
1179         if (bmain) {
1180                 MEM_SAFE_FREE(bmain->blen_thumb);
1181         }
1182
1183         if (img) {
1184                 const size_t sz = BLEN_THUMB_MEMSIZE(img->x, img->y);
1185                 data = MEM_mallocN(sz, __func__);
1186
1187                 IMB_rect_from_float(img);  /* Just in case... */
1188                 data->width = img->x;
1189                 data->height = img->y;
1190                 memcpy(data->rect, img->rect, sz - sizeof(*data));
1191         }
1192
1193         if (bmain) {
1194                 bmain->blen_thumb = data;
1195         }
1196         return data;
1197 }
1198
1199 /**
1200  * Generates an image from raw .blend file thumbnail \a data.
1201  *
1202  * \param bmain Use this bmain->blen_thumb data if given \a data is NULL.
1203  * \param data Raw .blend file thumbnail data.
1204  * \return An ImBuf from given data, or NULL if invalid.
1205  */
1206 ImBuf *BKE_main_thumbnail_to_imbuf(Main *bmain, BlendThumbnail *data)
1207 {
1208         ImBuf *img = NULL;
1209
1210         if (!data && bmain) {
1211                 data = bmain->blen_thumb;
1212         }
1213
1214         if (data) {
1215                 /* Note: we cannot use IMB_allocFromBuffer(), since it tries to dupalloc passed buffer, which will fail
1216                  *       here (we do not want to pass the first two ints!). */
1217                 img = IMB_allocImBuf((unsigned int)data->width, (unsigned int)data->height, 32, IB_rect | IB_metadata);
1218                 memcpy(img->rect, data->rect, BLEN_THUMB_MEMSIZE(data->width, data->height) - sizeof(*data));
1219         }
1220
1221         return img;
1222 }
1223
1224 /**
1225  * Generates an empty (black) thumbnail for given Main.
1226  */
1227 void BKE_main_thumbnail_create(struct Main *bmain)
1228 {
1229         MEM_SAFE_FREE(bmain->blen_thumb);
1230
1231         bmain->blen_thumb = MEM_callocN(BLEN_THUMB_MEMSIZE(BLEN_THUMB_SIZE, BLEN_THUMB_SIZE), __func__);
1232         bmain->blen_thumb->width = BLEN_THUMB_SIZE;
1233         bmain->blen_thumb->height = BLEN_THUMB_SIZE;
1234 }
1235
1236 /* ***************** ID ************************ */
1237 ID *BKE_libblock_find_name_ex(struct Main *bmain, const short type, const char *name)
1238 {
1239         ListBase *lb = which_libbase(bmain, type);
1240         BLI_assert(lb != NULL);
1241         return BLI_findstring(lb, name, offsetof(ID, name) + 2);
1242 }
1243 ID *BKE_libblock_find_name(const short type, const char *name)
1244 {
1245         return BKE_libblock_find_name_ex(G.main, type, name);
1246 }
1247
1248
1249 void id_sort_by_name(ListBase *lb, ID *id)
1250 {
1251         ID *idtest;
1252
1253         /* insert alphabetically */
1254         if (lb->first != lb->last) {
1255                 BLI_remlink(lb, id);
1256
1257                 idtest = lb->first;
1258                 while (idtest) {
1259                         if (BLI_strcasecmp(idtest->name, id->name) > 0 || (idtest->lib && !id->lib)) {
1260                                 BLI_insertlinkbefore(lb, idtest, id);
1261                                 break;
1262                         }
1263                         idtest = idtest->next;
1264                 }
1265                 /* as last */
1266                 if (idtest == NULL) {
1267                         BLI_addtail(lb, id);
1268                 }
1269         }
1270
1271 }
1272
1273 /**
1274  * Check to see if there is an ID with the same name as 'name'.
1275  * Returns the ID if so, if not, returns NULL
1276  */
1277 static ID *is_dupid(ListBase *lb, ID *id, const char *name)
1278 {
1279         ID *idtest = NULL;
1280
1281         for (idtest = lb->first; idtest; idtest = idtest->next) {
1282                 /* if idtest is not a lib */
1283                 if (id != idtest && !ID_IS_LINKED_DATABLOCK(idtest)) {
1284                         /* do not test alphabetic! */
1285                         /* optimized */
1286                         if (idtest->name[2] == name[0]) {
1287                                 if (STREQ(name, idtest->name + 2)) break;
1288                         }
1289                 }
1290         }
1291
1292         return idtest;
1293 }
1294
1295 /**
1296  * Check to see if an ID name is already used, and find a new one if so.
1297  * Return true if created a new name (returned in name).
1298  *
1299  * Normally the ID that's being check is already in the ListBase, so ID *id
1300  * points at the new entry.  The Python Library module needs to know what
1301  * the name of a datablock will be before it is appended; in this case ID *id
1302  * id is NULL
1303  */
1304
1305 static bool check_for_dupid(ListBase *lb, ID *id, char *name)
1306 {
1307         ID *idtest;
1308         int nr = 0, a, left_len;
1309 #define MAX_IN_USE 64
1310         bool in_use[MAX_IN_USE];
1311         /* to speed up finding unused numbers within [1 .. MAX_IN_USE - 1] */
1312
1313         char left[MAX_ID_NAME + 8], leftest[MAX_ID_NAME + 8];
1314
1315         while (true) {
1316
1317                 /* phase 1: id already exists? */
1318                 idtest = is_dupid(lb, id, name);
1319
1320                 /* if there is no double, done */
1321                 if (idtest == NULL) return false;
1322
1323                 /* we have a dup; need to make a new name */
1324                 /* quick check so we can reuse one of first MAX_IN_USE - 1 ids if vacant */
1325                 memset(in_use, false, sizeof(in_use));
1326
1327                 /* get name portion, number portion ("name.number") */
1328                 left_len = BLI_split_name_num(left, &nr, name, '.');
1329
1330                 /* if new name will be too long, truncate it */
1331                 if (nr > 999 && left_len > (MAX_ID_NAME - 8)) {  /* assumption: won't go beyond 9999 */
1332                         left[MAX_ID_NAME - 8] = 0;
1333                         left_len = MAX_ID_NAME - 8;
1334                 }
1335                 else if (left_len > (MAX_ID_NAME - 7)) {
1336                         left[MAX_ID_NAME - 7] = 0;
1337                         left_len = MAX_ID_NAME - 7;
1338                 }
1339
1340                 for (idtest = lb->first; idtest; idtest = idtest->next) {
1341                         int nrtest;
1342                         if ( (id != idtest) &&
1343                              !ID_IS_LINKED_DATABLOCK(idtest) &&
1344                              (*name == *(idtest->name + 2)) &&
1345                              STREQLEN(name, idtest->name + 2, left_len) &&
1346                              (BLI_split_name_num(leftest, &nrtest, idtest->name + 2, '.') == left_len)
1347                              )
1348                         {
1349                                 /* will get here at least once, otherwise is_dupid call above would have returned NULL */
1350                                 if (nrtest < MAX_IN_USE)
1351                                         in_use[nrtest] = true;  /* mark as used */
1352                                 if (nr <= nrtest)
1353                                         nr = nrtest + 1;    /* track largest unused */
1354                         }
1355                 }
1356                 /* At this point, 'nr' will typically be at least 1. (but not always) */
1357                 // BLI_assert(nr >= 1);
1358
1359                 /* decide which value of nr to use */
1360                 for (a = 0; a < MAX_IN_USE; a++) {
1361                         if (a >= nr) break;  /* stop when we've checked up to biggest */  /* redundant check */
1362                         if (!in_use[a]) { /* found an unused value */
1363                                 nr = a;
1364                                 /* can only be zero if all potential duplicate names had
1365                                  * nonzero numeric suffixes, which means name itself has
1366                                  * nonzero numeric suffix (else no name conflict and wouldn't
1367                                  * have got here), which means name[left_len] is not a null */
1368                                 break;
1369                         }
1370                 }
1371                 /* At this point, nr is either the lowest unused number within [0 .. MAX_IN_USE - 1],
1372                  * or 1 greater than the largest used number if all those low ones are taken.
1373                  * We can't be bothered to look for the lowest unused number beyond (MAX_IN_USE - 1). */
1374
1375                 /* If the original name has no numeric suffix,
1376                  * rather than just chopping and adding numbers,
1377                  * shave off the end chars until we have a unique name.
1378                  * Check the null terminators match as well so we don't get Cube.000 -> Cube.00 */
1379                 if (nr == 0 && name[left_len] == '\0') {
1380                         int len;
1381                         /* FIXME: this code will never be executed, because either nr will be
1382                          * at least 1, or name will not end at left_len! */
1383                         BLI_assert(0);
1384
1385                         len = left_len - 1;
1386                         idtest = is_dupid(lb, id, name);
1387
1388                         while (idtest && len > 1) {
1389                                 name[len--] = '\0';
1390                                 idtest = is_dupid(lb, id, name);
1391                         }
1392                         if (idtest == NULL) return true;
1393                         /* otherwise just continue and use a number suffix */
1394                 }
1395
1396                 if (nr > 999 && left_len > (MAX_ID_NAME - 8)) {
1397                         /* this would overflow name buffer */
1398                         left[MAX_ID_NAME - 8] = 0;
1399                         /* left_len = MAX_ID_NAME - 8; */ /* for now this isn't used again */
1400                         memcpy(name, left, sizeof(char) * (MAX_ID_NAME - 7));
1401                         continue;
1402                 }
1403                 /* this format specifier is from hell... */
1404                 BLI_snprintf(name, sizeof(id->name) - 2, "%s.%.3d", left, nr);
1405
1406                 return true;
1407         }
1408
1409 #undef MAX_IN_USE
1410 }
1411
1412 /*
1413  * Only for local blocks: external en indirect blocks already have a
1414  * unique ID.
1415  *
1416  * return true: created a new name
1417  */
1418
1419 bool new_id(ListBase *lb, ID *id, const char *tname)
1420 {
1421         bool result;
1422         char name[MAX_ID_NAME - 2];
1423
1424         /* if library, don't rename */
1425         if (ID_IS_LINKED_DATABLOCK(id))
1426                 return false;
1427
1428         /* if no libdata given, look up based on ID */
1429         if (lb == NULL)
1430                 lb = which_libbase(G.main, GS(id->name));
1431
1432         /* if no name given, use name of current ID
1433          * else make a copy (tname args can be const) */
1434         if (tname == NULL)
1435                 tname = id->name + 2;
1436
1437         BLI_strncpy(name, tname, sizeof(name));
1438
1439         if (name[0] == '\0') {
1440                 /* disallow empty names */
1441                 BLI_strncpy(name, DATA_(ID_FALLBACK_NAME), sizeof(name));
1442         }
1443         else {
1444                 /* disallow non utf8 chars,
1445                  * the interface checks for this but new ID's based on file names don't */
1446                 BLI_utf8_invalid_strip(name, strlen(name));
1447         }
1448
1449         result = check_for_dupid(lb, id, name);
1450         strcpy(id->name + 2, name);
1451
1452         /* This was in 2.43 and previous releases
1453          * however all data in blender should be sorted, not just duplicate names
1454          * sorting should not hurt, but noting just incase it alters the way other
1455          * functions work, so sort every time */
1456 #if 0
1457         if (result)
1458                 id_sort_by_name(lb, id);
1459 #endif
1460
1461         id_sort_by_name(lb, id);
1462
1463         return result;
1464 }
1465
1466 /**
1467  * Pull an ID out of a library (make it local). Only call this for IDs that
1468  * don't have other library users.
1469  */
1470 void id_clear_lib_data_ex(Main *bmain, ID *id, bool id_in_mainlist)
1471 {
1472         bNodeTree *ntree = NULL;
1473         Key *key = NULL;
1474
1475         BKE_id_lib_local_paths(bmain, id->lib, id);
1476
1477         id_fake_user_clear(id);
1478
1479         id->lib = NULL;
1480         id->tag &= ~(LIB_TAG_INDIRECT | LIB_TAG_EXTERN);
1481         if (id_in_mainlist)
1482                 new_id(which_libbase(bmain, GS(id->name)), id, NULL);
1483
1484         /* Internal bNodeTree blocks inside datablocks also stores id->lib, make sure this stays in sync. */
1485         if ((ntree = ntreeFromID(id))) {
1486                 id_clear_lib_data_ex(bmain, &ntree->id, id_in_mainlist);
1487         }
1488
1489         /* Same goes for shapekeys. */
1490         if ((key = BKE_key_from_id(id))) {
1491                 id_clear_lib_data_ex(bmain, &key->id, id_in_mainlist);
1492         }
1493
1494         if (GS(id->name) == ID_OB) {
1495                 Object *object = (Object *)id;
1496                 if (object->proxy_from != NULL) {
1497                         object->proxy_from->proxy = NULL;
1498                         object->proxy_from->proxy_group = NULL;
1499                 }
1500                 object->proxy = object->proxy_from = object->proxy_group = NULL;
1501         }
1502 }
1503
1504 void id_clear_lib_data(Main *bmain, ID *id)
1505 {
1506         id_clear_lib_data_ex(bmain, id, true);
1507 }
1508
1509 /* next to indirect usage in read/writefile also in editobject.c scene.c */
1510 void BKE_main_id_clear_newpoins(Main *bmain)
1511 {
1512         ListBase *lbarray[MAX_LIBARRAY];
1513         ID *id;
1514         int a;
1515
1516         a = set_listbasepointers(bmain, lbarray);
1517         while (a--) {
1518                 id = lbarray[a]->first;
1519                 while (id) {
1520                         id->newid = NULL;
1521                         id->tag &= ~LIB_TAG_NEW;
1522                         id = id->next;
1523                 }
1524         }
1525 }
1526
1527 static void lib_indirect_test_id(ID *id, const Library *lib)
1528 {
1529 #define LIBTAG(a) \
1530         if (a && a->id.lib) { a->id.tag &= ~LIB_TAG_INDIRECT; a->id.tag |= LIB_TAG_EXTERN; } (void)0
1531
1532         if (ID_IS_LINKED_DATABLOCK(id)) {
1533                 /* datablocks that were indirectly related are now direct links
1534                  * without this, appending data that has a link to other data will fail to write */
1535                 if (lib && id->lib->parent == lib) {
1536                         id_lib_extern(id);
1537                 }
1538                 return;
1539         }
1540
1541         if (GS(id->name) == ID_OB) {
1542                 Object *ob = (Object *)id;
1543                 Mesh *me;
1544
1545                 int a;
1546
1547 #if 0   /* XXX OLD ANIMSYS, NLASTRIPS ARE NO LONGER USED */
1548                 /* XXX old animation system! -------------------------------------- */
1549                 {
1550                         bActionStrip *strip;
1551                         for (strip = ob->nlastrips.first; strip; strip = strip->next) {
1552                                 LIBTAG(strip->object);
1553                                 LIBTAG(strip->act);
1554                                 LIBTAG(strip->ipo);
1555                         }
1556                 }
1557                 /* XXX: new animation system needs something like this? */
1558 #endif
1559
1560                 for (a = 0; a < ob->totcol; a++) {
1561                         LIBTAG(ob->mat[a]);
1562                 }
1563
1564                 LIBTAG(ob->dup_group);
1565                 LIBTAG(ob->proxy);
1566
1567                 me = ob->data;
1568                 LIBTAG(me);
1569         }
1570
1571 #undef LIBTAG
1572 }
1573
1574 /** Make linked datablocks local.
1575  *
1576  * \param bmain Almost certainly G.main.
1577  * \param lib If not NULL, only make local datablocks from this library.
1578  * \param untagged_only If true, only make local datablocks not tagged with LIB_TAG_PRE_EXISTING.
1579  * \param set_fake If true, set fake user on all localized datablocks (except group and objects ones).
1580  */
1581 void BKE_library_make_local(Main *bmain, const Library *lib, const bool untagged_only, const bool set_fake)
1582 {
1583         ListBase *lbarray[MAX_LIBARRAY];
1584         ID *id, *idn;
1585         int a;
1586
1587         a = set_listbasepointers(bmain, lbarray);
1588         while (a--) {
1589                 id = lbarray[a]->first;
1590
1591                 while (id) {
1592                         id->newid = NULL;
1593                         idn = id->next;      /* id is possibly being inserted again */
1594
1595                         /* The check on the second line (LIB_TAG_PRE_EXISTING) is done so its
1596                          * possible to tag data you don't want to be made local, used for
1597                          * appending data, so any libdata already linked wont become local
1598                          * (very nasty to discover all your links are lost after appending)
1599                          * */
1600                         if (id->tag & (LIB_TAG_EXTERN | LIB_TAG_INDIRECT | LIB_TAG_NEW) &&
1601                             ((untagged_only == false) || !(id->tag & LIB_TAG_PRE_EXISTING)))
1602                         {
1603                                 if (lib == NULL || id->lib == lib) {
1604                                         if (id->lib) {
1605                                                 /* for Make Local > All we should be calling id_make_local,
1606                                                  * but doing that breaks append (see #36003 and #36006), we
1607                                                  * we should make it work with all datablocks and id.us==0 */
1608                                                 id_clear_lib_data(bmain, id); /* sets 'id->tag' */
1609
1610                                                 /* why sort alphabetically here but not in
1611                                                  * id_clear_lib_data() ? - campbell */
1612                                                 id_sort_by_name(lbarray[a], id);
1613                                         }
1614                                         else {
1615                                                 id->tag &= ~(LIB_TAG_EXTERN | LIB_TAG_INDIRECT | LIB_TAG_NEW);
1616                                         }
1617                                 }
1618
1619                                 if (set_fake) {
1620                                         if (!ELEM(GS(id->name), ID_OB, ID_GR)) {
1621                                                 /* do not set fake user on objects, groups (instancing) */
1622                                                 id_fake_user_set(id);
1623                                         }
1624                                 }
1625                         }
1626
1627                         id = idn;
1628                 }
1629         }
1630
1631         a = set_listbasepointers(bmain, lbarray);
1632         while (a--) {
1633                 for (id = lbarray[a]->first; id; id = id->next)
1634                         lib_indirect_test_id(id, lib);
1635         }
1636 }
1637
1638 /**
1639  * Use after setting the ID's name
1640  * When name exists: call 'new_id'
1641  */
1642 void BLI_libblock_ensure_unique_name(Main *bmain, const char *name)
1643 {
1644         ListBase *lb;
1645         ID *idtest;
1646
1647
1648         lb = which_libbase(bmain, GS(name));
1649         if (lb == NULL) return;
1650
1651         /* search for id */
1652         idtest = BLI_findstring(lb, name + 2, offsetof(ID, name) + 2);
1653
1654         if (idtest && !new_id(lb, idtest, idtest->name + 2)) {
1655                 id_sort_by_name(lb, idtest);
1656         }
1657 }
1658
1659 /**
1660  * Sets the name of a block to name, suitably adjusted for uniqueness.
1661  */
1662 void BKE_libblock_rename(Main *bmain, ID *id, const char *name)
1663 {
1664         ListBase *lb = which_libbase(bmain, GS(id->name));
1665         new_id(lb, id, name);
1666 }
1667
1668 /**
1669  * Returns in name the name of the block, with a 3-character prefix prepended
1670  * indicating whether it comes from a library, has a fake user, or no users.
1671  */
1672 void BKE_id_ui_prefix(char name[MAX_ID_NAME + 1], const ID *id)
1673 {
1674         name[0] = id->lib ? (ID_MISSING(id) ? 'M' : 'L') : ' ';
1675         name[1] = (id->flag & LIB_FAKEUSER) ? 'F' : ((id->us == 0) ? '0' : ' ');
1676         name[2] = ' ';
1677
1678         strcpy(name + 3, id->name + 2);
1679 }
1680
1681 void BKE_library_filepath_set(Library *lib, const char *filepath)
1682 {
1683         /* in some cases this is used to update the absolute path from the
1684          * relative */
1685         if (lib->name != filepath) {
1686                 BLI_strncpy(lib->name, filepath, sizeof(lib->name));
1687         }
1688
1689         BLI_strncpy(lib->filepath, filepath, sizeof(lib->filepath));
1690
1691         /* not essential but set filepath is an absolute copy of value which
1692          * is more useful if its kept in sync */
1693         if (BLI_path_is_rel(lib->filepath)) {
1694                 /* note that the file may be unsaved, in this case, setting the
1695                  * filepath on an indirectly linked path is not allowed from the
1696                  * outliner, and its not really supported but allow from here for now
1697                  * since making local could cause this to be directly linked - campbell
1698                  */
1699                 const char *basepath = lib->parent ? lib->parent->filepath : G.main->name;
1700                 BLI_path_abs(lib->filepath, basepath);
1701         }
1702 }