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