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