BKE_library_make_local: clear behind us no more used linked datablocks.
[blender.git] / source / blender / blenkernel / intern / library.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/blenkernel/intern/library.c
29  *  \ingroup bke
30  *
31  * Contains management of ID's and libraries
32  * allocate and free of all library data
33  */
34
35 #include <stdio.h>
36 #include <ctype.h>
37 #include <string.h>
38 #include <stdlib.h>
39 #include <stddef.h>
40 #include <assert.h>
41
42 #include "MEM_guardedalloc.h"
43
44 /* all types are needed here, in order to do memory operations */
45 #include "DNA_anim_types.h"
46 #include "DNA_armature_types.h"
47 #include "DNA_brush_types.h"
48 #include "DNA_camera_types.h"
49 #include "DNA_group_types.h"
50 #include "DNA_gpencil_types.h"
51 #include "DNA_ipo_types.h"
52 #include "DNA_key_types.h"
53 #include "DNA_lamp_types.h"
54 #include "DNA_lattice_types.h"
55 #include "DNA_linestyle_types.h"
56 #include "DNA_material_types.h"
57 #include "DNA_mesh_types.h"
58 #include "DNA_meta_types.h"
59 #include "DNA_movieclip_types.h"
60 #include "DNA_mask_types.h"
61 #include "DNA_node_types.h"
62 #include "DNA_object_types.h"
63 #include "DNA_scene_types.h"
64 #include "DNA_screen_types.h"
65 #include "DNA_speaker_types.h"
66 #include "DNA_sound_types.h"
67 #include "DNA_text_types.h"
68 #include "DNA_vfont_types.h"
69 #include "DNA_windowmanager_types.h"
70 #include "DNA_world_types.h"
71
72 #include "BLI_blenlib.h"
73 #include "BLI_utildefines.h"
74
75 #include "BLI_threads.h"
76 #include "BLT_translation.h"
77
78 #include "BKE_action.h"
79 #include "BKE_animsys.h"
80 #include "BKE_armature.h"
81 #include "BKE_bpath.h"
82 #include "BKE_brush.h"
83 #include "BKE_camera.h"
84 #include "BKE_context.h"
85 #include "BKE_curve.h"
86 #include "BKE_depsgraph.h"
87 #include "BKE_font.h"
88 #include "BKE_global.h"
89 #include "BKE_group.h"
90 #include "BKE_gpencil.h"
91 #include "BKE_idcode.h"
92 #include "BKE_idprop.h"
93 #include "BKE_image.h"
94 #include "BKE_key.h"
95 #include "BKE_lamp.h"
96 #include "BKE_lattice.h"
97 #include "BKE_library.h"
98 #include "BKE_library_query.h"
99 #include "BKE_library_remap.h"
100 #include "BKE_linestyle.h"
101 #include "BKE_mesh.h"
102 #include "BKE_material.h"
103 #include "BKE_main.h"
104 #include "BKE_mball.h"
105 #include "BKE_mask.h"
106 #include "BKE_node.h"
107 #include "BKE_object.h"
108 #include "BKE_particle.h"
109 #include "BKE_packedFile.h"
110 #include "BKE_sound.h"
111 #include "BKE_speaker.h"
112 #include "BKE_scene.h"
113 #include "BKE_text.h"
114 #include "BKE_texture.h"
115 #include "BKE_world.h"
116
117 #include "DEG_depsgraph.h"
118
119 #include "RNA_access.h"
120
121 #include "IMB_imbuf.h"
122 #include "IMB_imbuf_types.h"
123
124 /* GS reads the memory pointed at in a specific ordering. 
125  * only use this definition, makes little and big endian systems
126  * work fine, in conjunction with MAKE_ID */
127
128 /* ************* general ************************ */
129
130
131 /* this has to be called from each make_local_* func, we could call
132  * from id_make_local() but then the make local functions would not be self
133  * contained.
134  * also note that the id _must_ have a library - campbell */
135 void BKE_id_lib_local_paths(Main *bmain, Library *lib, ID *id)
136 {
137         const char *bpath_user_data[2] = {bmain->name, lib->filepath};
138
139         BKE_bpath_traverse_id(bmain, id,
140                               BKE_bpath_relocate_visitor,
141                               BKE_BPATH_TRAVERSE_SKIP_MULTIFILE,
142                               (void *)bpath_user_data);
143 }
144
145 void id_lib_extern(ID *id)
146 {
147         if (id && ID_IS_LINKED_DATABLOCK(id)) {
148                 BLI_assert(BKE_idcode_is_linkable(GS(id->name)));
149                 if (id->tag & LIB_TAG_INDIRECT) {
150                         id->tag -= LIB_TAG_INDIRECT;
151                         id->tag |= LIB_TAG_EXTERN;
152                 }
153         }
154 }
155
156 /* ensure we have a real user */
157 /* Note: Now that we have flags, we could get rid of the 'fake_user' special case, flags are enough to ensure
158  *       we always have a real user.
159  *       However, ID_REAL_USERS is used in several places outside of core library.c, so think we can wait later
160  *       to make this change... */
161 void id_us_ensure_real(ID *id)
162 {
163         if (id) {
164                 const int limit = ID_FAKE_USERS(id);
165                 id->tag |= LIB_TAG_EXTRAUSER;
166                 if (id->us <= limit) {
167                         if (id->us < limit || ((id->us == limit) && (id->tag & LIB_TAG_EXTRAUSER_SET))) {
168                                 printf("ID user count error: %s (from '%s')\n", id->name, id->lib ? id->lib->filepath : "[Main]");
169                                 BLI_assert(0);
170                         }
171                         id->us = limit + 1;
172                         id->tag |= LIB_TAG_EXTRAUSER_SET;
173                 }
174         }
175 }
176
177 void id_us_clear_real(ID *id)
178 {
179         if (id && (id->tag & LIB_TAG_EXTRAUSER)) {
180                 if (id->tag & LIB_TAG_EXTRAUSER_SET) {
181                         id->us--;
182                         BLI_assert(id->us >= ID_FAKE_USERS(id));
183                 }
184                 id->tag &= ~(LIB_TAG_EXTRAUSER | LIB_TAG_EXTRAUSER_SET);
185         }
186 }
187
188 /**
189  * Same as \a id_us_plus, but does not handle lib indirect -> extern.
190  * Only used by readfile.c so far, but simpler/safer to keep it here nonetheless.
191  */
192 void id_us_plus_no_lib(ID *id)
193 {
194         if (id) {
195                 if ((id->tag & LIB_TAG_EXTRAUSER) && (id->tag & LIB_TAG_EXTRAUSER_SET)) {
196                         BLI_assert(id->us >= 1);
197                         /* No need to increase count, just tag extra user as no more set.
198                          * Avoids annoying & inconsistent +1 in user count. */
199                         id->tag &= ~LIB_TAG_EXTRAUSER_SET;
200                 }
201                 else {
202                         BLI_assert(id->us >= 0);
203                         id->us++;
204                 }
205         }
206 }
207
208
209 void id_us_plus(ID *id)
210 {
211         if (id) {
212                 id_us_plus_no_lib(id);
213                 id_lib_extern(id);
214         }
215 }
216
217 /* decrements the user count for *id. */
218 void id_us_min(ID *id)
219 {
220         if (id) {
221                 const int limit = ID_FAKE_USERS(id);
222
223                 if (id->us <= limit) {
224                         printf("ID user decrement error: %s (from '%s'): %d <= %d\n",
225                                id->name, id->lib ? id->lib->filepath : "[Main]", id->us, limit);
226                         BLI_assert(0);
227                         id->us = limit;
228                 }
229                 else {
230                         id->us--;
231                 }
232
233                 if ((id->us == limit) && (id->tag & LIB_TAG_EXTRAUSER)) {
234                         /* We need an extra user here, but never actually incremented user count for it so far, do it now. */
235                         id_us_ensure_real(id);
236                 }
237         }
238 }
239
240 void id_fake_user_set(ID *id)
241 {
242         if (id && !(id->flag & LIB_FAKEUSER)) {
243                 id->flag |= LIB_FAKEUSER;
244                 id_us_plus(id);
245         }
246 }
247
248 void id_fake_user_clear(ID *id)
249 {
250         if (id && (id->flag & LIB_FAKEUSER)) {
251                 id->flag &= ~LIB_FAKEUSER;
252                 id_us_min(id);
253         }
254 }
255
256 static int id_expand_local_callback(
257         void *UNUSED(user_data), struct ID *UNUSED(id_self), struct ID **id_pointer, int UNUSED(cd_flag))
258 {
259         if (*id_pointer) {
260                 id_lib_extern(*id_pointer);
261         }
262
263         return IDWALK_RET_NOP;
264 }
265
266 /**
267  * Expand ID usages of given id as 'extern' (and no more indirect) linked data. Used by ID copy/make_local functions.
268  */
269 void BKE_id_expand_local(ID *id)
270 {
271         BKE_library_foreach_ID_link(id, id_expand_local_callback, NULL, 0);
272 }
273
274 /**
275  * Generic 'make local' function, works for most of datablock types...
276  */
277 void BKE_id_make_local_generic(Main *bmain, ID *id, const bool id_in_mainlist, const bool lib_local)
278 {
279         bool is_local = false, is_lib = false;
280
281         /* - only lib users: do nothing (unless force_local is set)
282          * - only local users: set flag
283          * - mixed: make copy
284          * In case we make a whole lib's content local, we always want to localize, and we skip remapping (done later).
285          */
286
287         if (!ID_IS_LINKED_DATABLOCK(id)) {
288                 return;
289         }
290
291         BKE_library_ID_test_usages(bmain, id, &is_local, &is_lib);
292
293         if (lib_local || is_local) {
294                 if (!is_lib) {
295                         id_clear_lib_data_ex(bmain, id, id_in_mainlist);
296                         BKE_id_expand_local(id);
297                 }
298                 else {
299                         ID *id_new;
300
301                         /* Should not fail in expected usecases, but id_copy does not copy Scene e.g. */
302                         if (id_copy(bmain, id, &id_new, false)) {
303                                 id_new->us = 0;
304
305                                 if (!lib_local) {
306                                         BKE_libblock_remap(bmain, id, id_new, ID_REMAP_SKIP_INDIRECT_USAGE);
307                                 }
308                         }
309                 }
310         }
311
312 }
313
314 /**
315  * Calls the appropriate make_local method for the block, unless test is set.
316  *
317  * \param lib_local Special flag used when making a whole library's content local, it needs specific handling.
318  *
319  * \return true if the block can be made local.
320  */
321 bool id_make_local(Main *bmain, ID *id, const bool test, const bool lib_local)
322 {
323         if (id->tag & LIB_TAG_INDIRECT)
324                 return false;
325
326         switch (GS(id->name)) {
327                 case ID_SCE:
328                         /* Partially implemented (has no copy...). */
329                         if (!test) BKE_scene_make_local(bmain, (Scene *)id, lib_local);
330                         return true;
331                 case ID_LI:
332                         return false; /* can't be linked */
333                 case ID_OB:
334                         if (!test) BKE_object_make_local(bmain, (Object *)id, lib_local);
335                         return true;
336                 case ID_ME:
337                         if (!test) BKE_mesh_make_local(bmain, (Mesh *)id, lib_local);
338                         return true;
339                 case ID_CU:
340                         if (!test) BKE_curve_make_local(bmain, (Curve *)id, lib_local);
341                         return true;
342                 case ID_MB:
343                         if (!test) BKE_mball_make_local(bmain, (MetaBall *)id, lib_local);
344                         return true;
345                 case ID_MA:
346                         if (!test) BKE_material_make_local(bmain, (Material *)id, lib_local);
347                         return true;
348                 case ID_TE:
349                         if (!test) BKE_texture_make_local(bmain, (Tex *)id, lib_local);
350                         return true;
351                 case ID_IM:
352                         if (!test) BKE_image_make_local(bmain, (Image *)id, lib_local);
353                         return true;
354                 case ID_LT:
355                         if (!test) BKE_lattice_make_local(bmain, (Lattice *)id, lib_local);
356                         return true;
357                 case ID_LA:
358                         if (!test) BKE_lamp_make_local(bmain, (Lamp *)id, lib_local);
359                         return true;
360                 case ID_CA:
361                         if (!test) BKE_camera_make_local(bmain, (Camera *)id, lib_local);
362                         return true;
363                 case ID_SPK:
364                         if (!test) BKE_speaker_make_local(bmain, (Speaker *)id, lib_local);
365                         return true;
366                 case ID_IP:
367                         return false; /* deprecated */
368                 case ID_KE:
369                         return false; /* can't be linked */
370                 case ID_WO:
371                         if (!test) BKE_world_make_local(bmain, (World *)id, lib_local);
372                         return true;
373                 case ID_SCR:
374                         return false; /* can't be linked */
375                 case ID_VF:
376                         /* Partially implemented (has no copy...). */
377                         if (!test) BKE_vfont_make_local(bmain, (VFont *)id, lib_local);
378                         return true;
379                 case ID_TXT:
380                         if (!test) BKE_text_make_local(bmain, (Text *)id, lib_local);
381                         return true;
382                 case ID_SO:
383                         /* Partially implemented (has no copy...). */
384                         if (!test) BKE_sound_make_local(bmain, (bSound *)id, lib_local);
385                         return true;
386                 case ID_GR:
387                         if (!test) BKE_group_make_local(bmain, (Group *)id, lib_local);
388                         return true;
389                 case ID_AR:
390                         if (!test) BKE_armature_make_local(bmain, (bArmature *)id, lib_local);
391                         return true;
392                 case ID_AC:
393                         if (!test) BKE_action_make_local(bmain, (bAction *)id, lib_local);
394                         return true;
395                 case ID_NT:
396                         if (!test) ntreeMakeLocal(bmain, (bNodeTree *)id, true, lib_local);
397                         return true;
398                 case ID_BR:
399                         if (!test) BKE_brush_make_local(bmain, (Brush *)id, lib_local);
400                         return true;
401                 case ID_PA:
402                         if (!test) BKE_particlesettings_make_local(bmain, (ParticleSettings *)id, lib_local);
403                         return true;
404                 case ID_WM:
405                         return false; /* can't be linked */
406                 case ID_GD:
407                         if (!test) BKE_gpencil_make_local(bmain, (bGPdata *)id, lib_local);
408                         return true;
409                 case ID_MSK:
410                         if (!test) BKE_mask_make_local(bmain, (Mask *)id, lib_local);
411                         return true;
412                 case ID_LS:
413                         if (!test) BKE_linestyle_make_local(bmain, (FreestyleLineStyle *)id, lib_local);
414                         return true;
415         }
416
417         return false;
418 }
419
420 /**
421  * Invokes the appropriate copy method for the block and returns the result in
422  * newid, unless test. Returns true if the block can be copied.
423  */
424 bool id_copy(Main *bmain, ID *id, ID **newid, bool test)
425 {
426         if (!test) {
427                 *newid = NULL;
428         }
429
430         /* conventions:
431          * - make shallow copy, only this ID block
432          * - id.us of the new ID is set to 1 */
433         switch (GS(id->name)) {
434                 case ID_SCE:
435                         return false;  /* can't be copied from here */
436                 case ID_LI:
437                         return false;  /* can't be copied from here */
438                 case ID_OB:
439                         if (!test) *newid = (ID *)BKE_object_copy(bmain, (Object *)id);
440                         return true;
441                 case ID_ME:
442                         if (!test) *newid = (ID *)BKE_mesh_copy(bmain, (Mesh *)id);
443                         return true;
444                 case ID_CU:
445                         if (!test) *newid = (ID *)BKE_curve_copy(bmain, (Curve *)id);
446                         return true;
447                 case ID_MB:
448                         if (!test) *newid = (ID *)BKE_mball_copy(bmain, (MetaBall *)id);
449                         return true;
450                 case ID_MA:
451                         if (!test) *newid = (ID *)BKE_material_copy(bmain, (Material *)id);
452                         return true;
453                 case ID_TE:
454                         if (!test) *newid = (ID *)BKE_texture_copy(bmain, (Tex *)id);
455                         return true;
456                 case ID_IM:
457                         if (!test) *newid = (ID *)BKE_image_copy(bmain, (Image *)id);
458                         return true;
459                 case ID_LT:
460                         if (!test) *newid = (ID *)BKE_lattice_copy(bmain, (Lattice *)id);
461                         return true;
462                 case ID_LA:
463                         if (!test) *newid = (ID *)BKE_lamp_copy(bmain, (Lamp *)id);
464                         return true;
465                 case ID_SPK:
466                         if (!test) *newid = (ID *)BKE_speaker_copy(bmain, (Speaker *)id);
467                         return true;
468                 case ID_CA:
469                         if (!test) *newid = (ID *)BKE_camera_copy(bmain, (Camera *)id);
470                         return true;
471                 case ID_IP:
472                         return false;  /* deprecated */
473                 case ID_KE:
474                         if (!test) *newid = (ID *)BKE_key_copy(bmain, (Key *)id);
475                         return true;
476                 case ID_WO:
477                         if (!test) *newid = (ID *)BKE_world_copy(bmain, (World *)id);
478                         return true;
479                 case ID_SCR:
480                         return false;  /* can't be copied from here */
481                 case ID_VF:
482                         return false;  /* not implemented */
483                 case ID_TXT:
484                         if (!test) *newid = (ID *)BKE_text_copy(bmain, (Text *)id);
485                         return true;
486                 case ID_SO:
487                         return false;  /* not implemented */
488                 case ID_GR:
489                         if (!test) *newid = (ID *)BKE_group_copy(bmain, (Group *)id);
490                         return true;
491                 case ID_AR:
492                         if (!test) *newid = (ID *)BKE_armature_copy(bmain, (bArmature *)id);
493                         return true;
494                 case ID_AC:
495                         if (!test) *newid = (ID *)BKE_action_copy(bmain, (bAction *)id);
496                         return true;
497                 case ID_NT:
498                         if (!test) *newid = (ID *)ntreeCopyTree(bmain, (bNodeTree *)id);
499                         return true;
500                 case ID_BR:
501                         if (!test) *newid = (ID *)BKE_brush_copy(bmain, (Brush *)id);
502                         return true;
503                 case ID_PA:
504                         if (!test) *newid = (ID *)BKE_particlesettings_copy(bmain, (ParticleSettings *)id);
505                         return true;
506                 case ID_WM:
507                         return false;  /* can't be copied from here */
508                 case ID_GD:
509                         if (!test) *newid = (ID *)gpencil_data_duplicate(bmain, (bGPdata *)id, false);
510                         return true;
511                 case ID_MSK:
512                         if (!test) *newid = (ID *)BKE_mask_copy(bmain, (Mask *)id);
513                         return true;
514                 case ID_LS:
515                         if (!test) *newid = (ID *)BKE_linestyle_copy(bmain, (FreestyleLineStyle *)id);
516                         return true;
517         }
518         
519         return false;
520 }
521
522 bool id_single_user(bContext *C, ID *id, PointerRNA *ptr, PropertyRNA *prop)
523 {
524         ID *newid = NULL;
525         PointerRNA idptr;
526         
527         if (id) {
528                 /* if property isn't editable, we're going to have an extra block hanging around until we save */
529                 if (RNA_property_editable(ptr, prop)) {
530                         if (id_copy(CTX_data_main(C), id, &newid, false) && newid) {
531                                 /* copy animation actions too */
532                                 BKE_animdata_copy_id_action(id);
533                                 /* us is 1 by convention, but RNA_property_pointer_set
534                                  * will also increment it, so set it to zero */
535                                 newid->us = 0;
536                                 
537                                 /* assign copy */
538                                 RNA_id_pointer_create(newid, &idptr);
539                                 RNA_property_pointer_set(ptr, prop, idptr);
540                                 RNA_property_update(C, ptr, prop);
541                                 
542                                 return true;
543                         }
544                 }
545         }
546         
547         return false;
548 }
549
550 ListBase *which_libbase(Main *mainlib, short type)
551 {
552         switch (type) {
553                 case ID_SCE:
554                         return &(mainlib->scene);
555                 case ID_LI:
556                         return &(mainlib->library);
557                 case ID_OB:
558                         return &(mainlib->object);
559                 case ID_ME:
560                         return &(mainlib->mesh);
561                 case ID_CU:
562                         return &(mainlib->curve);
563                 case ID_MB:
564                         return &(mainlib->mball);
565                 case ID_MA:
566                         return &(mainlib->mat);
567                 case ID_TE:
568                         return &(mainlib->tex);
569                 case ID_IM:
570                         return &(mainlib->image);
571                 case ID_LT:
572                         return &(mainlib->latt);
573                 case ID_LA:
574                         return &(mainlib->lamp);
575                 case ID_CA:
576                         return &(mainlib->camera);
577                 case ID_IP:
578                         return &(mainlib->ipo);
579                 case ID_KE:
580                         return &(mainlib->key);
581                 case ID_WO:
582                         return &(mainlib->world);
583                 case ID_SCR:
584                         return &(mainlib->screen);
585                 case ID_VF:
586                         return &(mainlib->vfont);
587                 case ID_TXT:
588                         return &(mainlib->text);
589                 case ID_SPK:
590                         return &(mainlib->speaker);
591                 case ID_SO:
592                         return &(mainlib->sound);
593                 case ID_GR:
594                         return &(mainlib->group);
595                 case ID_AR:
596                         return &(mainlib->armature);
597                 case ID_AC:
598                         return &(mainlib->action);
599                 case ID_NT:
600                         return &(mainlib->nodetree);
601                 case ID_BR:
602                         return &(mainlib->brush);
603                 case ID_PA:
604                         return &(mainlib->particle);
605                 case ID_WM:
606                         return &(mainlib->wm);
607                 case ID_GD:
608                         return &(mainlib->gpencil);
609                 case ID_MC:
610                         return &(mainlib->movieclip);
611                 case ID_MSK:
612                         return &(mainlib->mask);
613                 case ID_LS:
614                         return &(mainlib->linestyle);
615                 case ID_PAL:
616                         return &(mainlib->palettes);
617                 case ID_PC:
618                         return &(mainlib->paintcurves);
619         }
620         return NULL;
621 }
622
623 /**
624  * Clear or set given tags for all ids in listbase (runtime tags).
625  */
626 void BKE_main_id_tag_listbase(ListBase *lb, const int tag, const bool value)
627 {
628         ID *id;
629         if (value) {
630                 for (id = lb->first; id; id = id->next) {
631                         id->tag |= tag;
632                 }
633         }
634         else {
635                 const int ntag = ~tag;
636                 for (id = lb->first; id; id = id->next) {
637                         id->tag &= ntag;
638                 }
639         }
640 }
641
642 /**
643  * Clear or set given tags for all ids of given type in bmain (runtime tags).
644  */
645 void BKE_main_id_tag_idcode(struct Main *mainvar, const short type, const int tag, const bool value)
646 {
647         ListBase *lb = which_libbase(mainvar, type);
648
649         BKE_main_id_tag_listbase(lb, tag, value);
650 }
651
652 /**
653  * Clear or set given tags for all ids in bmain (runtime tags).
654  */
655 void BKE_main_id_tag_all(struct Main *mainvar, const int tag, const bool value)
656 {
657         ListBase *lbarray[MAX_LIBARRAY];
658         int a;
659
660         a = set_listbasepointers(mainvar, lbarray);
661         while (a--) {
662                 BKE_main_id_tag_listbase(lbarray[a], tag, value);
663         }
664 }
665
666
667 /**
668  * Clear or set given flags for all ids in listbase (persistent flags).
669  */
670 void BKE_main_id_flag_listbase(ListBase *lb, const int flag, const bool value)
671 {
672         ID *id;
673         if (value) {
674                 for (id = lb->first; id; id = id->next)
675                         id->tag |= flag;
676         }
677         else {
678                 const int nflag = ~flag;
679                 for (id = lb->first; id; id = id->next)
680                         id->tag &= nflag;
681         }
682 }
683
684 /**
685  * Clear or set given flags for all ids in bmain (persistent flags).
686  */
687 void BKE_main_id_flag_all(Main *bmain, const int flag, const bool value)
688 {
689         ListBase *lbarray[MAX_LIBARRAY];
690         int a;
691         a = set_listbasepointers(bmain, lbarray);
692         while (a--) {
693                 BKE_main_id_flag_listbase(lbarray[a], flag, value);
694         }
695 }
696
697 void BKE_main_lib_objects_recalc_all(Main *bmain)
698 {
699         Object *ob;
700
701         /* flag for full recalc */
702         for (ob = bmain->object.first; ob; ob = ob->id.next) {
703                 if (ID_IS_LINKED_DATABLOCK(ob)) {
704                         DAG_id_tag_update(&ob->id, OB_RECALC_OB | OB_RECALC_DATA | OB_RECALC_TIME);
705                 }
706         }
707
708         DAG_id_type_tag(bmain, ID_OB);
709 }
710
711 /**
712  * puts into array *lb pointers to all the ListBase structs in main,
713  * and returns the number of them as the function result. This is useful for
714  * generic traversal of all the blocks in a Main (by traversing all the
715  * lists in turn), without worrying about block types.
716  *
717  * \note MAX_LIBARRAY define should match this code */
718 int set_listbasepointers(Main *main, ListBase **lb)
719 {
720         int a = 0;
721
722         /* BACKWARDS! also watch order of free-ing! (mesh<->mat), first items freed last.
723          * This is important because freeing data decreases usercounts of other datablocks,
724          * if this data is its self freed it can crash. */
725         lb[a++] = &(main->library);  /* Libraries may be accessed from pretty much any other ID... */
726         lb[a++] = &(main->ipo);
727         lb[a++] = &(main->action); /* moved here to avoid problems when freeing with animato (aligorith) */
728         lb[a++] = &(main->key);
729         lb[a++] = &(main->gpencil); /* referenced by nodes, objects, view, scene etc, before to free after. */
730         lb[a++] = &(main->nodetree);
731         lb[a++] = &(main->image);
732         lb[a++] = &(main->tex);
733         lb[a++] = &(main->mat);
734         lb[a++] = &(main->vfont);
735         
736         /* Important!: When adding a new object type,
737          * the specific data should be inserted here 
738          */
739
740         lb[a++] = &(main->armature);
741
742         lb[a++] = &(main->mesh);
743         lb[a++] = &(main->curve);
744         lb[a++] = &(main->mball);
745
746         lb[a++] = &(main->latt);
747         lb[a++] = &(main->lamp);
748         lb[a++] = &(main->camera);
749
750         lb[a++] = &(main->text);
751         lb[a++] = &(main->sound);
752         lb[a++] = &(main->group);
753         lb[a++] = &(main->palettes);
754         lb[a++] = &(main->paintcurves);
755         lb[a++] = &(main->brush);
756         lb[a++] = &(main->particle);
757         lb[a++] = &(main->speaker);
758
759         lb[a++] = &(main->world);
760         lb[a++] = &(main->movieclip);
761         lb[a++] = &(main->screen);
762         lb[a++] = &(main->object);
763         lb[a++] = &(main->linestyle); /* referenced by scenes */
764         lb[a++] = &(main->scene);
765         lb[a++] = &(main->wm);
766         lb[a++] = &(main->mask);
767         
768         lb[a] = NULL;
769
770         BLI_assert(a + 1 == MAX_LIBARRAY);
771
772         return a;
773 }
774
775 /* *********** ALLOC AND FREE *****************
776  *
777  * BKE_libblock_free(ListBase *lb, ID *id )
778  * provide a list-basis and datablock, but only ID is read
779  *
780  * void *BKE_libblock_alloc(ListBase *lb, type, name)
781  * inserts in list and returns a new ID
782  *
783  * **************************** */
784
785 /**
786  * Allocates and returns memory of the right size for the specified block type,
787  * initialized to zero.
788  */
789 void *BKE_libblock_alloc_notest(short type)
790 {
791         ID *id = NULL;
792         
793         switch (type) {
794                 case ID_SCE:
795                         id = MEM_callocN(sizeof(Scene), "scene");
796                         break;
797                 case ID_LI:
798                         id = MEM_callocN(sizeof(Library), "library");
799                         break;
800                 case ID_OB:
801                         id = MEM_callocN(sizeof(Object), "object");
802                         break;
803                 case ID_ME:
804                         id = MEM_callocN(sizeof(Mesh), "mesh");
805                         break;
806                 case ID_CU:
807                         id = MEM_callocN(sizeof(Curve), "curve");
808                         break;
809                 case ID_MB:
810                         id = MEM_callocN(sizeof(MetaBall), "mball");
811                         break;
812                 case ID_MA:
813                         id = MEM_callocN(sizeof(Material), "mat");
814                         break;
815                 case ID_TE:
816                         id = MEM_callocN(sizeof(Tex), "tex");
817                         break;
818                 case ID_IM:
819                         id = MEM_callocN(sizeof(Image), "image");
820                         break;
821                 case ID_LT:
822                         id = MEM_callocN(sizeof(Lattice), "latt");
823                         break;
824                 case ID_LA:
825                         id = MEM_callocN(sizeof(Lamp), "lamp");
826                         break;
827                 case ID_CA:
828                         id = MEM_callocN(sizeof(Camera), "camera");
829                         break;
830                 case ID_IP:
831                         id = MEM_callocN(sizeof(Ipo), "ipo");
832                         break;
833                 case ID_KE:
834                         id = MEM_callocN(sizeof(Key), "key");
835                         break;
836                 case ID_WO:
837                         id = MEM_callocN(sizeof(World), "world");
838                         break;
839                 case ID_SCR:
840                         id = MEM_callocN(sizeof(bScreen), "screen");
841                         break;
842                 case ID_VF:
843                         id = MEM_callocN(sizeof(VFont), "vfont");
844                         break;
845                 case ID_TXT:
846                         id = MEM_callocN(sizeof(Text), "text");
847                         break;
848                 case ID_SPK:
849                         id = MEM_callocN(sizeof(Speaker), "speaker");
850                         break;
851                 case ID_SO:
852                         id = MEM_callocN(sizeof(bSound), "sound");
853                         break;
854                 case ID_GR:
855                         id = MEM_callocN(sizeof(Group), "group");
856                         break;
857                 case ID_AR:
858                         id = MEM_callocN(sizeof(bArmature), "armature");
859                         break;
860                 case ID_AC:
861                         id = MEM_callocN(sizeof(bAction), "action");
862                         break;
863                 case ID_NT:
864                         id = MEM_callocN(sizeof(bNodeTree), "nodetree");
865                         break;
866                 case ID_BR:
867                         id = MEM_callocN(sizeof(Brush), "brush");
868                         break;
869                 case ID_PA:
870                         id = MEM_callocN(sizeof(ParticleSettings), "ParticleSettings");
871                         break;
872                 case ID_WM:
873                         id = MEM_callocN(sizeof(wmWindowManager), "Window manager");
874                         break;
875                 case ID_GD:
876                         id = MEM_callocN(sizeof(bGPdata), "Grease Pencil");
877                         break;
878                 case ID_MC:
879                         id = MEM_callocN(sizeof(MovieClip), "Movie Clip");
880                         break;
881                 case ID_MSK:
882                         id = MEM_callocN(sizeof(Mask), "Mask");
883                         break;
884                 case ID_LS:
885                         id = MEM_callocN(sizeof(FreestyleLineStyle), "Freestyle Line Style");
886                         break;
887                 case ID_PAL:
888                         id = MEM_callocN(sizeof(Palette), "Palette");
889                         break;
890                 case ID_PC:
891                         id = MEM_callocN(sizeof(PaintCurve), "Paint Curve");
892                         break;
893         }
894         return id;
895 }
896
897 /**
898  * Allocates and returns a block of the specified type, with the specified name
899  * (adjusted as necessary to ensure uniqueness), and appended to the specified list.
900  * The user count is set to 1, all other content (apart from name and links) being
901  * initialized to zero.
902  */
903 void *BKE_libblock_alloc(Main *bmain, short type, const char *name)
904 {
905         ID *id = NULL;
906         ListBase *lb = which_libbase(bmain, type);
907         
908         id = BKE_libblock_alloc_notest(type);
909         if (id) {
910                 BKE_main_lock(bmain);
911                 BLI_addtail(lb, id);
912                 id->us = 1;
913                 id->icon_id = 0;
914                 *( (short *)id->name) = type;
915                 new_id(lb, id, name);
916                 /* alphabetic insertion: is in new_id */
917                 BKE_main_unlock(bmain);
918         }
919         DAG_id_type_tag(bmain, type);
920         return id;
921 }
922
923 /**
924  * Initialize an ID of given type, such that it has valid 'empty' data.
925  * ID is assumed to be just calloc'ed.
926  */
927 void BKE_libblock_init_empty(ID *id)
928 {
929         /* Note that only ID types that are not valid when filled of zero should have a callback here. */
930         switch (GS(id->name)) {
931                 case ID_SCE:
932                         BKE_scene_init((Scene *)id);
933                         break;
934                 case ID_LI:
935                         /* Nothing to do. */
936                         break;
937                 case ID_OB:
938                 {
939                         Object *ob = (Object *)id;
940                         ob->type = OB_EMPTY;
941                         BKE_object_init(ob);
942                         break;
943                 }
944                 case ID_ME:
945                         BKE_mesh_init((Mesh *)id);
946                         break;
947                 case ID_CU:
948                         BKE_curve_init((Curve *)id);
949                         break;
950                 case ID_MB:
951                         BKE_mball_init((MetaBall *)id);
952                         break;
953                 case ID_MA:
954                         BKE_material_init((Material *)id);
955                         break;
956                 case ID_TE:
957                         BKE_texture_default((Tex *)id);
958                         break;
959                 case ID_IM:
960                         BKE_image_init((Image *)id);
961                         break;
962                 case ID_LT:
963                         BKE_lattice_init((Lattice *)id);
964                         break;
965                 case ID_LA:
966                         BKE_lamp_init((Lamp *)id);
967                         break;
968                 case ID_SPK:
969                         BKE_speaker_init((Speaker *)id);
970                         break;
971                 case ID_CA:
972                         BKE_camera_init((Camera *)id);
973                         break;
974                 case ID_IP:
975                         /* Should not be needed - animation from lib pre-2.5 is broken anyway. */
976                         BLI_assert(0);
977                         break;
978                 case ID_KE:
979                         /* Shapekeys are a complex topic too - they depend on their 'user' data type...
980                          * They are not linkable, though, so it should never reach here anyway. */
981                         BLI_assert(0);
982                         break;
983                 case ID_WO:
984                         BKE_world_init((World *)id);
985                         break;
986                 case ID_SCR:
987                         /* Nothing to do. */
988                         break;
989                 case ID_VF:
990                         BKE_vfont_init((VFont *)id);
991                         break;
992                 case ID_TXT:
993                         BKE_text_init((Text *)id);
994                         break;
995                 case ID_SO:
996                         /* Another fuzzy case, think NULLified content is OK here... */
997                         break;
998                 case ID_GR:
999                         /* Nothing to do. */
1000                         break;
1001                 case ID_AR:
1002                         /* Nothing to do. */
1003                         break;
1004                 case ID_AC:
1005                         /* Nothing to do. */
1006                         break;
1007                 case ID_NT:
1008                         ntreeInitDefault((bNodeTree *)id);
1009                         break;
1010                 case ID_BR:
1011                         BKE_brush_init((Brush *)id);
1012                         break;
1013                 case ID_PA:
1014                         /* Nothing to do. */
1015                         break;
1016                 case ID_PC:
1017                         /* Nothing to do. */
1018                         break;
1019                 case ID_WM:
1020                         /* We should never reach this. */
1021                         BLI_assert(0);
1022                         break;
1023                 case ID_GD:
1024                         /* Nothing to do. */
1025                         break;
1026                 case ID_MSK:
1027                         /* Nothing to do. */
1028                         break;
1029                 case ID_LS:
1030                         BKE_linestyle_init((FreestyleLineStyle *)id);
1031                         break;
1032         }
1033 }
1034
1035 /* by spec, animdata is first item after ID */
1036 /* and, trust that BKE_animdata_from_id() will only find AnimData for valid ID-types */
1037 static void id_copy_animdata(ID *id, const bool do_action)
1038 {
1039         AnimData *adt = BKE_animdata_from_id(id);
1040         
1041         if (adt) {
1042                 IdAdtTemplate *iat = (IdAdtTemplate *)id;
1043                 iat->adt = BKE_animdata_copy(iat->adt, do_action); /* could be set to false, need to investigate */
1044         }
1045 }
1046
1047 /* material nodes use this since they are not treated as libdata */
1048 void BKE_libblock_copy_data(ID *id, const ID *id_from, const bool do_action)
1049 {
1050         if (id_from->properties)
1051                 id->properties = IDP_CopyProperty(id_from->properties);
1052
1053         /* the duplicate should get a copy of the animdata */
1054         id_copy_animdata(id, do_action);
1055 }
1056
1057 /* used everywhere in blenkernel */
1058 void *BKE_libblock_copy(Main *bmain, ID *id)
1059 {
1060         ID *idn;
1061         size_t idn_len;
1062
1063         idn = BKE_libblock_alloc(bmain, GS(id->name), id->name + 2);
1064
1065         assert(idn != NULL);
1066
1067         idn_len = MEM_allocN_len(idn);
1068         if ((int)idn_len - (int)sizeof(ID) > 0) { /* signed to allow neg result */
1069                 const char *cp = (const char *)id;
1070                 char *cpn = (char *)idn;
1071
1072                 memcpy(cpn + sizeof(ID), cp + sizeof(ID), idn_len - sizeof(ID));
1073         }
1074         
1075         id->newid = idn;
1076         idn->tag |= LIB_TAG_NEW;
1077
1078         BKE_libblock_copy_data(idn, id, false);
1079         
1080         return idn;
1081 }
1082
1083 void *BKE_libblock_copy_nolib(ID *id, const bool do_action)
1084 {
1085         ID *idn;
1086         size_t idn_len;
1087
1088         idn = BKE_libblock_alloc_notest(GS(id->name));
1089         assert(idn != NULL);
1090
1091         BLI_strncpy(idn->name, id->name, sizeof(idn->name));
1092
1093         idn_len = MEM_allocN_len(idn);
1094         if ((int)idn_len - (int)sizeof(ID) > 0) { /* signed to allow neg result */
1095                 const char *cp = (const char *)id;
1096                 char *cpn = (char *)idn;
1097
1098                 memcpy(cpn + sizeof(ID), cp + sizeof(ID), idn_len - sizeof(ID));
1099         }
1100
1101         id->newid = idn;
1102         idn->tag |= LIB_TAG_NEW;
1103         idn->us = 1;
1104
1105         BKE_libblock_copy_data(idn, id, do_action);
1106
1107         return idn;
1108 }
1109
1110 static int id_relink_looper(void *UNUSED(user_data), ID *UNUSED(self_id), ID **id_pointer, const int cd_flag)
1111 {
1112         ID *id = *id_pointer;
1113         if (id) {
1114                 /* See: NEW_ID macro */
1115                 if (id->newid) {
1116                         BKE_library_update_ID_link_user(id->newid, id, cd_flag);
1117                         *id_pointer = id->newid;
1118                 }
1119                 else if (id->tag & LIB_TAG_NEW) {
1120                         id->tag &= ~LIB_TAG_NEW;
1121                         BKE_libblock_relink(id);
1122                 }
1123         }
1124         return IDWALK_RET_NOP;
1125 }
1126
1127 void BKE_libblock_relink(ID *id)
1128 {
1129         if (ID_IS_LINKED_DATABLOCK(id))
1130                 return;
1131
1132         BKE_library_foreach_ID_link(id, id_relink_looper, NULL, 0);
1133 }
1134
1135 void BKE_library_free(Library *lib)
1136 {
1137         if (lib->packedfile)
1138                 freePackedFile(lib->packedfile);
1139 }
1140
1141 Main *BKE_main_new(void)
1142 {
1143         Main *bmain = MEM_callocN(sizeof(Main), "new main");
1144         bmain->eval_ctx = DEG_evaluation_context_new(DAG_EVAL_VIEWPORT);
1145         bmain->lock = MEM_mallocN(sizeof(SpinLock), "main lock");
1146         BLI_spin_init((SpinLock *)bmain->lock);
1147         return bmain;
1148 }
1149
1150 void BKE_main_free(Main *mainvar)
1151 {
1152         /* also call when reading a file, erase all, etc */
1153         ListBase *lbarray[MAX_LIBARRAY];
1154         int a;
1155
1156         MEM_SAFE_FREE(mainvar->blen_thumb);
1157
1158         a = set_listbasepointers(mainvar, lbarray);
1159         while (a--) {
1160                 ListBase *lb = lbarray[a];
1161                 ID *id;
1162                 
1163                 while ( (id = lb->first) ) {
1164 #if 1
1165                         BKE_libblock_free_ex(mainvar, id, false);
1166 #else
1167                         /* errors freeing ID's can be hard to track down,
1168                          * enable this so valgrind will give the line number in its error log */
1169                         switch (a) {
1170                                 case   0: BKE_libblock_free_ex(mainvar, id, false); break;
1171                                 case   1: BKE_libblock_free_ex(mainvar, id, false); break;
1172                                 case   2: BKE_libblock_free_ex(mainvar, id, false); break;
1173                                 case   3: BKE_libblock_free_ex(mainvar, id, false); break;
1174                                 case   4: BKE_libblock_free_ex(mainvar, id, false); break;
1175                                 case   5: BKE_libblock_free_ex(mainvar, id, false); break;
1176                                 case   6: BKE_libblock_free_ex(mainvar, id, false); break;
1177                                 case   7: BKE_libblock_free_ex(mainvar, id, false); break;
1178                                 case   8: BKE_libblock_free_ex(mainvar, id, false); break;
1179                                 case   9: BKE_libblock_free_ex(mainvar, id, false); break;
1180                                 case  10: BKE_libblock_free_ex(mainvar, id, false); break;
1181                                 case  11: BKE_libblock_free_ex(mainvar, id, false); break;
1182                                 case  12: BKE_libblock_free_ex(mainvar, id, false); break;
1183                                 case  13: BKE_libblock_free_ex(mainvar, id, false); break;
1184                                 case  14: BKE_libblock_free_ex(mainvar, id, false); break;
1185                                 case  15: BKE_libblock_free_ex(mainvar, id, false); break;
1186                                 case  16: BKE_libblock_free_ex(mainvar, id, false); break;
1187                                 case  17: BKE_libblock_free_ex(mainvar, id, false); break;
1188                                 case  18: BKE_libblock_free_ex(mainvar, id, false); break;
1189                                 case  19: BKE_libblock_free_ex(mainvar, id, false); break;
1190                                 case  20: BKE_libblock_free_ex(mainvar, id, false); break;
1191                                 case  21: BKE_libblock_free_ex(mainvar, id, false); break;
1192                                 case  22: BKE_libblock_free_ex(mainvar, id, false); break;
1193                                 case  23: BKE_libblock_free_ex(mainvar, id, false); break;
1194                                 case  24: BKE_libblock_free_ex(mainvar, id, false); break;
1195                                 case  25: BKE_libblock_free_ex(mainvar, id, false); break;
1196                                 case  26: BKE_libblock_free_ex(mainvar, id, false); break;
1197                                 case  27: BKE_libblock_free_ex(mainvar, id, false); break;
1198                                 case  28: BKE_libblock_free_ex(mainvar, id, false); break;
1199                                 case  29: BKE_libblock_free_ex(mainvar, id, false); break;
1200                                 case  30: BKE_libblock_free_ex(mainvar, id, false); break;
1201                                 case  31: BKE_libblock_free_ex(mainvar, id, false); break;
1202                                 case  32: BKE_libblock_free_ex(mainvar, id, false); break;
1203                                 case  33: BKE_libblock_free_ex(mainvar, id, false); break;
1204                                 default:
1205                                         BLI_assert(0);
1206                                         break;
1207                         }
1208 #endif
1209                 }
1210         }
1211
1212         BLI_spin_end((SpinLock *)mainvar->lock);
1213         MEM_freeN(mainvar->lock);
1214         DEG_evaluation_context_free(mainvar->eval_ctx);
1215         MEM_freeN(mainvar);
1216 }
1217
1218 void BKE_main_lock(struct Main *bmain)
1219 {
1220         BLI_spin_lock((SpinLock *) bmain->lock);
1221 }
1222
1223 void BKE_main_unlock(struct Main *bmain)
1224 {
1225         BLI_spin_unlock((SpinLock *) bmain->lock);
1226 }
1227
1228 /**
1229  * Generates a raw .blend file thumbnail data from given image.
1230  *
1231  * \param bmain If not NULL, also store generated data in this Main.
1232  * \param img ImBuf image to generate thumbnail data from.
1233  * \return The generated .blend file raw thumbnail data.
1234  */
1235 BlendThumbnail *BKE_main_thumbnail_from_imbuf(Main *bmain, ImBuf *img)
1236 {
1237         BlendThumbnail *data = NULL;
1238
1239         if (bmain) {
1240                 MEM_SAFE_FREE(bmain->blen_thumb);
1241         }
1242
1243         if (img) {
1244                 const size_t sz = BLEN_THUMB_MEMSIZE(img->x, img->y);
1245                 data = MEM_mallocN(sz, __func__);
1246
1247                 IMB_rect_from_float(img);  /* Just in case... */
1248                 data->width = img->x;
1249                 data->height = img->y;
1250                 memcpy(data->rect, img->rect, sz - sizeof(*data));
1251         }
1252
1253         if (bmain) {
1254                 bmain->blen_thumb = data;
1255         }
1256         return data;
1257 }
1258
1259 /**
1260  * Generates an image from raw .blend file thumbnail \a data.
1261  *
1262  * \param bmain Use this bmain->blen_thumb data if given \a data is NULL.
1263  * \param data Raw .blend file thumbnail data.
1264  * \return An ImBuf from given data, or NULL if invalid.
1265  */
1266 ImBuf *BKE_main_thumbnail_to_imbuf(Main *bmain, BlendThumbnail *data)
1267 {
1268         ImBuf *img = NULL;
1269
1270         if (!data && bmain) {
1271                 data = bmain->blen_thumb;
1272         }
1273
1274         if (data) {
1275                 /* Note: we cannot use IMB_allocFromBuffer(), since it tries to dupalloc passed buffer, which will fail
1276                  *       here (we do not want to pass the first two ints!). */
1277                 img = IMB_allocImBuf((unsigned int)data->width, (unsigned int)data->height, 32, IB_rect | IB_metadata);
1278                 memcpy(img->rect, data->rect, BLEN_THUMB_MEMSIZE(data->width, data->height) - sizeof(*data));
1279         }
1280
1281         return img;
1282 }
1283
1284 /**
1285  * Generates an empty (black) thumbnail for given Main.
1286  */
1287 void BKE_main_thumbnail_create(struct Main *bmain)
1288 {
1289         MEM_SAFE_FREE(bmain->blen_thumb);
1290
1291         bmain->blen_thumb = MEM_callocN(BLEN_THUMB_MEMSIZE(BLEN_THUMB_SIZE, BLEN_THUMB_SIZE), __func__);
1292         bmain->blen_thumb->width = BLEN_THUMB_SIZE;
1293         bmain->blen_thumb->height = BLEN_THUMB_SIZE;
1294 }
1295
1296 /* ***************** ID ************************ */
1297 ID *BKE_libblock_find_name_ex(struct Main *bmain, const short type, const char *name)
1298 {
1299         ListBase *lb = which_libbase(bmain, type);
1300         BLI_assert(lb != NULL);
1301         return BLI_findstring(lb, name, offsetof(ID, name) + 2);
1302 }
1303 ID *BKE_libblock_find_name(const short type, const char *name)
1304 {
1305         return BKE_libblock_find_name_ex(G.main, type, name);
1306 }
1307
1308
1309 void id_sort_by_name(ListBase *lb, ID *id)
1310 {
1311         ID *idtest;
1312         
1313         /* insert alphabetically */
1314         if (lb->first != lb->last) {
1315                 BLI_remlink(lb, id);
1316                 
1317                 idtest = lb->first;
1318                 while (idtest) {
1319                         if (BLI_strcasecmp(idtest->name, id->name) > 0 || (idtest->lib && !id->lib)) {
1320                                 BLI_insertlinkbefore(lb, idtest, id);
1321                                 break;
1322                         }
1323                         idtest = idtest->next;
1324                 }
1325                 /* as last */
1326                 if (idtest == NULL) {
1327                         BLI_addtail(lb, id);
1328                 }
1329         }
1330         
1331 }
1332
1333 /**
1334  * Check to see if there is an ID with the same name as 'name'.
1335  * Returns the ID if so, if not, returns NULL
1336  */
1337 static ID *is_dupid(ListBase *lb, ID *id, const char *name)
1338 {
1339         ID *idtest = NULL;
1340         
1341         for (idtest = lb->first; idtest; idtest = idtest->next) {
1342                 /* if idtest is not a lib */ 
1343                 if (id != idtest && !ID_IS_LINKED_DATABLOCK(idtest)) {
1344                         /* do not test alphabetic! */
1345                         /* optimized */
1346                         if (idtest->name[2] == name[0]) {
1347                                 if (STREQ(name, idtest->name + 2)) break;
1348                         }
1349                 }
1350         }
1351         
1352         return idtest;
1353 }
1354
1355 /**
1356  * Check to see if an ID name is already used, and find a new one if so.
1357  * Return true if created a new name (returned in name).
1358  *
1359  * Normally the ID that's being check is already in the ListBase, so ID *id
1360  * points at the new entry.  The Python Library module needs to know what
1361  * the name of a datablock will be before it is appended; in this case ID *id
1362  * id is NULL
1363  */
1364
1365 static bool check_for_dupid(ListBase *lb, ID *id, char *name)
1366 {
1367         ID *idtest;
1368         int nr = 0, a, left_len;
1369 #define MAX_IN_USE 64
1370         bool in_use[MAX_IN_USE];
1371         /* to speed up finding unused numbers within [1 .. MAX_IN_USE - 1] */
1372
1373         char left[MAX_ID_NAME + 8], leftest[MAX_ID_NAME + 8];
1374
1375         while (true) {
1376
1377                 /* phase 1: id already exists? */
1378                 idtest = is_dupid(lb, id, name);
1379
1380                 /* if there is no double, done */
1381                 if (idtest == NULL) return false;
1382
1383                 /* we have a dup; need to make a new name */
1384                 /* quick check so we can reuse one of first MAX_IN_USE - 1 ids if vacant */
1385                 memset(in_use, false, sizeof(in_use));
1386
1387                 /* get name portion, number portion ("name.number") */
1388                 left_len = BLI_split_name_num(left, &nr, name, '.');
1389
1390                 /* if new name will be too long, truncate it */
1391                 if (nr > 999 && left_len > (MAX_ID_NAME - 8)) {  /* assumption: won't go beyond 9999 */
1392                         left[MAX_ID_NAME - 8] = 0;
1393                         left_len = MAX_ID_NAME - 8;
1394                 }
1395                 else if (left_len > (MAX_ID_NAME - 7)) {
1396                         left[MAX_ID_NAME - 7] = 0;
1397                         left_len = MAX_ID_NAME - 7;
1398                 }
1399
1400                 for (idtest = lb->first; idtest; idtest = idtest->next) {
1401                         int nrtest;
1402                         if ( (id != idtest) &&
1403                              !ID_IS_LINKED_DATABLOCK(idtest) &&
1404                              (*name == *(idtest->name + 2)) &&
1405                              STREQLEN(name, idtest->name + 2, left_len) &&
1406                              (BLI_split_name_num(leftest, &nrtest, idtest->name + 2, '.') == left_len)
1407                              )
1408                         {
1409                                 /* will get here at least once, otherwise is_dupid call above would have returned NULL */
1410                                 if (nrtest < MAX_IN_USE)
1411                                         in_use[nrtest] = true;  /* mark as used */
1412                                 if (nr <= nrtest)
1413                                         nr = nrtest + 1;    /* track largest unused */
1414                         }
1415                 }
1416                 /* At this point, 'nr' will typically be at least 1. (but not always) */
1417                 // BLI_assert(nr >= 1);
1418
1419                 /* decide which value of nr to use */
1420                 for (a = 0; a < MAX_IN_USE; a++) {
1421                         if (a >= nr) break;  /* stop when we've checked up to biggest */  /* redundant check */
1422                         if (!in_use[a]) { /* found an unused value */
1423                                 nr = a;
1424                                 /* can only be zero if all potential duplicate names had
1425                                  * nonzero numeric suffixes, which means name itself has
1426                                  * nonzero numeric suffix (else no name conflict and wouldn't
1427                                  * have got here), which means name[left_len] is not a null */
1428                                 break;
1429                         }
1430                 }
1431                 /* At this point, nr is either the lowest unused number within [0 .. MAX_IN_USE - 1],
1432                  * or 1 greater than the largest used number if all those low ones are taken.
1433                  * We can't be bothered to look for the lowest unused number beyond (MAX_IN_USE - 1). */
1434
1435                 /* If the original name has no numeric suffix, 
1436                  * rather than just chopping and adding numbers, 
1437                  * shave off the end chars until we have a unique name.
1438                  * Check the null terminators match as well so we don't get Cube.000 -> Cube.00 */
1439                 if (nr == 0 && name[left_len] == '\0') {
1440                         int len;
1441                         /* FIXME: this code will never be executed, because either nr will be
1442                          * at least 1, or name will not end at left_len! */
1443                         BLI_assert(0);
1444
1445                         len = left_len - 1;
1446                         idtest = is_dupid(lb, id, name);
1447                         
1448                         while (idtest && len > 1) {
1449                                 name[len--] = '\0';
1450                                 idtest = is_dupid(lb, id, name);
1451                         }
1452                         if (idtest == NULL) return true;
1453                         /* otherwise just continue and use a number suffix */
1454                 }
1455                 
1456                 if (nr > 999 && left_len > (MAX_ID_NAME - 8)) {
1457                         /* this would overflow name buffer */
1458                         left[MAX_ID_NAME - 8] = 0;
1459                         /* left_len = MAX_ID_NAME - 8; */ /* for now this isn't used again */
1460                         memcpy(name, left, sizeof(char) * (MAX_ID_NAME - 7));
1461                         continue;
1462                 }
1463                 /* this format specifier is from hell... */
1464                 BLI_snprintf(name, sizeof(id->name) - 2, "%s.%.3d", left, nr);
1465
1466                 return true;
1467         }
1468
1469 #undef MAX_IN_USE
1470 }
1471
1472 /*
1473  * Only for local blocks: external en indirect blocks already have a
1474  * unique ID.
1475  *
1476  * return true: created a new name
1477  */
1478
1479 bool new_id(ListBase *lb, ID *id, const char *tname)
1480 {
1481         bool result;
1482         char name[MAX_ID_NAME - 2];
1483
1484         /* if library, don't rename */
1485         if (ID_IS_LINKED_DATABLOCK(id))
1486                 return false;
1487
1488         /* if no libdata given, look up based on ID */
1489         if (lb == NULL)
1490                 lb = which_libbase(G.main, GS(id->name));
1491
1492         /* if no name given, use name of current ID
1493          * else make a copy (tname args can be const) */
1494         if (tname == NULL)
1495                 tname = id->name + 2;
1496
1497         BLI_strncpy(name, tname, sizeof(name));
1498
1499         if (name[0] == '\0') {
1500                 /* disallow empty names */
1501                 BLI_strncpy(name, DATA_(ID_FALLBACK_NAME), sizeof(name));
1502         }
1503         else {
1504                 /* disallow non utf8 chars,
1505                  * the interface checks for this but new ID's based on file names don't */
1506                 BLI_utf8_invalid_strip(name, strlen(name));
1507         }
1508
1509         result = check_for_dupid(lb, id, name);
1510         strcpy(id->name + 2, name);
1511
1512         /* This was in 2.43 and previous releases
1513          * however all data in blender should be sorted, not just duplicate names
1514          * sorting should not hurt, but noting just incase it alters the way other
1515          * functions work, so sort every time */
1516 #if 0
1517         if (result)
1518                 id_sort_by_name(lb, id);
1519 #endif
1520
1521         id_sort_by_name(lb, id);
1522         
1523         return result;
1524 }
1525
1526 /**
1527  * Pull an ID out of a library (make it local). Only call this for IDs that
1528  * don't have other library users.
1529  */
1530 void id_clear_lib_data_ex(Main *bmain, ID *id, const bool id_in_mainlist)
1531 {
1532         bNodeTree *ntree = NULL;
1533         Key *key = NULL;
1534
1535         BKE_id_lib_local_paths(bmain, id->lib, id);
1536
1537         id_fake_user_clear(id);
1538
1539         id->lib = NULL;
1540         id->tag &= ~(LIB_TAG_INDIRECT | LIB_TAG_EXTERN);
1541         if (id_in_mainlist)
1542                 new_id(which_libbase(bmain, GS(id->name)), id, NULL);
1543
1544         /* Internal bNodeTree blocks inside datablocks also stores id->lib, make sure this stays in sync. */
1545         if ((ntree = ntreeFromID(id))) {
1546                 id_clear_lib_data_ex(bmain, &ntree->id, false);  /* Datablocks' nodetree is never in Main. */
1547         }
1548
1549         /* Same goes for shapekeys. */
1550         if ((key = BKE_key_from_id(id))) {
1551                 id_clear_lib_data_ex(bmain, &key->id, id_in_mainlist);  /* sigh, why are keys in Main? */
1552         }
1553
1554         if (GS(id->name) == ID_OB) {
1555                 Object *object = (Object *)id;
1556                 if (object->proxy_from != NULL) {
1557                         object->proxy_from->proxy = NULL;
1558                         object->proxy_from->proxy_group = NULL;
1559                 }
1560                 object->proxy = object->proxy_from = object->proxy_group = NULL;
1561         }
1562 }
1563
1564 void id_clear_lib_data(Main *bmain, ID *id)
1565 {
1566         id_clear_lib_data_ex(bmain, id, true);
1567 }
1568
1569 /* next to indirect usage in read/writefile also in editobject.c scene.c */
1570 void BKE_main_id_clear_newpoins(Main *bmain)
1571 {
1572         ListBase *lbarray[MAX_LIBARRAY];
1573         ID *id;
1574         int a;
1575
1576         a = set_listbasepointers(bmain, lbarray);
1577         while (a--) {
1578                 id = lbarray[a]->first;
1579                 while (id) {
1580                         id->newid = NULL;
1581                         id->tag &= ~LIB_TAG_NEW;
1582                         id = id->next;
1583                 }
1584         }
1585 }
1586
1587 /** Make linked datablocks local.
1588  *
1589  * \param bmain Almost certainly G.main.
1590  * \param lib If not NULL, only make local datablocks from this library.
1591  * \param untagged_only If true, only make local datablocks not tagged with LIB_TAG_PRE_EXISTING.
1592  * \param set_fake If true, set fake user on all localized datablocks (except group and objects ones).
1593  */
1594 /* XXX TODO This function should probably be reworked.
1595  *
1596  * Old (2.77) version was simply making (tagging) datablocks as local, without actually making any check whether
1597  * they were also indirectly used or not...
1598  *
1599  * Current version uses regular id_make_local callback, but this is not super-efficient since this ends up
1600  * duplicating some IDs and then removing original ones (due to missing knowledge of which ID uses some other ID).
1601  *
1602  * We could first check all IDs and detect those to be made local that are only used by other local or future-local
1603  * datablocks, and directly tag those as local (instead of going through id_make_local) maybe...
1604  *
1605  * We'll probably need at some point a true dependency graph between datablocks, but for now this should work
1606  * good enough (performances is not a critical point here anyway).
1607  */
1608 void BKE_library_make_local(Main *bmain, const Library *lib, const bool untagged_only, const bool set_fake)
1609 {
1610         ListBase *lbarray[MAX_LIBARRAY];
1611         ID *id, *id_next;
1612         int a;
1613
1614         for (a = set_listbasepointers(bmain, lbarray); a--; ) {
1615                 for (id = lbarray[a]->first; id; id = id_next) {
1616                         id->newid = NULL;
1617                         id_next = id->next;  /* id is possibly being inserted again */
1618                         
1619                         /* The check on the second line (LIB_TAG_PRE_EXISTING) is done so its
1620                          * possible to tag data you don't want to be made local, used for
1621                          * appending data, so any libdata already linked wont become local
1622                          * (very nasty to discover all your links are lost after appending)  
1623                          * */
1624                         if (id->tag & (LIB_TAG_EXTERN | LIB_TAG_INDIRECT | LIB_TAG_NEW) &&
1625                             ((untagged_only == false) || !(id->tag & LIB_TAG_PRE_EXISTING)))
1626                         {
1627                                 if (lib == NULL || id->lib == lib) {
1628                                         if (id->lib) {
1629                                                 /* In this specific case, we do want to make ID local even if it has no local usage yet... */
1630                                                 id_make_local(bmain, id, false, true);
1631                                         }
1632                                         else {
1633                                                 id->tag &= ~(LIB_TAG_EXTERN | LIB_TAG_INDIRECT | LIB_TAG_NEW);
1634                                         }
1635                                 }
1636
1637                                 if (set_fake) {
1638                                         if (!ELEM(GS(id->name), ID_OB, ID_GR)) {
1639                                                 /* do not set fake user on objects, groups (instancing) */
1640                                                 id_fake_user_set(id);
1641                                         }
1642                                 }
1643                         }
1644                 }
1645         }
1646
1647         /* We have to remap local usages of old (linked) ID to new (local) id in a second loop, as lbarray ordering is not
1648          * enough to ensure us we did catch all dependencies (e.g. if making local a parent object before its child...).
1649          * See T48907. */
1650         for (a = set_listbasepointers(bmain, lbarray); a--; ) {
1651                 for (id = lbarray[a]->first; id; id = id->next) {
1652                         if (id->newid) {
1653                                 BKE_libblock_remap(bmain, id, id->newid, ID_REMAP_SKIP_INDIRECT_USAGE);
1654                         }
1655                 }
1656         }
1657
1658         /* Third step: remove datablocks that have been copied to be localized and are no more used in the end...
1659          * Note that we may have to loop more than once here, to tackle dependencies between linked objects... */
1660         bool do_loop = true;
1661         while (do_loop) {
1662                 do_loop = false;
1663                 for (a = set_listbasepointers(bmain, lbarray); a--; ) {
1664                         for (id = lbarray[a]->first; id; id = id_next) {
1665                                 id_next = id->next;
1666                                 if (id->newid) {
1667                                         bool is_local = false, is_lib = false;
1668
1669                                         BKE_library_ID_test_usages(bmain, id, &is_local, &is_lib);
1670                                         if (!is_local && !is_lib) {
1671                                                 BKE_libblock_free(bmain, id);
1672                                                 do_loop = true;
1673                                         }
1674                                 }
1675                         }
1676                 }
1677         }
1678 }
1679
1680 /**
1681  * Use after setting the ID's name
1682  * When name exists: call 'new_id'
1683  */
1684 void BLI_libblock_ensure_unique_name(Main *bmain, const char *name)
1685 {
1686         ListBase *lb;
1687         ID *idtest;
1688
1689
1690         lb = which_libbase(bmain, GS(name));
1691         if (lb == NULL) return;
1692         
1693         /* search for id */
1694         idtest = BLI_findstring(lb, name + 2, offsetof(ID, name) + 2);
1695
1696         if (idtest && !new_id(lb, idtest, idtest->name + 2)) {
1697                 id_sort_by_name(lb, idtest);
1698         }
1699 }
1700
1701 /**
1702  * Sets the name of a block to name, suitably adjusted for uniqueness.
1703  */
1704 void BKE_libblock_rename(Main *bmain, ID *id, const char *name)
1705 {
1706         ListBase *lb = which_libbase(bmain, GS(id->name));
1707         new_id(lb, id, name);
1708 }
1709
1710 /**
1711  * Returns in name the name of the block, with a 3-character prefix prepended
1712  * indicating whether it comes from a library, has a fake user, or no users.
1713  */
1714 void BKE_id_ui_prefix(char name[MAX_ID_NAME + 1], const ID *id)
1715 {
1716         name[0] = id->lib ? (ID_MISSING(id) ? 'M' : 'L') : ' ';
1717         name[1] = (id->flag & LIB_FAKEUSER) ? 'F' : ((id->us == 0) ? '0' : ' ');
1718         name[2] = ' ';
1719
1720         strcpy(name + 3, id->name + 2);
1721 }
1722
1723 void BKE_library_filepath_set(Library *lib, const char *filepath)
1724 {
1725         /* in some cases this is used to update the absolute path from the
1726          * relative */
1727         if (lib->name != filepath) {
1728                 BLI_strncpy(lib->name, filepath, sizeof(lib->name));
1729         }
1730
1731         BLI_strncpy(lib->filepath, filepath, sizeof(lib->filepath));
1732
1733         /* not essential but set filepath is an absolute copy of value which
1734          * is more useful if its kept in sync */
1735         if (BLI_path_is_rel(lib->filepath)) {
1736                 /* note that the file may be unsaved, in this case, setting the
1737                  * filepath on an indirectly linked path is not allowed from the
1738                  * outliner, and its not really supported but allow from here for now
1739                  * since making local could cause this to be directly linked - campbell
1740                  */
1741                 const char *basepath = lib->parent ? lib->parent->filepath : G.main->name;
1742                 BLI_path_abs(lib->filepath, basepath);
1743         }
1744 }