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