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