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