Library: Add assert to catch unsupported copy flags combination
[blender.git] / 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_cachefile_types.h"
49 #include "DNA_camera_types.h"
50 #include "DNA_group_types.h"
51 #include "DNA_gpencil_types.h"
52 #include "DNA_ipo_types.h"
53 #include "DNA_key_types.h"
54 #include "DNA_lamp_types.h"
55 #include "DNA_lattice_types.h"
56 #include "DNA_linestyle_types.h"
57 #include "DNA_material_types.h"
58 #include "DNA_mesh_types.h"
59 #include "DNA_meta_types.h"
60 #include "DNA_modifier_types.h"
61 #include "DNA_movieclip_types.h"
62 #include "DNA_mask_types.h"
63 #include "DNA_node_types.h"
64 #include "DNA_object_types.h"
65 #include "DNA_scene_types.h"
66 #include "DNA_screen_types.h"
67 #include "DNA_speaker_types.h"
68 #include "DNA_sound_types.h"
69 #include "DNA_text_types.h"
70 #include "DNA_vfont_types.h"
71 #include "DNA_windowmanager_types.h"
72 #include "DNA_world_types.h"
73
74 #include "BLI_blenlib.h"
75 #include "BLI_utildefines.h"
76 #include "BLI_ghash.h"
77 #include "BLI_linklist.h"
78 #include "BLI_memarena.h"
79 #include "BLI_mempool.h"
80 #include "BLI_string_utils.h"
81
82 #include "BLI_threads.h"
83 #include "BLT_translation.h"
84
85 #include "BKE_action.h"
86 #include "BKE_animsys.h"
87 #include "BKE_armature.h"
88 #include "BKE_bpath.h"
89 #include "BKE_brush.h"
90 #include "BKE_camera.h"
91 #include "BKE_cachefile.h"
92 #include "BKE_context.h"
93 #include "BKE_curve.h"
94 #include "BKE_depsgraph.h"
95 #include "BKE_font.h"
96 #include "BKE_global.h"
97 #include "BKE_group.h"
98 #include "BKE_gpencil.h"
99 #include "BKE_idcode.h"
100 #include "BKE_idprop.h"
101 #include "BKE_image.h"
102 #include "BKE_key.h"
103 #include "BKE_lamp.h"
104 #include "BKE_lattice.h"
105 #include "BKE_library.h"
106 #include "BKE_library_query.h"
107 #include "BKE_library_remap.h"
108 #include "BKE_linestyle.h"
109 #include "BKE_mesh.h"
110 #include "BKE_material.h"
111 #include "BKE_main.h"
112 #include "BKE_mball.h"
113 #include "BKE_mask.h"
114 #include "BKE_movieclip.h"
115 #include "BKE_node.h"
116 #include "BKE_object.h"
117 #include "BKE_paint.h"
118 #include "BKE_particle.h"
119 #include "BKE_packedFile.h"
120 #include "BKE_sound.h"
121 #include "BKE_speaker.h"
122 #include "BKE_scene.h"
123 #include "BKE_text.h"
124 #include "BKE_texture.h"
125 #include "BKE_world.h"
126
127 #include "DEG_depsgraph.h"
128
129 #include "RNA_access.h"
130
131 #include "IMB_imbuf.h"
132 #include "IMB_imbuf_types.h"
133
134 #include "atomic_ops.h"
135
136 //#define DEBUG_TIME
137
138 #ifdef DEBUG_TIME
139 #  include "PIL_time_utildefines.h"
140 #endif
141
142 /* GS reads the memory pointed at in a specific ordering. 
143  * only use this definition, makes little and big endian systems
144  * work fine, in conjunction with MAKE_ID */
145
146 /* ************* general ************************ */
147
148
149 /* this has to be called from each make_local_* func, we could call
150  * from id_make_local() but then the make local functions would not be self
151  * contained.
152  * also note that the id _must_ have a library - campbell */
153 void BKE_id_lib_local_paths(Main *bmain, Library *lib, ID *id)
154 {
155         const char *bpath_user_data[2] = {bmain->name, lib->filepath};
156
157         BKE_bpath_traverse_id(bmain, id,
158                               BKE_bpath_relocate_visitor,
159                               BKE_BPATH_TRAVERSE_SKIP_MULTIFILE,
160                               (void *)bpath_user_data);
161 }
162
163 void id_lib_extern(ID *id)
164 {
165         if (id && ID_IS_LINKED(id)) {
166                 BLI_assert(BKE_idcode_is_linkable(GS(id->name)));
167                 if (id->tag & LIB_TAG_INDIRECT) {
168                         id->tag -= LIB_TAG_INDIRECT;
169                         id->tag |= LIB_TAG_EXTERN;
170                 }
171         }
172 }
173
174 /* ensure we have a real user */
175 /* Note: Now that we have flags, we could get rid of the 'fake_user' special case, flags are enough to ensure
176  *       we always have a real user.
177  *       However, ID_REAL_USERS is used in several places outside of core library.c, so think we can wait later
178  *       to make this change... */
179 void id_us_ensure_real(ID *id)
180 {
181         if (id) {
182                 const int limit = ID_FAKE_USERS(id);
183                 id->tag |= LIB_TAG_EXTRAUSER;
184                 if (id->us <= limit) {
185                         if (id->us < limit || ((id->us == limit) && (id->tag & LIB_TAG_EXTRAUSER_SET))) {
186                                 printf("ID user count error: %s (from '%s')\n", id->name, id->lib ? id->lib->filepath : "[Main]");
187                                 BLI_assert(0);
188                         }
189                         id->us = limit + 1;
190                         id->tag |= LIB_TAG_EXTRAUSER_SET;
191                 }
192         }
193 }
194
195 void id_us_clear_real(ID *id)
196 {
197         if (id && (id->tag & LIB_TAG_EXTRAUSER)) {
198                 if (id->tag & LIB_TAG_EXTRAUSER_SET) {
199                         id->us--;
200                         BLI_assert(id->us >= ID_FAKE_USERS(id));
201                 }
202                 id->tag &= ~(LIB_TAG_EXTRAUSER | LIB_TAG_EXTRAUSER_SET);
203         }
204 }
205
206 /**
207  * Same as \a id_us_plus, but does not handle lib indirect -> extern.
208  * Only used by readfile.c so far, but simpler/safer to keep it here nonetheless.
209  */
210 void id_us_plus_no_lib(ID *id)
211 {
212         if (id) {
213                 if ((id->tag & LIB_TAG_EXTRAUSER) && (id->tag & LIB_TAG_EXTRAUSER_SET)) {
214                         BLI_assert(id->us >= 1);
215                         /* No need to increase count, just tag extra user as no more set.
216                          * Avoids annoying & inconsistent +1 in user count. */
217                         id->tag &= ~LIB_TAG_EXTRAUSER_SET;
218                 }
219                 else {
220                         BLI_assert(id->us >= 0);
221                         id->us++;
222                 }
223         }
224 }
225
226
227 void id_us_plus(ID *id)
228 {
229         if (id) {
230                 id_us_plus_no_lib(id);
231                 id_lib_extern(id);
232         }
233 }
234
235 /* decrements the user count for *id. */
236 void id_us_min(ID *id)
237 {
238         if (id) {
239                 const int limit = ID_FAKE_USERS(id);
240
241                 if (id->us <= limit) {
242                         printf("ID user decrement error: %s (from '%s'): %d <= %d\n",
243                                id->name, id->lib ? id->lib->filepath : "[Main]", id->us, limit);
244                         BLI_assert(0);
245                         id->us = limit;
246                 }
247                 else {
248                         id->us--;
249                 }
250
251                 if ((id->us == limit) && (id->tag & LIB_TAG_EXTRAUSER)) {
252                         /* We need an extra user here, but never actually incremented user count for it so far, do it now. */
253                         id_us_ensure_real(id);
254                 }
255         }
256 }
257
258 void id_fake_user_set(ID *id)
259 {
260         if (id && !(id->flag & LIB_FAKEUSER)) {
261                 id->flag |= LIB_FAKEUSER;
262                 id_us_plus(id);
263         }
264 }
265
266 void id_fake_user_clear(ID *id)
267 {
268         if (id && (id->flag & LIB_FAKEUSER)) {
269                 id->flag &= ~LIB_FAKEUSER;
270                 id_us_min(id);
271         }
272 }
273
274 void BKE_id_clear_newpoin(ID *id)
275 {
276         if (id->newid) {
277                 id->newid->tag &= ~LIB_TAG_NEW;
278         }
279         id->newid = NULL;
280 }
281
282 static int id_expand_local_callback(
283         void *UNUSED(user_data), struct ID *id_self, struct ID **id_pointer, int cb_flag)
284 {
285         if (cb_flag & IDWALK_CB_PRIVATE) {
286                 return IDWALK_RET_NOP;
287         }
288
289         /* Can hapen that we get unlinkable ID here, e.g. with shapekey referring to itself (through drivers)...
290          * Just skip it, shape key can only be either indirectly linked, or fully local, period.
291          * And let's curse one more time that stupid useless shapekey ID type! */
292         if (*id_pointer && *id_pointer != id_self && BKE_idcode_is_linkable(GS((*id_pointer)->name))) {
293                 id_lib_extern(*id_pointer);
294         }
295
296         return IDWALK_RET_NOP;
297 }
298
299 /**
300  * Expand ID usages of given id as 'extern' (and no more indirect) linked data. Used by ID copy/make_local functions.
301  */
302 void BKE_id_expand_local(Main *bmain, ID *id)
303 {
304         BKE_library_foreach_ID_link(bmain, id, id_expand_local_callback, NULL, IDWALK_READONLY);
305 }
306
307 /**
308  * Ensure new (copied) ID is fully made local.
309  */
310 void BKE_id_copy_ensure_local(Main *bmain, const ID *old_id, ID *new_id)
311 {
312         if (ID_IS_LINKED(old_id)) {
313                 BKE_id_expand_local(bmain, new_id);
314                 BKE_id_lib_local_paths(bmain, old_id->lib, new_id);
315         }
316 }
317
318 /**
319  * Generic 'make local' function, works for most of datablock types...
320  */
321 void BKE_id_make_local_generic(Main *bmain, ID *id, const bool id_in_mainlist, const bool lib_local)
322 {
323         bool is_local = false, is_lib = false;
324
325         /* - only lib users: do nothing (unless force_local is set)
326          * - only local users: set flag
327          * - mixed: make copy
328          * In case we make a whole lib's content local, we always want to localize, and we skip remapping (done later).
329          */
330
331         if (!ID_IS_LINKED(id)) {
332                 return;
333         }
334
335         BKE_library_ID_test_usages(bmain, id, &is_local, &is_lib);
336
337         if (lib_local || is_local) {
338                 if (!is_lib) {
339                         id_clear_lib_data_ex(bmain, id, id_in_mainlist);
340                         BKE_id_expand_local(bmain, id);
341                 }
342                 else {
343                         ID *id_new;
344
345                         /* Should not fail in expected usecases, but id_copy does not copy Scene e.g. */
346                         if (id_copy(bmain, id, &id_new, false)) {
347                                 id_new->us = 0;
348
349                                 /* setting newid is mandatory for complex make_lib_local logic... */
350                                 ID_NEW_SET(id, id_new);
351                                 Key *key = BKE_key_from_id(id), *key_new = BKE_key_from_id(id);
352                                 if (key && key_new) {
353                                         ID_NEW_SET(key, key_new);
354                                 }
355                                 bNodeTree *ntree = ntreeFromID(id), *ntree_new = ntreeFromID(id_new);
356                                 if (ntree && ntree_new) {
357                                         ID_NEW_SET(ntree, ntree_new);
358                                 }
359
360                                 if (!lib_local) {
361                                         BKE_libblock_remap(bmain, id, id_new, ID_REMAP_SKIP_INDIRECT_USAGE);
362                                 }
363                         }
364                 }
365         }
366 }
367
368 /**
369  * Calls the appropriate make_local method for the block, unless test is set.
370  *
371  * \note Always set ID->newid pointer in case it gets duplicated...
372  *
373  * \param lib_local Special flag used when making a whole library's content local, it needs specific handling.
374  *
375  * \return true if the block can be made local.
376  */
377 bool id_make_local(Main *bmain, ID *id, const bool test, const bool lib_local)
378 {
379         /* We don't care whether ID is directly or indirectly linked in case we are making a whole lib local... */
380         if (!lib_local && (id->tag & LIB_TAG_INDIRECT)) {
381                 return false;
382         }
383
384         switch ((ID_Type)GS(id->name)) {
385                 case ID_SCE:
386                         if (!test) BKE_scene_make_local(bmain, (Scene *)id, lib_local);
387                         return true;
388                 case ID_OB:
389                         if (!test) BKE_object_make_local(bmain, (Object *)id, lib_local);
390                         return true;
391                 case ID_ME:
392                         if (!test) BKE_mesh_make_local(bmain, (Mesh *)id, lib_local);
393                         return true;
394                 case ID_CU:
395                         if (!test) BKE_curve_make_local(bmain, (Curve *)id, lib_local);
396                         return true;
397                 case ID_MB:
398                         if (!test) BKE_mball_make_local(bmain, (MetaBall *)id, lib_local);
399                         return true;
400                 case ID_MA:
401                         if (!test) BKE_material_make_local(bmain, (Material *)id, lib_local);
402                         return true;
403                 case ID_TE:
404                         if (!test) BKE_texture_make_local(bmain, (Tex *)id, lib_local);
405                         return true;
406                 case ID_IM:
407                         if (!test) BKE_image_make_local(bmain, (Image *)id, lib_local);
408                         return true;
409                 case ID_LT:
410                         if (!test) BKE_lattice_make_local(bmain, (Lattice *)id, lib_local);
411                         return true;
412                 case ID_LA:
413                         if (!test) BKE_lamp_make_local(bmain, (Lamp *)id, lib_local);
414                         return true;
415                 case ID_CA:
416                         if (!test) BKE_camera_make_local(bmain, (Camera *)id, lib_local);
417                         return true;
418                 case ID_SPK:
419                         if (!test) BKE_speaker_make_local(bmain, (Speaker *)id, lib_local);
420                         return true;
421                 case ID_WO:
422                         if (!test) BKE_world_make_local(bmain, (World *)id, lib_local);
423                         return true;
424                 case ID_VF:
425                         if (!test) BKE_vfont_make_local(bmain, (VFont *)id, lib_local);
426                         return true;
427                 case ID_TXT:
428                         if (!test) BKE_text_make_local(bmain, (Text *)id, lib_local);
429                         return true;
430                 case ID_SO:
431                         if (!test) BKE_sound_make_local(bmain, (bSound *)id, lib_local);
432                         return true;
433                 case ID_GR:
434                         if (!test) BKE_group_make_local(bmain, (Group *)id, lib_local);
435                         return true;
436                 case ID_AR:
437                         if (!test) BKE_armature_make_local(bmain, (bArmature *)id, lib_local);
438                         return true;
439                 case ID_AC:
440                         if (!test) BKE_action_make_local(bmain, (bAction *)id, lib_local);
441                         return true;
442                 case ID_NT:
443                         if (!test) ntreeMakeLocal(bmain, (bNodeTree *)id, true, lib_local);
444                         return true;
445                 case ID_BR:
446                         if (!test) BKE_brush_make_local(bmain, (Brush *)id, lib_local);
447                         return true;
448                 case ID_PA:
449                         if (!test) BKE_particlesettings_make_local(bmain, (ParticleSettings *)id, lib_local);
450                         return true;
451                 case ID_GD:
452                         if (!test) BKE_gpencil_make_local(bmain, (bGPdata *)id, lib_local);
453                         return true;
454                 case ID_MC:
455                         if (!test) BKE_movieclip_make_local(bmain, (MovieClip *)id, lib_local);
456                         return true;
457                 case ID_MSK:
458                         if (!test) BKE_mask_make_local(bmain, (Mask *)id, lib_local);
459                         return true;
460                 case ID_LS:
461                         if (!test) BKE_linestyle_make_local(bmain, (FreestyleLineStyle *)id, lib_local);
462                         return true;
463                 case ID_PAL:
464                         if (!test) BKE_palette_make_local(bmain, (Palette *)id, lib_local);
465                         return true;
466                 case ID_PC:
467                         if (!test) BKE_paint_curve_make_local(bmain, (PaintCurve *)id, lib_local);
468                         return true;
469                 case ID_CF:
470                         if (!test) BKE_cachefile_make_local(bmain, (CacheFile *)id, lib_local);
471                         return true;
472                 case ID_SCR:
473                 case ID_LI:
474                 case ID_KE:
475                 case ID_WM:
476                         return false; /* can't be linked */
477                 case ID_IP:
478                         return false; /* deprecated */
479         }
480
481         return false;
482 }
483
484 struct IDCopyLibManagementData {
485         const ID *id_src;
486         ID *id_dst;
487         int flag;
488 };
489
490 /* Increases usercount as required, and remap self ID pointers. */
491 static int id_copy_libmanagement_cb(void *user_data, ID *UNUSED(id_self), ID **id_pointer, int cb_flag)
492 {
493         struct IDCopyLibManagementData *data = user_data;
494         ID *id = *id_pointer;
495
496         /* Remap self-references to new copied ID. */
497         if (id == data->id_src) {
498                 /* We cannot use id_self here, it is not *always* id_dst (thanks to $£!+@#&/? nodetrees). */
499                 id = *id_pointer = data->id_dst;
500         }
501
502         /* Increase used IDs refcount if needed and required. */
503         if ((data->flag & LIB_ID_CREATE_NO_USER_REFCOUNT) == 0 && (cb_flag & IDWALK_CB_USER)) {
504                 id_us_plus(id);
505         }
506
507         return IDWALK_RET_NOP;
508 }
509
510 /**
511  * Generic entry point for copying a datablock (new API).
512  *
513  * \note Copy is only affecting given data-block (no ID used by copied one will be affected, besides usercount).
514  *       There is only one exception, if LIB_ID_COPY_ACTIONS is defined, actions used by animdata will be duplicated.
515  *
516  * \note Usercount of new copy is always set to 1.
517  *
518  * \param bmain Main database, may be NULL only if LIB_ID_CREATE_NO_MAIN is specified.
519  * \param id Source datablock.
520  * \param r_newid Pointer to new (copied) ID pointer.
521  * \param flag Set of copy options, see DNA_ID.h enum for details (leave to zero for default, full copy).
522  * \param test If set, do not do any copy, just test whether copy is supported.
523  * \return False when copying that ID type is not supported, true otherwise.
524  */
525 /* XXX TODO remove test thing, *all* IDs should be copyable that way! */
526 bool BKE_id_copy_ex(Main *bmain, const ID *id, ID **r_newid, const int flag, const bool test)
527 {
528 #define LIB_ID_TYPES_NOCOPY ID_LI, ID_SCR, ID_WM,  /* Not supported */ \
529                             ID_IP  /* Deprecated */
530
531         BLI_assert(test || (r_newid != NULL));
532         /* Early output is source is NULL. */
533         if (id == NULL) {
534                 return false;
535         }
536         /* Make sure destination pointer is all good. */
537         if ((flag & LIB_ID_CREATE_NO_ALLOCATE) == 0) {
538                 if (r_newid != NULL) {
539                         *r_newid = NULL;
540                 }
541         }
542         else {
543                 if (r_newid != NULL && *r_newid != NULL) {
544                         /* Allow some garbage non-initialized memory to go in. */
545                         const size_t size = BKE_libblock_get_alloc_info(GS(id->name), NULL);
546                         memset(*r_newid, 0, size);
547                 }
548         }
549         if (ELEM(GS(id->name), LIB_ID_TYPES_NOCOPY)) {
550                 return false;
551         }
552         else if (test) {
553                 return true;
554         }
555
556         BKE_libblock_copy_ex(bmain, id, r_newid, flag);
557
558         switch ((ID_Type)GS(id->name)) {
559                 case ID_SCE:
560                         BKE_scene_copy_data(bmain, (Scene *)*r_newid, (Scene *)id, flag);
561                         break;
562                 case ID_OB:
563                         BKE_object_copy_data(bmain, (Object *)*r_newid, (Object *)id, flag);
564                         break;
565                 case ID_ME:
566                         BKE_mesh_copy_data(bmain, (Mesh *)*r_newid, (Mesh *)id, flag);
567                         break;
568                 case ID_CU:
569                         BKE_curve_copy_data(bmain, (Curve *)*r_newid, (Curve *)id, flag);
570                         break;
571                 case ID_MB:
572                         BKE_mball_copy_data(bmain, (MetaBall *)*r_newid, (MetaBall *)id, flag);
573                         break;
574                 case ID_MA:
575                         BKE_material_copy_data(bmain, (Material *)*r_newid, (Material *)id, flag);
576                         break;
577                 case ID_TE:
578                         BKE_texture_copy_data(bmain, (Tex *)*r_newid, (Tex *)id, flag);
579                         break;
580                 case ID_IM:
581                         BKE_image_copy_data(bmain, (Image *)*r_newid, (Image *)id, flag);
582                         break;
583                 case ID_LT:
584                         BKE_lattice_copy_data(bmain, (Lattice *)*r_newid, (Lattice *)id, flag);
585                         break;
586                 case ID_LA:
587                         BKE_lamp_copy_data(bmain, (Lamp *)*r_newid, (Lamp *)id, flag);
588                         break;
589                 case ID_SPK:
590                         BKE_speaker_copy_data(bmain, (Speaker *)*r_newid, (Speaker *)id, flag);
591                         break;
592                 case ID_CA:
593                         BKE_camera_copy_data(bmain, (Camera *)*r_newid, (Camera *)id, flag);
594                         break;
595                 case ID_KE:
596                         BKE_key_copy_data(bmain, (Key *)*r_newid, (Key *)id, flag);
597                         break;
598                 case ID_WO:
599                         BKE_world_copy_data(bmain, (World *)*r_newid, (World *)id, flag);
600                         break;
601                 case ID_TXT:
602                         BKE_text_copy_data(bmain, (Text *)*r_newid, (Text *)id, flag);
603                         break;
604                 case ID_GR:
605                         BKE_group_copy_data(bmain, (Group *)*r_newid, (Group *)id, flag);
606                         break;
607                 case ID_AR:
608                         BKE_armature_copy_data(bmain, (bArmature *)*r_newid, (bArmature *)id, flag);
609                         break;
610                 case ID_AC:
611                         BKE_action_copy_data(bmain, (bAction *)*r_newid, (bAction *)id, flag);
612                         break;
613                 case ID_NT:
614                         BKE_node_tree_copy_data(bmain, (bNodeTree *)*r_newid, (bNodeTree *)id, flag);
615                         break;
616                 case ID_BR:
617                         BKE_brush_copy_data(bmain, (Brush *)*r_newid, (Brush *)id, flag);
618                         break;
619                 case ID_PA:
620                         BKE_particlesettings_copy_data(bmain, (ParticleSettings *)*r_newid, (ParticleSettings *)id, flag);
621                         break;
622                 case ID_GD:
623                         BKE_gpencil_copy_data(bmain, (bGPdata *)*r_newid, (bGPdata *)id, flag);
624                         break;
625                 case ID_MC:
626                         BKE_movieclip_copy_data(bmain, (MovieClip *)*r_newid, (MovieClip *)id, flag);
627                         break;
628                 case ID_MSK:
629                         BKE_mask_copy_data(bmain, (Mask *)*r_newid, (Mask *)id, flag);
630                         break;
631                 case ID_LS:
632                         BKE_linestyle_copy_data(bmain, (FreestyleLineStyle *)*r_newid, (FreestyleLineStyle *)id, flag);
633                         break;
634                 case ID_PAL:
635                         BKE_palette_copy_data(bmain, (Palette *)*r_newid, (Palette *)id, flag);
636                         break;
637                 case ID_PC:
638                         BKE_paint_curve_copy_data(bmain, (PaintCurve *)*r_newid, (PaintCurve *)id, flag);
639                         break;
640                 case ID_CF:
641                         BKE_cachefile_copy_data(bmain, (CacheFile *)*r_newid, (CacheFile *)id, flag);
642                         break;
643                 case ID_SO:
644                         BKE_sound_copy_data(bmain, (bSound *)*r_newid, (bSound *)id, flag);
645                         break;
646                 case ID_VF:
647                         BKE_vfont_copy_data(bmain, (VFont *)*r_newid, (VFont *)id, flag);
648                         break;
649                 case ID_LI:
650                 case ID_SCR:
651                 case ID_WM:
652                 case ID_IP:
653                         BLI_assert(0);  /* Should have been rejected at start of function! */
654                         break;
655         }
656
657         /* Update ID refcount, remap pointers to self in new ID. */
658         struct IDCopyLibManagementData data = {.id_src = id, .id_dst = *r_newid, .flag = flag};
659         BKE_library_foreach_ID_link(bmain, *r_newid, id_copy_libmanagement_cb, &data, IDWALK_NOP);
660
661         /* Do not make new copy local in case we are copying outside of main...
662          * XXX TODO: is this behavior OK, or should we need own flag to control that? */
663         if ((flag & LIB_ID_CREATE_NO_MAIN) == 0) {
664                 BLI_assert((flag & LIB_ID_COPY_KEEP_LIB) == 0);
665                 BKE_id_copy_ensure_local(bmain, id, *r_newid);
666         }
667         else {
668                 (*r_newid)->lib = id->lib;
669         }
670
671         return true;
672 }
673
674 /**
675  * Invokes the appropriate copy method for the block and returns the result in
676  * newid, unless test. Returns true if the block can be copied.
677  */
678 bool id_copy(Main *bmain, const ID *id, ID **newid, bool test)
679 {
680         return BKE_id_copy_ex(bmain, id, newid, 0, test);
681 }
682
683 /** Does *not* set ID->newid pointer. */
684 bool id_single_user(bContext *C, ID *id, PointerRNA *ptr, PropertyRNA *prop)
685 {
686         ID *newid = NULL;
687         PointerRNA idptr;
688         
689         if (id) {
690                 /* if property isn't editable, we're going to have an extra block hanging around until we save */
691                 if (RNA_property_editable(ptr, prop)) {
692                         if (id_copy(CTX_data_main(C), id, &newid, false) && newid) {
693                                 /* copy animation actions too */
694                                 BKE_animdata_copy_id_action(id, false);
695                                 /* us is 1 by convention, but RNA_property_pointer_set
696                                  * will also increment it, so set it to zero */
697                                 newid->us = 0;
698
699                                 /* assign copy */
700                                 RNA_id_pointer_create(newid, &idptr);
701                                 RNA_property_pointer_set(ptr, prop, idptr);
702                                 RNA_property_update(C, ptr, prop);
703                                 
704                                 return true;
705                         }
706                 }
707         }
708         
709         return false;
710 }
711
712 static int libblock_management_us_plus(void *UNUSED(user_data), ID *UNUSED(id_self), ID **id_pointer, int cb_flag)
713 {
714         if (cb_flag & IDWALK_CB_USER) {
715                 id_us_plus(*id_pointer);
716         }
717         if (cb_flag & IDWALK_CB_USER_ONE) {
718                 id_us_ensure_real(*id_pointer);
719         }
720
721         return IDWALK_RET_NOP;
722 }
723
724 static int libblock_management_us_min(void *UNUSED(user_data), ID *UNUSED(id_self), ID **id_pointer, int cb_flag)
725 {
726         if (cb_flag & IDWALK_CB_USER) {
727                 id_us_min(*id_pointer);
728         }
729         /* We can do nothing in IDWALK_CB_USER_ONE case! */
730
731         return IDWALK_RET_NOP;
732 }
733
734 /** Add a 'NO_MAIN' datablock to given main (also sets usercounts of its IDs if needed). */
735 void BKE_libblock_management_main_add(Main *bmain, void *idv)
736 {
737         ID *id = idv;
738
739         BLI_assert(bmain != NULL);
740         if ((id->tag & LIB_TAG_NO_MAIN) == 0) {
741                 return;
742         }
743
744         if ((id->tag & LIB_TAG_NOT_ALLOCATED) != 0) {
745                 /* We cannot add non-allocated ID to Main! */
746                 return;
747         }
748
749         /* We cannot allow non-userrefcounting IDs in Main database! */
750         if ((id->tag & LIB_TAG_NO_USER_REFCOUNT) != 0) {
751                 BKE_library_foreach_ID_link(bmain, id, libblock_management_us_plus, NULL, IDWALK_NOP);
752         }
753
754         ListBase *lb = which_libbase(bmain, GS(id->name));
755         BKE_main_lock(bmain);
756         BLI_addtail(lb, id);
757         new_id(lb, id, NULL);
758         /* alphabetic insertion: is in new_id */
759         id->tag &= ~(LIB_TAG_NO_MAIN | LIB_TAG_NO_USER_REFCOUNT);
760         bmain->is_memfile_undo_written = false;
761         BKE_main_unlock(bmain);
762 }
763
764 /** Remove a datablock from given main (set it to 'NO_MAIN' status). */
765 void BKE_libblock_management_main_remove(Main *bmain, void *idv)
766 {
767         ID *id = idv;
768
769         BLI_assert(bmain != NULL);
770         if ((id->tag & LIB_TAG_NO_MAIN) != 0) {
771                 return;
772         }
773
774         /* For now, allow userrefcounting IDs to get out of Main - can be handy in some cases... */
775
776         ListBase *lb = which_libbase(bmain, GS(id->name));
777         BKE_main_lock(bmain);
778         BLI_remlink(lb, id);
779         id->tag |= LIB_TAG_NO_MAIN;
780         bmain->is_memfile_undo_written = false;
781         BKE_main_unlock(bmain);
782 }
783
784 void BKE_libblock_management_usercounts_set(Main *bmain, void *idv)
785 {
786         ID *id = idv;
787
788         if ((id->tag & LIB_TAG_NO_USER_REFCOUNT) == 0) {
789                 return;
790         }
791
792         BKE_library_foreach_ID_link(bmain, id, libblock_management_us_plus, NULL, IDWALK_NOP);
793         id->tag &= ~LIB_TAG_NO_USER_REFCOUNT;
794 }
795
796 void BKE_libblock_management_usercounts_clear(Main *bmain, void *idv)
797 {
798         ID *id = idv;
799
800         /* We do not allow IDs in Main database to not be userrefcounting. */
801         if ((id->tag & LIB_TAG_NO_USER_REFCOUNT) != 0 || (id->tag & LIB_TAG_NO_MAIN) != 0) {
802                 return;
803         }
804
805         BKE_library_foreach_ID_link(bmain, id, libblock_management_us_min, NULL, IDWALK_NOP);
806         id->tag |= LIB_TAG_NO_USER_REFCOUNT;
807 }
808
809 ListBase *which_libbase(Main *mainlib, short type)
810 {
811         switch ((ID_Type)type) {
812                 case ID_SCE:
813                         return &(mainlib->scene);
814                 case ID_LI:
815                         return &(mainlib->library);
816                 case ID_OB:
817                         return &(mainlib->object);
818                 case ID_ME:
819                         return &(mainlib->mesh);
820                 case ID_CU:
821                         return &(mainlib->curve);
822                 case ID_MB:
823                         return &(mainlib->mball);
824                 case ID_MA:
825                         return &(mainlib->mat);
826                 case ID_TE:
827                         return &(mainlib->tex);
828                 case ID_IM:
829                         return &(mainlib->image);
830                 case ID_LT:
831                         return &(mainlib->latt);
832                 case ID_LA:
833                         return &(mainlib->lamp);
834                 case ID_CA:
835                         return &(mainlib->camera);
836                 case ID_IP:
837                         return &(mainlib->ipo);
838                 case ID_KE:
839                         return &(mainlib->key);
840                 case ID_WO:
841                         return &(mainlib->world);
842                 case ID_SCR:
843                         return &(mainlib->screen);
844                 case ID_VF:
845                         return &(mainlib->vfont);
846                 case ID_TXT:
847                         return &(mainlib->text);
848                 case ID_SPK:
849                         return &(mainlib->speaker);
850                 case ID_SO:
851                         return &(mainlib->sound);
852                 case ID_GR:
853                         return &(mainlib->group);
854                 case ID_AR:
855                         return &(mainlib->armature);
856                 case ID_AC:
857                         return &(mainlib->action);
858                 case ID_NT:
859                         return &(mainlib->nodetree);
860                 case ID_BR:
861                         return &(mainlib->brush);
862                 case ID_PA:
863                         return &(mainlib->particle);
864                 case ID_WM:
865                         return &(mainlib->wm);
866                 case ID_GD:
867                         return &(mainlib->gpencil);
868                 case ID_MC:
869                         return &(mainlib->movieclip);
870                 case ID_MSK:
871                         return &(mainlib->mask);
872                 case ID_LS:
873                         return &(mainlib->linestyle);
874                 case ID_PAL:
875                         return &(mainlib->palettes);
876                 case ID_PC:
877                         return &(mainlib->paintcurves);
878                 case ID_CF:
879                         return &(mainlib->cachefiles);
880         }
881         return NULL;
882 }
883
884 /**
885  * Clear or set given tags for all ids in listbase (runtime tags).
886  */
887 void BKE_main_id_tag_listbase(ListBase *lb, const int tag, const bool value)
888 {
889         ID *id;
890         if (value) {
891                 for (id = lb->first; id; id = id->next) {
892                         id->tag |= tag;
893                 }
894         }
895         else {
896                 const int ntag = ~tag;
897                 for (id = lb->first; id; id = id->next) {
898                         id->tag &= ntag;
899                 }
900         }
901 }
902
903 /**
904  * Clear or set given tags for all ids of given type in bmain (runtime tags).
905  */
906 void BKE_main_id_tag_idcode(struct Main *mainvar, const short type, const int tag, const bool value)
907 {
908         ListBase *lb = which_libbase(mainvar, type);
909
910         BKE_main_id_tag_listbase(lb, tag, value);
911 }
912
913 /**
914  * Clear or set given tags for all ids in bmain (runtime tags).
915  */
916 void BKE_main_id_tag_all(struct Main *mainvar, const int tag, const bool value)
917 {
918         ListBase *lbarray[MAX_LIBARRAY];
919         int a;
920
921         a = set_listbasepointers(mainvar, lbarray);
922         while (a--) {
923                 BKE_main_id_tag_listbase(lbarray[a], tag, value);
924         }
925 }
926
927
928 /**
929  * Clear or set given flags for all ids in listbase (persistent flags).
930  */
931 void BKE_main_id_flag_listbase(ListBase *lb, const int flag, const bool value)
932 {
933         ID *id;
934         if (value) {
935                 for (id = lb->first; id; id = id->next)
936                         id->tag |= flag;
937         }
938         else {
939                 const int nflag = ~flag;
940                 for (id = lb->first; id; id = id->next)
941                         id->tag &= nflag;
942         }
943 }
944
945 /**
946  * Clear or set given flags for all ids in bmain (persistent flags).
947  */
948 void BKE_main_id_flag_all(Main *bmain, const int flag, const bool value)
949 {
950         ListBase *lbarray[MAX_LIBARRAY];
951         int a;
952         a = set_listbasepointers(bmain, lbarray);
953         while (a--) {
954                 BKE_main_id_flag_listbase(lbarray[a], flag, value);
955         }
956 }
957
958 void BKE_main_lib_objects_recalc_all(Main *bmain)
959 {
960         Object *ob;
961
962         /* flag for full recalc */
963         for (ob = bmain->object.first; ob; ob = ob->id.next) {
964                 if (ID_IS_LINKED(ob)) {
965                         DAG_id_tag_update(&ob->id, OB_RECALC_OB | OB_RECALC_DATA | OB_RECALC_TIME);
966                 }
967         }
968
969         DAG_id_type_tag(bmain, ID_OB);
970 }
971
972 /**
973  * puts into array *lb pointers to all the ListBase structs in main,
974  * and returns the number of them as the function result. This is useful for
975  * generic traversal of all the blocks in a Main (by traversing all the
976  * lists in turn), without worrying about block types.
977  *
978  * \note MAX_LIBARRAY define should match this code */
979 int set_listbasepointers(Main *main, ListBase **lb)
980 {
981         /* BACKWARDS! also watch order of free-ing! (mesh<->mat), first items freed last.
982          * This is important because freeing data decreases usercounts of other datablocks,
983          * if this data is its self freed it can crash. */
984         lb[INDEX_ID_LI] = &(main->library);  /* Libraries may be accessed from pretty much any other ID... */
985         lb[INDEX_ID_IP] = &(main->ipo);
986         lb[INDEX_ID_AC] = &(main->action); /* moved here to avoid problems when freeing with animato (aligorith) */
987         lb[INDEX_ID_KE] = &(main->key);
988         lb[INDEX_ID_GD] = &(main->gpencil); /* referenced by nodes, objects, view, scene etc, before to free after. */
989         lb[INDEX_ID_NT] = &(main->nodetree);
990         lb[INDEX_ID_IM] = &(main->image);
991         lb[INDEX_ID_TE] = &(main->tex);
992         lb[INDEX_ID_MA] = &(main->mat);
993         lb[INDEX_ID_VF] = &(main->vfont);
994         
995         /* Important!: When adding a new object type,
996          * the specific data should be inserted here 
997          */
998
999         lb[INDEX_ID_AR] = &(main->armature);
1000
1001         lb[INDEX_ID_CF] = &(main->cachefiles);
1002         lb[INDEX_ID_ME] = &(main->mesh);
1003         lb[INDEX_ID_CU] = &(main->curve);
1004         lb[INDEX_ID_MB] = &(main->mball);
1005
1006         lb[INDEX_ID_LT] = &(main->latt);
1007         lb[INDEX_ID_LA] = &(main->lamp);
1008         lb[INDEX_ID_CA] = &(main->camera);
1009
1010         lb[INDEX_ID_TXT] = &(main->text);
1011         lb[INDEX_ID_SO]  = &(main->sound);
1012         lb[INDEX_ID_GR]  = &(main->group);
1013         lb[INDEX_ID_PAL] = &(main->palettes);
1014         lb[INDEX_ID_PC]  = &(main->paintcurves);
1015         lb[INDEX_ID_BR]  = &(main->brush);
1016         lb[INDEX_ID_PA]  = &(main->particle);
1017         lb[INDEX_ID_SPK] = &(main->speaker);
1018
1019         lb[INDEX_ID_WO]  = &(main->world);
1020         lb[INDEX_ID_MC]  = &(main->movieclip);
1021         lb[INDEX_ID_SCR] = &(main->screen);
1022         lb[INDEX_ID_OB]  = &(main->object);
1023         lb[INDEX_ID_LS]  = &(main->linestyle); /* referenced by scenes */
1024         lb[INDEX_ID_SCE] = &(main->scene);
1025         lb[INDEX_ID_WM]  = &(main->wm);
1026         lb[INDEX_ID_MSK] = &(main->mask);
1027         
1028         lb[INDEX_ID_NULL] = NULL;
1029
1030         return (MAX_LIBARRAY - 1);
1031 }
1032
1033 /* *********** ALLOC AND FREE *****************
1034  *
1035  * BKE_libblock_free(ListBase *lb, ID *id )
1036  * provide a list-basis and datablock, but only ID is read
1037  *
1038  * void *BKE_libblock_alloc(ListBase *lb, type, name)
1039  * inserts in list and returns a new ID
1040  *
1041  * **************************** */
1042
1043 /**
1044  * Get allocation size fo a given datablock type and optionally allocation name.
1045  */
1046 size_t BKE_libblock_get_alloc_info(short type, const char **name)
1047 {
1048 #define CASE_RETURN(id_code, type)  \
1049         case id_code:                   \
1050                 do {                        \
1051                         if (name != NULL) {     \
1052                                 *name = #type;      \
1053                         }                       \
1054                         return sizeof(type);    \
1055                 } while(0)
1056
1057         switch ((ID_Type)type) {
1058                 CASE_RETURN(ID_SCE, Scene);
1059                 CASE_RETURN(ID_LI,  Library);
1060                 CASE_RETURN(ID_OB,  Object);
1061                 CASE_RETURN(ID_ME,  Mesh);
1062                 CASE_RETURN(ID_CU,  Curve);
1063                 CASE_RETURN(ID_MB,  MetaBall);
1064                 CASE_RETURN(ID_MA,  Material);
1065                 CASE_RETURN(ID_TE,  Tex);
1066                 CASE_RETURN(ID_IM,  Image);
1067                 CASE_RETURN(ID_LT,  Lattice);
1068                 CASE_RETURN(ID_LA,  Lamp);
1069                 CASE_RETURN(ID_CA,  Camera);
1070                 CASE_RETURN(ID_IP,  Ipo);
1071                 CASE_RETURN(ID_KE,  Key);
1072                 CASE_RETURN(ID_WO,  World);
1073                 CASE_RETURN(ID_SCR, bScreen);
1074                 CASE_RETURN(ID_VF,  VFont);
1075                 CASE_RETURN(ID_TXT, Text);
1076                 CASE_RETURN(ID_SPK, Speaker);
1077                 CASE_RETURN(ID_SO,  bSound);
1078                 CASE_RETURN(ID_GR,  Group);
1079                 CASE_RETURN(ID_AR,  bArmature);
1080                 CASE_RETURN(ID_AC,  bAction);
1081                 CASE_RETURN(ID_NT,  bNodeTree);
1082                 CASE_RETURN(ID_BR,  Brush);
1083                 CASE_RETURN(ID_PA,  ParticleSettings);
1084                 CASE_RETURN(ID_WM,  wmWindowManager);
1085                 CASE_RETURN(ID_GD,  bGPdata);
1086                 CASE_RETURN(ID_MC,  MovieClip);
1087                 CASE_RETURN(ID_MSK, Mask);
1088                 CASE_RETURN(ID_LS,  FreestyleLineStyle);
1089                 CASE_RETURN(ID_PAL, Palette);
1090                 CASE_RETURN(ID_PC,  PaintCurve);
1091                 CASE_RETURN(ID_CF,  CacheFile);
1092         }
1093         return 0;
1094 #undef CASE_RETURN
1095 }
1096
1097 /**
1098  * Allocates and returns memory of the right size for the specified block type,
1099  * initialized to zero.
1100  */
1101 void *BKE_libblock_alloc_notest(short type)
1102 {
1103         const char *name;
1104         size_t size = BKE_libblock_get_alloc_info(type, &name);
1105         if (size != 0) {
1106                 return MEM_callocN(size, name);
1107         }
1108         BLI_assert(!"Request to allocate unknown data type");
1109         return NULL;
1110 }
1111
1112 /**
1113  * Allocates and returns a block of the specified type, with the specified name
1114  * (adjusted as necessary to ensure uniqueness), and appended to the specified list.
1115  * The user count is set to 1, all other content (apart from name and links) being
1116  * initialized to zero.
1117  */
1118 void *BKE_libblock_alloc(Main *bmain, short type, const char *name, const int flag)
1119 {
1120         BLI_assert((flag & LIB_ID_CREATE_NO_ALLOCATE) == 0);
1121
1122         ID *id = BKE_libblock_alloc_notest(type);
1123
1124         if (id) {
1125                 if ((flag & LIB_ID_CREATE_NO_MAIN) != 0) {
1126                         id->tag |= LIB_TAG_NO_MAIN;
1127                 }
1128                 if ((flag & LIB_ID_CREATE_NO_USER_REFCOUNT) != 0) {
1129                         id->tag |= LIB_TAG_NO_USER_REFCOUNT;
1130                 }
1131
1132                 id->icon_id = 0;
1133                 *((short *)id->name) = type;
1134                 if ((flag & LIB_ID_CREATE_NO_USER_REFCOUNT) == 0) {
1135                         id->us = 1;
1136                 }
1137                 if ((flag & LIB_ID_CREATE_NO_MAIN) == 0) {
1138                         ListBase *lb = which_libbase(bmain, type);
1139
1140                         BKE_main_lock(bmain);
1141                         BLI_addtail(lb, id);
1142                         new_id(lb, id, name);
1143                         bmain->is_memfile_undo_written = false;
1144                         /* alphabetic insertion: is in new_id */
1145                         BKE_main_unlock(bmain);
1146
1147                         /* TODO to be removed from here! */
1148                         if ((flag & LIB_ID_CREATE_NO_DEG_TAG) == 0) {
1149                                 DAG_id_type_tag(bmain, type);
1150                         }
1151                 }
1152                 else {
1153                         BLI_strncpy(id->name + 2, name, sizeof(id->name) - 2);
1154                 }
1155         }
1156
1157         return id;
1158 }
1159
1160 /**
1161  * Initialize an ID of given type, such that it has valid 'empty' data.
1162  * ID is assumed to be just calloc'ed.
1163  */
1164 void BKE_libblock_init_empty(ID *id)
1165 {
1166         /* Note that only ID types that are not valid when filled of zero should have a callback here. */
1167         switch ((ID_Type)GS(id->name)) {
1168                 case ID_SCE:
1169                         BKE_scene_init((Scene *)id);
1170                         break;
1171                 case ID_LI:
1172                         /* Nothing to do. */
1173                         break;
1174                 case ID_OB:
1175                 {
1176                         Object *ob = (Object *)id;
1177                         ob->type = OB_EMPTY;
1178                         BKE_object_init(ob);
1179                         break;
1180                 }
1181                 case ID_ME:
1182                         BKE_mesh_init((Mesh *)id);
1183                         break;
1184                 case ID_CU:
1185                         BKE_curve_init((Curve *)id);
1186                         break;
1187                 case ID_MB:
1188                         BKE_mball_init((MetaBall *)id);
1189                         break;
1190                 case ID_MA:
1191                         BKE_material_init((Material *)id);
1192                         break;
1193                 case ID_TE:
1194                         BKE_texture_default((Tex *)id);
1195                         break;
1196                 case ID_IM:
1197                         BKE_image_init((Image *)id);
1198                         break;
1199                 case ID_LT:
1200                         BKE_lattice_init((Lattice *)id);
1201                         break;
1202                 case ID_LA:
1203                         BKE_lamp_init((Lamp *)id);
1204                         break;
1205                 case ID_SPK:
1206                         BKE_speaker_init((Speaker *)id);
1207                         break;
1208                 case ID_CA:
1209                         BKE_camera_init((Camera *)id);
1210                         break;
1211                 case ID_WO:
1212                         BKE_world_init((World *)id);
1213                         break;
1214                 case ID_SCR:
1215                         /* Nothing to do. */
1216                         break;
1217                 case ID_VF:
1218                         BKE_vfont_init((VFont *)id);
1219                         break;
1220                 case ID_TXT:
1221                         BKE_text_init((Text *)id);
1222                         break;
1223                 case ID_SO:
1224                         /* Another fuzzy case, think NULLified content is OK here... */
1225                         break;
1226                 case ID_GR:
1227                         /* Nothing to do. */
1228                         break;
1229                 case ID_AR:
1230                         /* Nothing to do. */
1231                         break;
1232                 case ID_AC:
1233                         /* Nothing to do. */
1234                         break;
1235                 case ID_NT:
1236                         ntreeInitDefault((bNodeTree *)id);
1237                         break;
1238                 case ID_BR:
1239                         BKE_brush_init((Brush *)id);
1240                         break;
1241                 case ID_PA:
1242                         /* Nothing to do. */
1243                         break;
1244                 case ID_PC:
1245                         /* Nothing to do. */
1246                         break;
1247                 case ID_GD:
1248                         /* Nothing to do. */
1249                         break;
1250                 case ID_MSK:
1251                         /* Nothing to do. */
1252                         break;
1253                 case ID_LS:
1254                         BKE_linestyle_init((FreestyleLineStyle *)id);
1255                         break;
1256                 case ID_CF:
1257                         BKE_cachefile_init((CacheFile *)id);
1258                         break;
1259                 case ID_KE:
1260                         /* Shapekeys are a complex topic too - they depend on their 'user' data type...
1261                          * They are not linkable, though, so it should never reach here anyway. */
1262                         BLI_assert(0);
1263                         break;
1264                 case ID_WM:
1265                         /* We should never reach this. */
1266                         BLI_assert(0);
1267                         break;
1268                 case ID_IP:
1269                         /* Should not be needed - animation from lib pre-2.5 is broken anyway. */
1270                         BLI_assert(0);
1271                         break;
1272                 default:
1273                         BLI_assert(0);  /* Should never reach this point... */
1274         }
1275 }
1276
1277 /* by spec, animdata is first item after ID */
1278 /* and, trust that BKE_animdata_from_id() will only find AnimData for valid ID-types */
1279 static void id_copy_animdata(Main *bmain, ID *id, const bool do_action)
1280 {
1281         AnimData *adt = BKE_animdata_from_id(id);
1282         
1283         if (adt) {
1284                 IdAdtTemplate *iat = (IdAdtTemplate *)id;
1285                 iat->adt = BKE_animdata_copy(bmain, iat->adt, do_action); /* could be set to false, need to investigate */
1286         }
1287 }
1288
1289 void BKE_libblock_copy_ex(Main *bmain, const ID *id, ID **r_newid, const int flag)
1290 {
1291         ID *new_id = *r_newid;
1292
1293         /* Grrrrrrrrr... Not adding 'root' nodetrees to bmain.... grrrrrrrrrrrrrrrrrrrr! */
1294         /* This is taken from original ntree copy code, might be weak actually? */
1295         const bool use_nodetree_alloc_exception = ((GS(id->name) == ID_NT) && (bmain != NULL) &&
1296                                                    (BLI_findindex(&bmain->nodetree, id) < 0));
1297
1298         BLI_assert((flag & LIB_ID_CREATE_NO_MAIN) != 0 || bmain != NULL);
1299         BLI_assert((flag & LIB_ID_CREATE_NO_MAIN) != 0 || (flag & LIB_ID_CREATE_NO_ALLOCATE) == 0);
1300         BLI_assert((flag & LIB_ID_CREATE_NO_MAIN) == 0 || (flag & LIB_ID_CREATE_NO_USER_REFCOUNT) != 0);
1301
1302         if ((flag & LIB_ID_CREATE_NO_ALLOCATE) != 0) {
1303                 /* r_newid already contains pointer to allocated memory. */
1304                 /* TODO do we want to memset(0) whole mem before filling it? */
1305                 BLI_strncpy(new_id->name, id->name, sizeof(new_id->name));
1306                 new_id->us = 0;
1307                 new_id->tag |= LIB_TAG_NOT_ALLOCATED | LIB_TAG_NO_MAIN | LIB_TAG_NO_USER_REFCOUNT;
1308                 /* TODO Do we want/need to copy more from ID struct itself? */
1309         }
1310         else {
1311                 new_id = BKE_libblock_alloc(bmain, GS(id->name), id->name + 2, flag | (use_nodetree_alloc_exception ? LIB_ID_CREATE_NO_MAIN : 0));
1312         }
1313         BLI_assert(new_id != NULL);
1314
1315         const size_t id_len = BKE_libblock_get_alloc_info(GS(new_id->name), NULL);
1316         const size_t id_offset = sizeof(ID);
1317         if ((int)id_len - (int)id_offset > 0) { /* signed to allow neg result */ /* XXX ????? */
1318                 const char *cp = (const char *)id;
1319                 char *cpn = (char *)new_id;
1320
1321                 memcpy(cpn + id_offset, cp + id_offset, id_len - id_offset);
1322         }
1323
1324         if (id->properties) {
1325                 new_id->properties = IDP_CopyProperty_ex(id->properties, flag);
1326         }
1327
1328         /* the duplicate should get a copy of the animdata */
1329         BLI_assert((flag & LIB_ID_COPY_ACTIONS) == 0 || (flag & LIB_ID_CREATE_NO_MAIN) == 0);
1330         id_copy_animdata(bmain, new_id, (flag & LIB_ID_COPY_ACTIONS) != 0 && (flag & LIB_ID_CREATE_NO_MAIN) == 0);
1331
1332         if ((flag & LIB_ID_CREATE_NO_DEG_TAG) == 0 && (flag & LIB_ID_CREATE_NO_MAIN) == 0) {
1333                 DAG_id_type_tag(bmain, GS(new_id->name));
1334         }
1335
1336         *r_newid = new_id;
1337 }
1338
1339 /* used everywhere in blenkernel */
1340 void *BKE_libblock_copy(Main *bmain, const ID *id)
1341 {
1342         ID *idn;
1343
1344         BKE_libblock_copy_ex(bmain, id, &idn, 0);
1345
1346         return idn;
1347 }
1348
1349 void *BKE_libblock_copy_nolib(const ID *id, const bool do_action)
1350 {
1351         ID *idn;
1352
1353         BKE_libblock_copy_ex(NULL, id, &idn, LIB_ID_CREATE_NO_MAIN | LIB_ID_CREATE_NO_USER_REFCOUNT | (do_action ? LIB_ID_COPY_ACTIONS : 0));
1354
1355         return idn;
1356 }
1357
1358 void BKE_library_free(Library *lib)
1359 {
1360         if (lib->packedfile)
1361                 freePackedFile(lib->packedfile);
1362 }
1363
1364 Main *BKE_main_new(void)
1365 {
1366         Main *bmain = MEM_callocN(sizeof(Main), "new main");
1367         bmain->eval_ctx = DEG_evaluation_context_new(DAG_EVAL_VIEWPORT);
1368         bmain->lock = MEM_mallocN(sizeof(SpinLock), "main lock");
1369         BLI_spin_init((SpinLock *)bmain->lock);
1370         return bmain;
1371 }
1372
1373 void BKE_main_free(Main *mainvar)
1374 {
1375         /* also call when reading a file, erase all, etc */
1376         ListBase *lbarray[MAX_LIBARRAY];
1377         int a;
1378
1379         MEM_SAFE_FREE(mainvar->blen_thumb);
1380
1381         a = set_listbasepointers(mainvar, lbarray);
1382         while (a--) {
1383                 ListBase *lb = lbarray[a];
1384                 ID *id;
1385                 
1386                 while ( (id = lb->first) ) {
1387 #if 1
1388                         BKE_libblock_free_ex(mainvar, id, false, false);
1389 #else
1390                         /* errors freeing ID's can be hard to track down,
1391                          * enable this so valgrind will give the line number in its error log */
1392                         switch (a) {
1393                                 case   0: BKE_libblock_free_ex(mainvar, id, false, false); break;
1394                                 case   1: BKE_libblock_free_ex(mainvar, id, false, false); break;
1395                                 case   2: BKE_libblock_free_ex(mainvar, id, false, false); break;
1396                                 case   3: BKE_libblock_free_ex(mainvar, id, false, false); break;
1397                                 case   4: BKE_libblock_free_ex(mainvar, id, false, false); break;
1398                                 case   5: BKE_libblock_free_ex(mainvar, id, false, false); break;
1399                                 case   6: BKE_libblock_free_ex(mainvar, id, false, false); break;
1400                                 case   7: BKE_libblock_free_ex(mainvar, id, false, false); break;
1401                                 case   8: BKE_libblock_free_ex(mainvar, id, false, false); break;
1402                                 case   9: BKE_libblock_free_ex(mainvar, id, false, false); break;
1403                                 case  10: BKE_libblock_free_ex(mainvar, id, false, false); break;
1404                                 case  11: BKE_libblock_free_ex(mainvar, id, false, false); break;
1405                                 case  12: BKE_libblock_free_ex(mainvar, id, false, false); break;
1406                                 case  13: BKE_libblock_free_ex(mainvar, id, false, false); break;
1407                                 case  14: BKE_libblock_free_ex(mainvar, id, false, false); break;
1408                                 case  15: BKE_libblock_free_ex(mainvar, id, false, false); break;
1409                                 case  16: BKE_libblock_free_ex(mainvar, id, false, false); break;
1410                                 case  17: BKE_libblock_free_ex(mainvar, id, false, false); break;
1411                                 case  18: BKE_libblock_free_ex(mainvar, id, false, false); break;
1412                                 case  19: BKE_libblock_free_ex(mainvar, id, false, false); break;
1413                                 case  20: BKE_libblock_free_ex(mainvar, id, false, false); break;
1414                                 case  21: BKE_libblock_free_ex(mainvar, id, false, false); break;
1415                                 case  22: BKE_libblock_free_ex(mainvar, id, false, false); break;
1416                                 case  23: BKE_libblock_free_ex(mainvar, id, false, false); break;
1417                                 case  24: BKE_libblock_free_ex(mainvar, id, false, false); break;
1418                                 case  25: BKE_libblock_free_ex(mainvar, id, false, false); break;
1419                                 case  26: BKE_libblock_free_ex(mainvar, id, false, false); break;
1420                                 case  27: BKE_libblock_free_ex(mainvar, id, false, false); break;
1421                                 case  28: BKE_libblock_free_ex(mainvar, id, false, false); break;
1422                                 case  29: BKE_libblock_free_ex(mainvar, id, false, false); break;
1423                                 case  30: BKE_libblock_free_ex(mainvar, id, false, false); break;
1424                                 case  31: BKE_libblock_free_ex(mainvar, id, false, false); break;
1425                                 case  32: BKE_libblock_free_ex(mainvar, id, false, false); break;
1426                                 case  33: BKE_libblock_free_ex(mainvar, id, false, false); break;
1427                                 case  34: BKE_libblock_free_ex(mainvar, id, false, false); break;
1428                                 default:
1429                                         BLI_assert(0);
1430                                         break;
1431                         }
1432 #endif
1433                 }
1434         }
1435
1436         if (mainvar->relations) {
1437                 BKE_main_relations_free(mainvar);
1438         }
1439
1440         BLI_spin_end((SpinLock *)mainvar->lock);
1441         MEM_freeN(mainvar->lock);
1442         DEG_evaluation_context_free(mainvar->eval_ctx);
1443         MEM_freeN(mainvar);
1444 }
1445
1446 void BKE_main_lock(struct Main *bmain)
1447 {
1448         BLI_spin_lock((SpinLock *) bmain->lock);
1449 }
1450
1451 void BKE_main_unlock(struct Main *bmain)
1452 {
1453         BLI_spin_unlock((SpinLock *) bmain->lock);
1454 }
1455
1456
1457 static int main_relations_create_cb(void *user_data, ID *id_self, ID **id_pointer, int cb_flag)
1458 {
1459         MainIDRelations *rel = user_data;
1460
1461         if (*id_pointer) {
1462                 MainIDRelationsEntry *entry, **entry_p;
1463
1464                 entry = BLI_mempool_alloc(rel->entry_pool);
1465                 if (BLI_ghash_ensure_p(rel->id_user_to_used, id_self, (void ***)&entry_p)) {
1466                         entry->next = *entry_p;
1467                 }
1468                 else {
1469                         entry->next = NULL;
1470                 }
1471                 entry->id_pointer = id_pointer;
1472                 entry->usage_flag = cb_flag;
1473                 *entry_p = entry;
1474
1475                 entry = BLI_mempool_alloc(rel->entry_pool);
1476                 if (BLI_ghash_ensure_p(rel->id_used_to_user, *id_pointer, (void ***)&entry_p)) {
1477                         entry->next = *entry_p;
1478                 }
1479                 else {
1480                         entry->next = NULL;
1481                 }
1482                 entry->id_pointer = (ID **)id_self;
1483                 entry->usage_flag = cb_flag;
1484                 *entry_p = entry;
1485         }
1486
1487         return IDWALK_RET_NOP;
1488 }
1489
1490 /** Generate the mappings between used IDs and their users, and vice-versa. */
1491 void BKE_main_relations_create(Main *bmain)
1492 {
1493         ListBase *lbarray[MAX_LIBARRAY];
1494         ID *id;
1495         int a;
1496
1497         if (bmain->relations != NULL) {
1498                 BKE_main_relations_free(bmain);
1499         }
1500
1501         bmain->relations = MEM_mallocN(sizeof(*bmain->relations), __func__);
1502         bmain->relations->id_used_to_user = BLI_ghash_new(BLI_ghashutil_ptrhash, BLI_ghashutil_ptrcmp, __func__);
1503         bmain->relations->id_user_to_used = BLI_ghash_new(BLI_ghashutil_ptrhash, BLI_ghashutil_ptrcmp, __func__);
1504         bmain->relations->entry_pool = BLI_mempool_create(sizeof(MainIDRelationsEntry), 128, 128, BLI_MEMPOOL_NOP);
1505
1506         for (a = set_listbasepointers(bmain, lbarray); a--; ) {
1507                 for (id = lbarray[a]->first; id; id = id->next) {
1508                         BKE_library_foreach_ID_link(NULL, id, main_relations_create_cb, bmain->relations, IDWALK_READONLY);
1509                 }
1510         }
1511 }
1512
1513 void BKE_main_relations_free(Main *bmain)
1514 {
1515         if (bmain->relations) {
1516                 if (bmain->relations->id_used_to_user) {
1517                         BLI_ghash_free(bmain->relations->id_used_to_user, NULL, NULL);
1518                 }
1519                 if (bmain->relations->id_user_to_used) {
1520                         BLI_ghash_free(bmain->relations->id_user_to_used, NULL, NULL);
1521                 }
1522                 BLI_mempool_destroy(bmain->relations->entry_pool);
1523                 MEM_freeN(bmain->relations);
1524                 bmain->relations = NULL;
1525         }
1526 }
1527
1528 /**
1529  * Generates a raw .blend file thumbnail data from given image.
1530  *
1531  * \param bmain If not NULL, also store generated data in this Main.
1532  * \param img ImBuf image to generate thumbnail data from.
1533  * \return The generated .blend file raw thumbnail data.
1534  */
1535 BlendThumbnail *BKE_main_thumbnail_from_imbuf(Main *bmain, ImBuf *img)
1536 {
1537         BlendThumbnail *data = NULL;
1538
1539         if (bmain) {
1540                 MEM_SAFE_FREE(bmain->blen_thumb);
1541         }
1542
1543         if (img) {
1544                 const size_t sz = BLEN_THUMB_MEMSIZE(img->x, img->y);
1545                 data = MEM_mallocN(sz, __func__);
1546
1547                 IMB_rect_from_float(img);  /* Just in case... */
1548                 data->width = img->x;
1549                 data->height = img->y;
1550                 memcpy(data->rect, img->rect, sz - sizeof(*data));
1551         }
1552
1553         if (bmain) {
1554                 bmain->blen_thumb = data;
1555         }
1556         return data;
1557 }
1558
1559 /**
1560  * Generates an image from raw .blend file thumbnail \a data.
1561  *
1562  * \param bmain Use this bmain->blen_thumb data if given \a data is NULL.
1563  * \param data Raw .blend file thumbnail data.
1564  * \return An ImBuf from given data, or NULL if invalid.
1565  */
1566 ImBuf *BKE_main_thumbnail_to_imbuf(Main *bmain, BlendThumbnail *data)
1567 {
1568         ImBuf *img = NULL;
1569
1570         if (!data && bmain) {
1571                 data = bmain->blen_thumb;
1572         }
1573
1574         if (data) {
1575                 /* Note: we cannot use IMB_allocFromBuffer(), since it tries to dupalloc passed buffer, which will fail
1576                  *       here (we do not want to pass the first two ints!). */
1577                 img = IMB_allocImBuf((unsigned int)data->width, (unsigned int)data->height, 32, IB_rect | IB_metadata);
1578                 memcpy(img->rect, data->rect, BLEN_THUMB_MEMSIZE(data->width, data->height) - sizeof(*data));
1579         }
1580
1581         return img;
1582 }
1583
1584 /**
1585  * Generates an empty (black) thumbnail for given Main.
1586  */
1587 void BKE_main_thumbnail_create(struct Main *bmain)
1588 {
1589         MEM_SAFE_FREE(bmain->blen_thumb);
1590
1591         bmain->blen_thumb = MEM_callocN(BLEN_THUMB_MEMSIZE(BLEN_THUMB_SIZE, BLEN_THUMB_SIZE), __func__);
1592         bmain->blen_thumb->width = BLEN_THUMB_SIZE;
1593         bmain->blen_thumb->height = BLEN_THUMB_SIZE;
1594 }
1595
1596 /* ***************** ID ************************ */
1597 ID *BKE_libblock_find_name_ex(struct Main *bmain, const short type, const char *name)
1598 {
1599         ListBase *lb = which_libbase(bmain, type);
1600         BLI_assert(lb != NULL);
1601         return BLI_findstring(lb, name, offsetof(ID, name) + 2);
1602 }
1603 ID *BKE_libblock_find_name(const short type, const char *name)
1604 {
1605         return BKE_libblock_find_name_ex(G.main, type, name);
1606 }
1607
1608
1609 void id_sort_by_name(ListBase *lb, ID *id)
1610 {
1611         ID *idtest;
1612         
1613         /* insert alphabetically */
1614         if (lb->first != lb->last) {
1615                 BLI_remlink(lb, id);
1616                 
1617                 idtest = lb->first;
1618                 while (idtest) {
1619                         if (BLI_strcasecmp(idtest->name, id->name) > 0 || (idtest->lib && !id->lib)) {
1620                                 BLI_insertlinkbefore(lb, idtest, id);
1621                                 break;
1622                         }
1623                         idtest = idtest->next;
1624                 }
1625                 /* as last */
1626                 if (idtest == NULL) {
1627                         BLI_addtail(lb, id);
1628                 }
1629         }
1630         
1631 }
1632
1633 /**
1634  * Check to see if there is an ID with the same name as 'name'.
1635  * Returns the ID if so, if not, returns NULL
1636  */
1637 static ID *is_dupid(ListBase *lb, ID *id, const char *name)
1638 {
1639         ID *idtest = NULL;
1640         
1641         for (idtest = lb->first; idtest; idtest = idtest->next) {
1642                 /* if idtest is not a lib */ 
1643                 if (id != idtest && !ID_IS_LINKED(idtest)) {
1644                         /* do not test alphabetic! */
1645                         /* optimized */
1646                         if (idtest->name[2] == name[0]) {
1647                                 if (STREQ(name, idtest->name + 2)) break;
1648                         }
1649                 }
1650         }
1651         
1652         return idtest;
1653 }
1654
1655 /**
1656  * Check to see if an ID name is already used, and find a new one if so.
1657  * Return true if created a new name (returned in name).
1658  *
1659  * Normally the ID that's being check is already in the ListBase, so ID *id
1660  * points at the new entry.  The Python Library module needs to know what
1661  * the name of a datablock will be before it is appended; in this case ID *id
1662  * id is NULL
1663  */
1664
1665 static bool check_for_dupid(ListBase *lb, ID *id, char *name)
1666 {
1667         ID *idtest;
1668         int nr = 0, a;
1669         size_t left_len;
1670 #define MAX_IN_USE 64
1671         bool in_use[MAX_IN_USE];
1672         /* to speed up finding unused numbers within [1 .. MAX_IN_USE - 1] */
1673
1674         char left[MAX_ID_NAME + 8], leftest[MAX_ID_NAME + 8];
1675
1676         while (true) {
1677
1678                 /* phase 1: id already exists? */
1679                 idtest = is_dupid(lb, id, name);
1680
1681                 /* if there is no double, done */
1682                 if (idtest == NULL) return false;
1683
1684                 /* we have a dup; need to make a new name */
1685                 /* quick check so we can reuse one of first MAX_IN_USE - 1 ids if vacant */
1686                 memset(in_use, false, sizeof(in_use));
1687
1688                 /* get name portion, number portion ("name.number") */
1689                 left_len = BLI_split_name_num(left, &nr, name, '.');
1690
1691                 /* if new name will be too long, truncate it */
1692                 if (nr > 999 && left_len > (MAX_ID_NAME - 8)) {  /* assumption: won't go beyond 9999 */
1693                         left[MAX_ID_NAME - 8] = '\0';
1694                         left_len = MAX_ID_NAME - 8;
1695                 }
1696                 else if (left_len > (MAX_ID_NAME - 7)) {
1697                         left[MAX_ID_NAME - 7] = '\0';
1698                         left_len = MAX_ID_NAME - 7;
1699                 }
1700
1701                 /* Code above may have generated invalid utf-8 string, due to raw truncation.
1702                  * Ensure we get a valid one now! */
1703                 left_len -= (size_t)BLI_utf8_invalid_strip(left, left_len);
1704
1705                 for (idtest = lb->first; idtest; idtest = idtest->next) {
1706                         int nrtest;
1707                         if ( (id != idtest) &&
1708                              !ID_IS_LINKED(idtest) &&
1709                              (*name == *(idtest->name + 2)) &&
1710                              STREQLEN(name, idtest->name + 2, left_len) &&
1711                              (BLI_split_name_num(leftest, &nrtest, idtest->name + 2, '.') == left_len)
1712                              )
1713                         {
1714                                 /* will get here at least once, otherwise is_dupid call above would have returned NULL */
1715                                 if (nrtest < MAX_IN_USE)
1716                                         in_use[nrtest] = true;  /* mark as used */
1717                                 if (nr <= nrtest)
1718                                         nr = nrtest + 1;    /* track largest unused */
1719                         }
1720                 }
1721                 /* At this point, 'nr' will typically be at least 1. (but not always) */
1722                 // BLI_assert(nr >= 1);
1723
1724                 /* decide which value of nr to use */
1725                 for (a = 0; a < MAX_IN_USE; a++) {
1726                         if (a >= nr) break;  /* stop when we've checked up to biggest */  /* redundant check */
1727                         if (!in_use[a]) { /* found an unused value */
1728                                 nr = a;
1729                                 /* can only be zero if all potential duplicate names had
1730                                  * nonzero numeric suffixes, which means name itself has
1731                                  * nonzero numeric suffix (else no name conflict and wouldn't
1732                                  * have got here), which means name[left_len] is not a null */
1733                                 break;
1734                         }
1735                 }
1736                 /* At this point, nr is either the lowest unused number within [0 .. MAX_IN_USE - 1],
1737                  * or 1 greater than the largest used number if all those low ones are taken.
1738                  * We can't be bothered to look for the lowest unused number beyond (MAX_IN_USE - 1). */
1739
1740                 /* If the original name has no numeric suffix, 
1741                  * rather than just chopping and adding numbers, 
1742                  * shave off the end chars until we have a unique name.
1743                  * Check the null terminators match as well so we don't get Cube.000 -> Cube.00 */
1744                 if (nr == 0 && name[left_len] == '\0') {
1745                         size_t len;
1746                         /* FIXME: this code will never be executed, because either nr will be
1747                          * at least 1, or name will not end at left_len! */
1748                         BLI_assert(0);
1749
1750                         len = left_len - 1;
1751                         idtest = is_dupid(lb, id, name);
1752                         
1753                         while (idtest && len > 1) {
1754                                 name[len--] = '\0';
1755                                 idtest = is_dupid(lb, id, name);
1756                         }
1757                         if (idtest == NULL) return true;
1758                         /* otherwise just continue and use a number suffix */
1759                 }
1760                 
1761                 if (nr > 999 && left_len > (MAX_ID_NAME - 8)) {
1762                         /* this would overflow name buffer */
1763                         left[MAX_ID_NAME - 8] = 0;
1764                         /* left_len = MAX_ID_NAME - 8; */ /* for now this isn't used again */
1765                         memcpy(name, left, sizeof(char) * (MAX_ID_NAME - 7));
1766                         continue;
1767                 }
1768                 /* this format specifier is from hell... */
1769                 BLI_snprintf(name, sizeof(id->name) - 2, "%s.%.3d", left, nr);
1770
1771                 return true;
1772         }
1773
1774 #undef MAX_IN_USE
1775 }
1776
1777 /*
1778  * Only for local blocks: external en indirect blocks already have a
1779  * unique ID.
1780  *
1781  * return true: created a new name
1782  */
1783
1784 bool new_id(ListBase *lb, ID *id, const char *tname)
1785 {
1786         bool result;
1787         char name[MAX_ID_NAME - 2];
1788
1789         /* if library, don't rename */
1790         if (ID_IS_LINKED(id))
1791                 return false;
1792
1793         /* if no name given, use name of current ID
1794          * else make a copy (tname args can be const) */
1795         if (tname == NULL)
1796                 tname = id->name + 2;
1797
1798         BLI_strncpy(name, tname, sizeof(name));
1799
1800         if (name[0] == '\0') {
1801                 /* disallow empty names */
1802                 BLI_strncpy(name, DATA_(ID_FALLBACK_NAME), sizeof(name));
1803         }
1804         else {
1805                 /* disallow non utf8 chars,
1806                  * the interface checks for this but new ID's based on file names don't */
1807                 BLI_utf8_invalid_strip(name, strlen(name));
1808         }
1809
1810         result = check_for_dupid(lb, id, name);
1811         strcpy(id->name + 2, name);
1812
1813         /* This was in 2.43 and previous releases
1814          * however all data in blender should be sorted, not just duplicate names
1815          * sorting should not hurt, but noting just incase it alters the way other
1816          * functions work, so sort every time */
1817 #if 0
1818         if (result)
1819                 id_sort_by_name(lb, id);
1820 #endif
1821
1822         id_sort_by_name(lb, id);
1823         
1824         return result;
1825 }
1826
1827 /**
1828  * Pull an ID out of a library (make it local). Only call this for IDs that
1829  * don't have other library users.
1830  */
1831 void id_clear_lib_data_ex(Main *bmain, ID *id, const bool id_in_mainlist)
1832 {
1833         bNodeTree *ntree = NULL;
1834         Key *key = NULL;
1835
1836         BKE_id_lib_local_paths(bmain, id->lib, id);
1837
1838         id_fake_user_clear(id);
1839
1840         id->lib = NULL;
1841         id->tag &= ~(LIB_TAG_INDIRECT | LIB_TAG_EXTERN);
1842         if (id_in_mainlist)
1843                 new_id(which_libbase(bmain, GS(id->name)), id, NULL);
1844
1845         /* Internal bNodeTree blocks inside datablocks also stores id->lib, make sure this stays in sync. */
1846         if ((ntree = ntreeFromID(id))) {
1847                 id_clear_lib_data_ex(bmain, &ntree->id, false);  /* Datablocks' nodetree is never in Main. */
1848         }
1849
1850         /* Same goes for shapekeys. */
1851         if ((key = BKE_key_from_id(id))) {
1852                 id_clear_lib_data_ex(bmain, &key->id, id_in_mainlist);  /* sigh, why are keys in Main? */
1853         }
1854 }
1855
1856 void id_clear_lib_data(Main *bmain, ID *id)
1857 {
1858         id_clear_lib_data_ex(bmain, id, true);
1859 }
1860
1861 /* next to indirect usage in read/writefile also in editobject.c scene.c */
1862 void BKE_main_id_clear_newpoins(Main *bmain)
1863 {
1864         ListBase *lbarray[MAX_LIBARRAY];
1865         ID *id;
1866         int a;
1867
1868         a = set_listbasepointers(bmain, lbarray);
1869         while (a--) {
1870                 id = lbarray[a]->first;
1871                 while (id) {
1872                         id->newid = NULL;
1873                         id->tag &= ~LIB_TAG_NEW;
1874                         id = id->next;
1875                 }
1876         }
1877 }
1878
1879
1880 static void library_make_local_copying_check(ID *id, GSet *loop_tags, MainIDRelations *id_relations, GSet *done_ids)
1881 {
1882         if (BLI_gset_haskey(done_ids, id)) {
1883                 return;  /* Already checked, nothing else to do. */
1884         }
1885
1886         MainIDRelationsEntry *entry = BLI_ghash_lookup(id_relations->id_used_to_user, id);
1887         BLI_gset_insert(loop_tags, id);
1888         for (; entry != NULL; entry = entry->next) {
1889                 ID *par_id = (ID *)entry->id_pointer;  /* used_to_user stores ID pointer, not pointer to ID pointer... */
1890
1891                 /* Our oh-so-beloved 'from' pointers... */
1892                 if (entry->usage_flag & IDWALK_CB_LOOPBACK) {
1893                         /* We totally disregard Object->proxy_from 'usage' here, this one would only generate fake positives. */
1894                         if (GS(par_id->name) == ID_OB) {
1895                                 BLI_assert(((Object *)par_id)->proxy_from == (Object *)id);
1896                                 continue;
1897                         }
1898
1899                         /* Shapekeys are considered 'private' to their owner ID here, and never tagged (since they cannot be linked),
1900                          * so we have to switch effective parent to their owner. */
1901                         if (GS(par_id->name) == ID_KE) {
1902                                 par_id = ((Key *)par_id)->from;
1903                         }
1904                 }
1905
1906                 if (par_id->lib == NULL) {
1907                         /* Local user, early out to avoid some gset querying... */
1908                         continue;
1909                 }
1910                 if (!BLI_gset_haskey(done_ids, par_id)) {
1911                         if (BLI_gset_haskey(loop_tags, par_id)) {
1912                                 /* We are in a 'dependency loop' of IDs, this does not say us anything, skip it.
1913                                  * Note that this is the situation that can lead to archipelagoes of linked data-blocks
1914                                  * (since all of them have non-local users, they would all be duplicated, leading to a loop of unused
1915                                  * linked data-blocks that cannot be freed since they all use each other...). */
1916                                 continue;
1917                         }
1918                         /* Else, recursively check that user ID. */
1919                         library_make_local_copying_check(par_id, loop_tags, id_relations, done_ids);
1920                 }
1921
1922                 if (par_id->tag & LIB_TAG_DOIT) {
1923                         /* This user will be fully local in future, so far so good, nothing to do here but check next user. */
1924                 }
1925                 else {
1926                         /* This user won't be fully local in future, so current ID won't be either. And we are done checking it. */
1927                         id->tag &= ~LIB_TAG_DOIT;
1928                         break;
1929                 }
1930         }
1931         BLI_gset_add(done_ids, id);
1932         BLI_gset_remove(loop_tags, id, NULL);
1933 }
1934
1935 /** Make linked datablocks local.
1936  *
1937  * \param bmain Almost certainly G.main.
1938  * \param lib If not NULL, only make local datablocks from this library.
1939  * \param untagged_only If true, only make local datablocks not tagged with LIB_TAG_PRE_EXISTING.
1940  * \param set_fake If true, set fake user on all localized datablocks (except group and objects ones).
1941  */
1942 /* Note: Old (2.77) version was simply making (tagging) datablocks as local, without actually making any check whether
1943  * they were also indirectly used or not...
1944  *
1945  * Current version uses regular id_make_local callback, with advanced pre-processing step to detect all cases of
1946  * IDs currently indirectly used, but which will be used by local data only once this function is finished.
1947  * This allows to avoid any unneeded duplication of IDs, and hence all time lost afterwards to remove
1948  * orphaned linked data-blocks...
1949  */
1950 void BKE_library_make_local(
1951         Main *bmain, const Library *lib, GHash *old_to_new_ids, const bool untagged_only, const bool set_fake)
1952 {
1953         ListBase *lbarray[MAX_LIBARRAY];
1954         ID *id;
1955         int a;
1956
1957         LinkNode *todo_ids = NULL;
1958         LinkNode *copied_ids = NULL;
1959         MemArena *linklist_mem = BLI_memarena_new(512 * sizeof(*todo_ids), __func__);
1960
1961         GSet *done_ids = BLI_gset_ptr_new(__func__);
1962
1963 #ifdef DEBUG_TIME
1964         TIMEIT_START(make_local);
1965 #endif
1966
1967         BKE_main_relations_create(bmain);
1968
1969 #ifdef DEBUG_TIME
1970         printf("Pre-compute current ID relations: Done.\n");
1971         TIMEIT_VALUE_PRINT(make_local);
1972 #endif
1973
1974         /* Step 1: Detect datablocks to make local. */
1975         for (a = set_listbasepointers(bmain, lbarray); a--; ) {
1976                 id = lbarray[a]->first;
1977
1978                 /* Do not explicitly make local non-linkable IDs (shapekeys, in fact), they are assumed to be handled
1979                  * by real datablocks responsible of them. */
1980                 const bool do_skip = (id && !BKE_idcode_is_linkable(GS(id->name)));
1981
1982                 for (; id; id = id->next) {
1983                         ID *ntree = (ID *)ntreeFromID(id);
1984
1985                         id->tag &= ~LIB_TAG_DOIT;
1986                         if (ntree != NULL) {
1987                                 ntree->tag &= ~LIB_TAG_DOIT;
1988                         }
1989
1990                         if (id->lib == NULL) {
1991                                 id->tag &= ~(LIB_TAG_EXTERN | LIB_TAG_INDIRECT | LIB_TAG_NEW);
1992                         }
1993                         /* The check on the fourth line (LIB_TAG_PRE_EXISTING) is done so its possible to tag data you don't want to
1994                          * be made local, used for appending data, so any libdata already linked wont become local (very nasty
1995                          * to discover all your links are lost after appending).
1996                          * Also, never ever make proxified objects local, would not make any sense. */
1997                         /* Some more notes:
1998                          *   - Shapekeys are never tagged here (since they are not linkable).
1999                          *   - Nodetrees used in materials etc. have to be tagged manually, since they do not exist in Main (!).
2000                          * This is ok-ish on 'make local' side of things (since those are handled by their 'owner' IDs),
2001                          * but complicates slightly the pre-processing of relations between IDs at step 2... */
2002                         else if (!do_skip && id->tag & (LIB_TAG_EXTERN | LIB_TAG_INDIRECT | LIB_TAG_NEW) &&
2003                                  ELEM(lib, NULL, id->lib) &&
2004                                  !(GS(id->name) == ID_OB && ((Object *)id)->proxy_from != NULL) &&
2005                                  ((untagged_only == false) || !(id->tag & LIB_TAG_PRE_EXISTING)))
2006                         {
2007                                 BLI_linklist_prepend_arena(&todo_ids, id, linklist_mem);
2008                                 id->tag |= LIB_TAG_DOIT;
2009
2010                                 /* Tag those nasty non-ID nodetrees, but do not add them to todo list, making them local is handled
2011                                  * by 'owner' ID. This is needed for library_make_local_copying_check() to work OK at step 2. */
2012                                 if (ntree != NULL) {
2013                                         ntree->tag |= LIB_TAG_DOIT;
2014                                 }
2015                         }
2016                         else {
2017                                 /* Linked ID that we won't be making local (needed info for step 2, see below). */
2018                                 BLI_gset_add(done_ids, id);
2019                         }
2020                 }
2021         }
2022
2023 #ifdef DEBUG_TIME
2024         printf("Step 1: Detect datablocks to make local: Done.\n");
2025         TIMEIT_VALUE_PRINT(make_local);
2026 #endif
2027
2028         /* Step 2: Check which datablocks we can directly make local (because they are only used by already, or future,
2029          * local data), others will need to be duplicated. */
2030         GSet *loop_tags = BLI_gset_ptr_new(__func__);
2031         for (LinkNode *it = todo_ids; it; it = it->next) {
2032                 library_make_local_copying_check(it->link, loop_tags, bmain->relations, done_ids);
2033                 BLI_assert(BLI_gset_len(loop_tags) == 0);
2034         }
2035         BLI_gset_free(loop_tags, NULL);
2036         BLI_gset_free(done_ids, NULL);
2037
2038         /* Next step will most likely add new IDs, better to get rid of this mapping now. */
2039         BKE_main_relations_free(bmain);
2040
2041 #ifdef DEBUG_TIME
2042         printf("Step 2: Check which datablocks we can directly make local: Done.\n");
2043         TIMEIT_VALUE_PRINT(make_local);
2044 #endif
2045
2046         /* Step 3: Make IDs local, either directly (quick and simple), or using generic process,
2047          * which involves more complex checks and might instead create a local copy of original linked ID. */
2048         for (LinkNode *it = todo_ids, *it_next; it; it = it_next) {
2049                 it_next = it->next;
2050                 id = it->link;
2051
2052                 if (id->tag & LIB_TAG_DOIT) {
2053                         /* We know all users of this object are local or will be made fully local, even if currently there are
2054                          * some indirect usages. So instead of making a copy that we'll likely get rid of later, directly make
2055                          * that data block local. Saves a tremendous amount of time with complex scenes... */
2056                         id_clear_lib_data_ex(bmain, id, true);
2057                         BKE_id_expand_local(bmain, id);
2058                         id->tag &= ~LIB_TAG_DOIT;
2059                 }
2060                 else {
2061                         /* In this specific case, we do want to make ID local even if it has no local usage yet... */
2062                         if (GS(id->name) == ID_OB) {
2063                                 /* Special case for objects because we don't want proxy pointers to be
2064                                  * cleared yet. This will happen down the road in this function.
2065                                  */
2066                                 BKE_object_make_local_ex(bmain, (Object *)id, true, false);
2067                         }
2068                         else {
2069                                 id_make_local(bmain, id, false, true);
2070                         }
2071
2072                         if (id->newid) {
2073                                 /* Reuse already allocated LinkNode (transferring it from todo_ids to copied_ids). */
2074                                 BLI_linklist_prepend_nlink(&copied_ids, id, it);
2075                         }
2076                 }
2077
2078                 if (set_fake) {
2079                         if (!ELEM(GS(id->name), ID_OB, ID_GR)) {
2080                                 /* do not set fake user on objects, groups (instancing) */
2081                                 id_fake_user_set(id);
2082                         }
2083                 }
2084         }
2085
2086 #ifdef DEBUG_TIME
2087         printf("Step 3: Make IDs local: Done.\n");
2088         TIMEIT_VALUE_PRINT(make_local);
2089 #endif
2090
2091         /* At this point, we are done with directly made local IDs. Now we have to handle duplicated ones, since their
2092          * remaining linked original counterpart may not be needed anymore... */
2093         todo_ids = NULL;
2094
2095         /* Step 4: We have to remap local usages of old (linked) ID to new (local) ID in a separated loop,
2096          * as lbarray ordering is not enough to ensure us we did catch all dependencies
2097          * (e.g. if making local a parent object before its child...). See T48907. */
2098         /* TODO This is now the biggest step by far (in term of processing time). We may be able to gain here by
2099          * using again main->relations mapping, but... this implies BKE_libblock_remap & co to be able to update
2100          * main->relations on the fly. Have to think about it a bit more, and see whether new code is OK first, anyway. */
2101         for (LinkNode *it = copied_ids; it; it = it->next) {
2102                 id = it->link;
2103
2104                 BLI_assert(id->newid != NULL);
2105                 BLI_assert(id->lib != NULL);
2106
2107                 BKE_libblock_remap(bmain, id, id->newid, ID_REMAP_SKIP_INDIRECT_USAGE);
2108                 if (old_to_new_ids) {
2109                         BLI_ghash_insert(old_to_new_ids, id, id->newid);
2110                 }
2111
2112                 /* Special hack for groups... Thing is, since we can't instantiate them here, we need to ensure
2113                  * they remain 'alive' (only instantiation is a real group 'user'... *sigh* See T49722. */
2114                 if (GS(id->name) == ID_GR && (id->tag & LIB_TAG_INDIRECT) != 0) {
2115                         id_us_ensure_real(id->newid);
2116                 }
2117         }
2118
2119 #ifdef DEBUG_TIME
2120         printf("Step 4: Remap local usages of old (linked) ID to new (local) ID: Done.\n");
2121         TIMEIT_VALUE_PRINT(make_local);
2122 #endif
2123
2124         /* Note: Keeping both version of the code (old one being safer, since it still has checks against unused IDs)
2125          * for now, we can remove old one once it has been tested for some time in master... */
2126 #if 1
2127         /* Step 5: proxy 'remapping' hack. */
2128         for (LinkNode *it = copied_ids; it; it = it->next) {
2129                 /* Attempt to re-link copied proxy objects. This allows appending of an entire scene
2130                  * from another blend file into this one, even when that blend file contains proxified
2131                  * armatures that have local references. Since the proxified object needs to be linked
2132                  * (not local), this will only work when the "Localize all" checkbox is disabled.
2133                  * TL;DR: this is a dirty hack on top of an already weak feature (proxies). */
2134                 if (GS(id->name) == ID_OB && ((Object *)id)->proxy != NULL) {
2135                         Object *ob = (Object *)id;
2136                         Object *ob_new = (Object *)id->newid;
2137                         bool is_local = false, is_lib = false;
2138
2139                         /* Proxies only work when the proxified object is linked-in from a library. */
2140                         if (ob->proxy->id.lib == NULL) {
2141                                 printf("Warning, proxy object %s will loose its link to %s, because the "
2142                                        "proxified object is local.\n", id->newid->name, ob->proxy->id.name);
2143                                 continue;
2144                         }
2145
2146                         BKE_library_ID_test_usages(bmain, id, &is_local, &is_lib);
2147
2148                         /* We can only switch the proxy'ing to a made-local proxy if it is no longer
2149                          * referred to from a library. Not checking for local use; if new local proxy
2150                          * was not used locally would be a nasty bug! */
2151                         if (is_local || is_lib) {
2152                                 printf("Warning, made-local proxy object %s will loose its link to %s, "
2153                                        "because the linked-in proxy is referenced (is_local=%i, is_lib=%i).\n",
2154                                        id->newid->name, ob->proxy->id.name, is_local, is_lib);
2155                         }
2156                         else {
2157                                 /* we can switch the proxy'ing from the linked-in to the made-local proxy.
2158                                  * BKE_object_make_proxy() shouldn't be used here, as it allocates memory that
2159                                  * was already allocated by BKE_object_make_local_ex() (which called BKE_object_copy_ex). */
2160                                 ob_new->proxy = ob->proxy;
2161                                 ob_new->proxy_group = ob->proxy_group;
2162                                 ob_new->proxy_from = ob->proxy_from;
2163                                 ob_new->proxy->proxy_from = ob_new;
2164                                 ob->proxy = ob->proxy_from = ob->proxy_group = NULL;
2165                         }
2166                 }
2167         }
2168
2169 #ifdef DEBUG_TIME
2170         printf("Step 5: Proxy 'remapping' hack: Done.\n");
2171         TIMEIT_VALUE_PRINT(make_local);
2172 #endif
2173
2174 #else
2175         LinkNode *linked_loop_candidates = NULL;
2176
2177         /* Step 5: remove datablocks that have been copied to be localized and are no more used in the end...
2178          * Note that we may have to loop more than once here, to tackle dependencies between linked objects... */
2179         bool do_loop = true;
2180         while (do_loop) {
2181                 do_loop = false;
2182                 for (LinkNode *it = copied_ids; it; it = it->next) {
2183                         if ((id = it->link) == NULL) {
2184                                 continue;
2185                         }
2186
2187                         bool is_local = false, is_lib = false;
2188
2189                         BKE_library_ID_test_usages(bmain, id, &is_local, &is_lib);
2190
2191                         /* Attempt to re-link copied proxy objects. This allows appending of an entire scene
2192                          * from another blend file into this one, even when that blend file contains proxified
2193                          * armatures that have local references. Since the proxified object needs to be linked
2194                          * (not local), this will only work when the "Localize all" checkbox is disabled.
2195                          * TL;DR: this is a dirty hack on top of an already weak feature (proxies). */
2196                         if (GS(id->name) == ID_OB && ((Object *)id)->proxy != NULL) {
2197                                 Object *ob = (Object *)id;
2198                                 Object *ob_new = (Object *)id->newid;
2199
2200                                 /* Proxies only work when the proxified object is linked-in from a library. */
2201                                 if (ob->proxy->id.lib == NULL) {
2202                                         printf("Warning, proxy object %s will loose its link to %s, because the "
2203                                                    "proxified object is local.\n", id->newid->name, ob->proxy->id.name);
2204                                 }
2205                                 /* We can only switch the proxy'ing to a made-local proxy if it is no longer
2206                                  * referred to from a library. Not checking for local use; if new local proxy
2207                                  * was not used locally would be a nasty bug! */
2208                                 else if (is_local || is_lib) {
2209                                         printf("Warning, made-local proxy object %s will loose its link to %s, "
2210                                                "because the linked-in proxy is referenced (is_local=%i, is_lib=%i).\n",
2211                                                id->newid->name, ob->proxy->id.name, is_local, is_lib);
2212                                 }
2213                                 else {
2214                                         /* we can switch the proxy'ing from the linked-in to the made-local proxy.
2215                                          * BKE_object_make_proxy() shouldn't be used here, as it allocates memory that
2216                                          * was already allocated by BKE_object_make_local_ex() (which called BKE_object_copy_ex). */
2217                                         ob_new->proxy = ob->proxy;
2218                                         ob_new->proxy_group = ob->proxy_group;
2219                                         ob_new->proxy_from = ob->proxy_from;
2220                                         ob_new->proxy->proxy_from = ob_new;
2221                                         ob->proxy = ob->proxy_from = ob->proxy_group = NULL;
2222                                 }
2223                         }
2224
2225                         if (!is_local) {
2226                                 if (!is_lib) {  /* Not used at all, we can free it! */
2227                                         BLI_assert(!"Unused linked data copy remaining from MakeLibLocal process, should not happen anymore");
2228                                         printf("\t%s (from %s)\n", id->name, id->lib->id.name);
2229                                         BKE_libblock_free(bmain, id);
2230                                         it->link = NULL;
2231                                         do_loop = true;
2232                                 }
2233                                 /* Only used by linked data, potential candidate to ugly lib-only dependency cycles... */
2234                                 else if ((id->tag & LIB_TAG_DOIT) == 0) {  /* Check TAG_DOIT to avoid adding same ID several times... */
2235                                         /* Note that we store the node, not directly ID pointer, that way if it->link is set to NULL
2236                                          * later we can skip it in lib-dependency cycles search later. */
2237                                         BLI_linklist_prepend_arena(&linked_loop_candidates, it, linklist_mem);
2238                                         id->tag |= LIB_TAG_DOIT;
2239
2240                                         /* Grrrrrrr... those half-datablocks-stuff... grrrrrrrrrrr...
2241                                          * Here we have to also tag them as potential candidates, otherwise they would falsy report
2242                                          * ID they used as 'directly used' in sixth step. */
2243                                         ID *ntree = (ID *)ntreeFromID(id);
2244                                         if (ntree != NULL) {
2245                                                 ntree->tag |= LIB_TAG_DOIT;
2246                                         }
2247                                 }
2248                         }
2249                 }
2250         }
2251
2252 #ifdef DEBUG_TIME
2253         printf("Step 5: Remove linked datablocks that have been copied and ended fully localized: Done.\n");
2254         TIMEIT_VALUE_PRINT(make_local);
2255 #endif
2256
2257         /* Step 6: Try to find circle dependencies between indirectly-linked-only datablocks.
2258          * Those are fake 'usages' that prevent their deletion. See T49775 for nice ugly case. */
2259         BKE_library_unused_linked_data_set_tag(bmain, false);
2260         for (LinkNode *it = linked_loop_candidates; it; it = it->next) {
2261                 if (it->link == NULL) {
2262                         continue;
2263                 }
2264                 if ((id = ((LinkNode *)it->link)->link) == NULL) {
2265                         it->link = NULL;
2266                         continue;
2267                 }
2268
2269                 /* Note: in theory here we are only handling datablocks forming exclusive linked dependency-cycles-based
2270                  * archipelagos, so no need to check again after we have deleted one, as done in previous step. */
2271                 if (id->tag & LIB_TAG_DOIT) {
2272                         BLI_assert(!"Unused linked data copy remaining from MakeLibLocal process (archipelago case), should not happen anymore");
2273                         /* Object's deletion rely on valid ob->data, but ob->data may have already been freed here...
2274                          * Setting it to NULL may not be 100% correct, but should be safe and do the work. */
2275                         if (GS(id->name) == ID_OB) {
2276                                 ((Object *)id)->data = NULL;
2277                         }
2278
2279                         /* Note: *in theory* IDs tagged here are fully *outside* of file scope, totally unused, so we can
2280                          *       directly wipe them out without caring about clearing their usages.
2281                          *       However, this is a highly-risky presumption, and nice crasher in case something goes wrong here.
2282                          *       So for 2.78a will keep the safe option, and switch to more efficient one in master later. */
2283 #if 1
2284                         BKE_libblock_free_ex(bmain, id, false, true);
2285 #else
2286                         BKE_libblock_unlink(bmain, id, false, false);
2287                         BKE_libblock_free(bmain, id);
2288 #endif
2289                         ((LinkNode *)it->link)->link = NULL;  /* Not strictly necessary, but safer (see T49903)... */
2290                         it->link = NULL;
2291                 }
2292         }
2293
2294 #ifdef DEBUG_TIME
2295         printf("Step 6: Try to find circle dependencies between indirectly-linked-only datablocks: Done.\n");
2296         TIMEIT_VALUE_PRINT(make_local);
2297 #endif
2298
2299 #endif
2300
2301         /* This is probably more of a hack than something we should do here, but...
2302          * Issue is, the whole copying + remapping done in complex cases above may leave pose channels of armatures
2303          * in complete invalid state (more precisely, the bone pointers of the pchans - very crappy cross-datablocks
2304          * relationship), se we tag it to be fully recomputed, but this does not seems to be enough in some cases,
2305          * and evaluation code ends up trying to evaluate a not-yet-updated armature object's deformations.
2306          * Try "make all local" in 04_01_H.lighting.blend from Agent327 without this, e.g. */
2307         for (Object *ob = bmain->object.first; ob; ob = ob->id.next) {
2308                 if (ob->data != NULL && ob->type == OB_ARMATURE && ob->pose != NULL && ob->pose->flag & POSE_RECALC) {
2309                         BKE_pose_rebuild(ob, ob->data);
2310                 }
2311         }
2312
2313 #ifdef DEBUG_TIME
2314         printf("Hack: Forcefully rebuild armature object poses: Done.\n");
2315         TIMEIT_VALUE_PRINT(make_local);
2316 #endif
2317
2318         BKE_main_id_clear_newpoins(bmain);
2319         BLI_memarena_free(linklist_mem);
2320
2321 #ifdef DEBUG_TIME
2322         printf("Cleanup and finish: Done.\n");
2323         TIMEIT_END(make_local);
2324 #endif
2325 }
2326
2327 /**
2328  * Use after setting the ID's name
2329  * When name exists: call 'new_id'
2330  */
2331 void BLI_libblock_ensure_unique_name(Main *bmain, const char *name)
2332 {
2333         ListBase *lb;
2334         ID *idtest;
2335
2336         lb = which_libbase(bmain, GS(name));
2337         if (lb == NULL) return;
2338         
2339         /* search for id */
2340         idtest = BLI_findstring(lb, name + 2, offsetof(ID, name) + 2);
2341
2342         if (idtest && !new_id(lb, idtest, idtest->name + 2)) {
2343                 id_sort_by_name(lb, idtest);
2344         }
2345 }
2346
2347 /**
2348  * Sets the name of a block to name, suitably adjusted for uniqueness.
2349  */
2350 void BKE_libblock_rename(Main *bmain, ID *id, const char *name)
2351 {
2352         ListBase *lb = which_libbase(bmain, GS(id->name));
2353         new_id(lb, id, name);
2354 }
2355
2356 /**
2357  * Returns in name the name of the block, with a 3-character prefix prepended
2358  * indicating whether it comes from a library, has a fake user, or no users.
2359  */
2360 void BKE_id_ui_prefix(char name[MAX_ID_NAME + 1], const ID *id)
2361 {
2362         name[0] = id->lib ? (ID_MISSING(id) ? 'M' : 'L') : ' ';
2363         name[1] = (id->flag & LIB_FAKEUSER) ? 'F' : ((id->us == 0) ? '0' : ' ');
2364         name[2] = ' ';
2365
2366         strcpy(name + 3, id->name + 2);
2367 }
2368
2369 void BKE_library_filepath_set(Library *lib, const char *filepath)
2370 {
2371         /* in some cases this is used to update the absolute path from the
2372          * relative */
2373         if (lib->name != filepath) {
2374                 BLI_strncpy(lib->name, filepath, sizeof(lib->name));
2375         }
2376
2377         BLI_strncpy(lib->filepath, filepath, sizeof(lib->filepath));
2378
2379         /* not essential but set filepath is an absolute copy of value which
2380          * is more useful if its kept in sync */
2381         if (BLI_path_is_rel(lib->filepath)) {
2382                 /* note that the file may be unsaved, in this case, setting the
2383                  * filepath on an indirectly linked path is not allowed from the
2384                  * outliner, and its not really supported but allow from here for now
2385                  * since making local could cause this to be directly linked - campbell
2386                  */
2387                 const char *basepath = lib->parent ? lib->parent->filepath : G.main->name;
2388                 BLI_path_abs(lib->filepath, basepath);
2389         }
2390 }
2391
2392 void BKE_id_tag_set_atomic(ID *id, int tag)
2393 {
2394         atomic_fetch_and_or_int32(&id->tag, tag);
2395 }
2396
2397 void BKE_id_tag_clear_atomic(ID *id, int tag)
2398 {
2399         atomic_fetch_and_and_int32(&id->tag, ~tag);
2400 }