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