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