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