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