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