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