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