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