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