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