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