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