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