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