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