patch [#34103] check_for_dupid2.patch
[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_material_types.h"
56 #include "DNA_mesh_types.h"
57 #include "DNA_meta_types.h"
58 #include "DNA_movieclip_types.h"
59 #include "DNA_mask_types.h"
60 #include "DNA_nla_types.h"
61 #include "DNA_node_types.h"
62 #include "DNA_scene_types.h"
63 #include "DNA_screen_types.h"
64 #include "DNA_speaker_types.h"
65 #include "DNA_sound_types.h"
66 #include "DNA_text_types.h"
67 #include "DNA_vfont_types.h"
68 #include "DNA_windowmanager_types.h"
69 #include "DNA_world_types.h"
70
71 #include "BLI_blenlib.h"
72 #include "BLI_dynstr.h"
73 #include "BLI_utildefines.h"
74 #include "BKE_bpath.h"
75
76 #include "BKE_action.h"
77 #include "BKE_animsys.h"
78 #include "BKE_armature.h"
79 #include "BKE_brush.h"
80 #include "BKE_camera.h"
81 #include "BKE_context.h"
82 #include "BKE_curve.h"
83 #include "BKE_fcurve.h"
84 #include "BKE_font.h"
85 #include "BKE_global.h"
86 #include "BKE_group.h"
87 #include "BKE_gpencil.h"
88 #include "BKE_idprop.h"
89 #include "BKE_icons.h"
90 #include "BKE_image.h"
91 #include "BKE_ipo.h"
92 #include "BKE_key.h"
93 #include "BKE_lamp.h"
94 #include "BKE_lattice.h"
95 #include "BKE_library.h"
96 #include "BKE_mesh.h"
97 #include "BKE_material.h"
98 #include "BKE_main.h"
99 #include "BKE_mball.h"
100 #include "BKE_movieclip.h"
101 #include "BKE_mask.h"
102 #include "BKE_node.h"
103 #include "BKE_object.h"
104 #include "BKE_particle.h"
105 #include "BKE_packedFile.h"
106 #include "BKE_speaker.h"
107 #include "BKE_sound.h"
108 #include "BKE_screen.h"
109 #include "BKE_scene.h"
110 #include "BKE_text.h"
111 #include "BKE_texture.h"
112 #include "BKE_world.h"
113
114 #include "RNA_access.h"
115
116 #ifdef WITH_PYTHON
117 #include "BPY_extern.h"
118 #endif
119
120 #define MAX_IDPUP  60  /* was 24 */
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         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                               bpath_user_data);
141 }
142
143 void id_lib_extern(ID *id)
144 {
145         if (id) {
146                 if (id->flag & LIB_INDIRECT) {
147                         id->flag -= LIB_INDIRECT;
148                         id->flag |= LIB_EXTERN;
149                 }
150         }
151 }
152
153 /* ensure we have a real user */
154 void id_us_ensure_real(ID *id)
155 {
156         if (id) {
157                 if (ID_REAL_USERS(id) <= 0) {
158                         id->us = MAX2(id->us, 0) + 1;
159                 }
160         }
161 }
162
163 void id_us_plus(ID *id)
164 {
165         if (id) {
166                 id->us++;
167                 if (id->flag & LIB_INDIRECT) {
168                         id->flag -= LIB_INDIRECT;
169                         id->flag |= LIB_EXTERN;
170                 }
171         }
172 }
173
174 /* decrements the user count for *id. */
175 void id_us_min(ID *id)
176 {
177         if (id) {
178                 if (id->us < 2 && (id->flag & LIB_FAKEUSER)) {
179                         id->us = 1;
180                 }
181                 else if (id->us <= 0) {
182                         printf("ID user decrement error: %s\n", id->name);
183                 }
184                 else {
185                         id->us--;
186                 }
187         }
188 }
189
190 /* calls the appropriate make_local method for the block, unless test. Returns true
191  * if the block can be made local. */
192 bool id_make_local(ID *id, bool test)
193 {
194         if (id->flag & LIB_INDIRECT)
195                 return false;
196
197         switch (GS(id->name)) {
198                 case ID_SCE:
199                         return false; /* not implemented */
200                 case ID_LI:
201                         return false; /* can't be linked */
202                 case ID_OB:
203                         if (!test) BKE_object_make_local((Object *)id);
204                         return true;
205                 case ID_ME:
206                         if (!test) {
207                                 BKE_mesh_make_local((Mesh *)id);
208                                 BKE_key_make_local(((Mesh *)id)->key);
209                         }
210                         return true;
211                 case ID_CU:
212                         if (!test) {
213                                 BKE_curve_make_local((Curve *)id);
214                                 BKE_key_make_local(((Curve *)id)->key);
215                         }
216                         return true;
217                 case ID_MB:
218                         if (!test) BKE_mball_make_local((MetaBall *)id);
219                         return true;
220                 case ID_MA:
221                         if (!test) BKE_material_make_local((Material *)id);
222                         return true;
223                 case ID_TE:
224                         if (!test) BKE_texture_make_local((Tex *)id);
225                         return true;
226                 case ID_IM:
227                         if (!test) BKE_image_make_local((Image *)id);
228                         return true;
229                 case ID_LT:
230                         if (!test) {
231                                 BKE_lattice_make_local((Lattice *)id);
232                                 BKE_key_make_local(((Lattice *)id)->key);
233                         }
234                         return true;
235                 case ID_LA:
236                         if (!test) BKE_lamp_make_local((Lamp *)id);
237                         return true;
238                 case ID_CA:
239                         if (!test) BKE_camera_make_local((Camera *)id);
240                         return true;
241                 case ID_SPK:
242                         if (!test) BKE_speaker_make_local((Speaker *)id);
243                         return true;
244                 case ID_IP:
245                         return false; /* deprecated */
246                 case ID_KE:
247                         if (!test) BKE_key_make_local((Key *)id);
248                         return true;
249                 case ID_WO:
250                         if (!test) BKE_world_make_local((World *)id);
251                         return true;
252                 case ID_SCR:
253                         return false; /* can't be linked */
254                 case ID_VF:
255                         return false; /* not implemented */
256                 case ID_TXT:
257                         return false; /* not implemented */
258                 case ID_SCRIPT:
259                         return false; /* deprecated */
260                 case ID_SO:
261                         return false; /* not implemented */
262                 case ID_GR:
263                         return false; /* not implemented */
264                 case ID_AR:
265                         if (!test) BKE_armature_make_local((bArmature *)id);
266                         return true;
267                 case ID_AC:
268                         if (!test) BKE_action_make_local((bAction *)id);
269                         return true;
270                 case ID_NT:
271                         return false; /* not implemented */
272                 case ID_BR:
273                         if (!test) BKE_brush_make_local((Brush *)id);
274                         return true;
275                 case ID_PA:
276                         if (!test) BKE_particlesettings_make_local((ParticleSettings *)id);
277                         return true;
278                 case ID_WM:
279                         return false; /* can't be linked */
280                 case ID_GD:
281                         return false; /* not implemented */
282         }
283
284         return false;
285 }
286
287 /**
288  * Invokes the appropriate copy method for the block and returns the result in
289  * newid, unless test. Returns true iff the block can be copied.
290  */
291 bool id_copy(ID *id, ID **newid, bool test)
292 {
293         if (!test) *newid = NULL;
294
295         /* conventions:
296          * - make shallow copy, only this ID block
297          * - id.us of the new ID is set to 1 */
298         switch (GS(id->name)) {
299                 case ID_SCE:
300                         return false;  /* can't be copied from here */
301                 case ID_LI:
302                         return false;  /* can't be copied from here */
303                 case ID_OB:
304                         if (!test) *newid = (ID *)BKE_object_copy((Object *)id);
305                         return true;
306                 case ID_ME:
307                         if (!test) *newid = (ID *)BKE_mesh_copy((Mesh *)id);
308                         return true;
309                 case ID_CU:
310                         if (!test) *newid = (ID *)BKE_curve_copy((Curve *)id);
311                         return true;
312                 case ID_MB:
313                         if (!test) *newid = (ID *)BKE_mball_copy((MetaBall *)id);
314                         return true;
315                 case ID_MA:
316                         if (!test) *newid = (ID *)BKE_material_copy((Material *)id);
317                         return true;
318                 case ID_TE:
319                         if (!test) *newid = (ID *)BKE_texture_copy((Tex *)id);
320                         return true;
321                 case ID_IM:
322                         if (!test) *newid = (ID *)BKE_image_copy(G.main, (Image *)id);
323                         return true;
324                 case ID_LT:
325                         if (!test) *newid = (ID *)BKE_lattice_copy((Lattice *)id);
326                         return true;
327                 case ID_LA:
328                         if (!test) *newid = (ID *)BKE_lamp_copy((Lamp *)id);
329                         return true;
330                 case ID_SPK:
331                         if (!test) *newid = (ID *)BKE_speaker_copy((Speaker *)id);
332                         return true;
333                 case ID_CA:
334                         if (!test) *newid = (ID *)BKE_camera_copy((Camera *)id);
335                         return true;
336                 case ID_IP:
337                         return false;  /* deprecated */
338                 case ID_KE:
339                         if (!test) *newid = (ID *)BKE_key_copy((Key *)id);
340                         return true;
341                 case ID_WO:
342                         if (!test) *newid = (ID *)BKE_world_copy((World *)id);
343                         return true;
344                 case ID_SCR:
345                         return false;  /* can't be copied from here */
346                 case ID_VF:
347                         return false;  /* not implemented */
348                 case ID_TXT:
349                         if (!test) *newid = (ID *)BKE_text_copy((Text *)id);
350                         return true;
351                 case ID_SCRIPT:
352                         return false;  /* deprecated */
353                 case ID_SO:
354                         return false;  /* not implemented */
355                 case ID_GR:
356                         if (!test) *newid = (ID *)BKE_group_copy((Group *)id);
357                         return true;
358                 case ID_AR:
359                         if (!test) *newid = (ID *)BKE_armature_copy((bArmature *)id);
360                         return true;
361                 case ID_AC:
362                         if (!test) *newid = (ID *)BKE_action_copy((bAction *)id);
363                         return true;
364                 case ID_NT:
365                         if (!test) *newid = (ID *)ntreeCopyTree((bNodeTree *)id);
366                         return true;
367                 case ID_BR:
368                         if (!test) *newid = (ID *)BKE_brush_copy((Brush *)id);
369                         return true;
370                 case ID_PA:
371                         if (!test) *newid = (ID *)BKE_particlesettings_copy((ParticleSettings *)id);
372                         return true;
373                 case ID_WM:
374                         return false;  /* can't be copied from here */
375                 case ID_GD:
376                         return false;  /* not implemented */
377                 case ID_MSK:
378                         if (!test) *newid = (ID *)BKE_mask_copy((Mask *)id);
379                         return true;
380         }
381         
382         return false;
383 }
384
385 bool id_unlink(ID *id, int test)
386 {
387         Main *mainlib = G.main;
388         ListBase *lb;
389
390         switch (GS(id->name)) {
391                 case ID_TXT:
392                         if (test) return true;
393                         BKE_text_unlink(mainlib, (Text *)id);
394                         break;
395                 case ID_GR:
396                         if (test) return true;
397                         BKE_group_unlink((Group *)id);
398                         break;
399                 case ID_OB:
400                         if (test) return true;
401                         BKE_object_unlink((Object *)id);
402                         break;
403         }
404
405         if (id->us == 0) {
406                 if (test) return true;
407
408                 lb = which_libbase(mainlib, GS(id->name));
409                 BKE_libblock_free(lb, id);
410
411                 return true;
412         }
413
414         return false;
415 }
416
417 bool id_single_user(bContext *C, ID *id, PointerRNA *ptr, PropertyRNA *prop)
418 {
419         ID *newid = NULL;
420         PointerRNA idptr;
421         
422         if (id) {
423                 /* if property isn't editable, we're going to have an extra block hanging around until we save */
424                 if (RNA_property_editable(ptr, prop)) {
425                         if (id_copy(id, &newid, false) && newid) {
426                                 /* copy animation actions too */
427                                 BKE_copy_animdata_id_action(id);
428                                 /* us is 1 by convention, but RNA_property_pointer_set
429                                  * will also increment it, so set it to zero */
430                                 newid->us = 0;
431                                 
432                                 /* assign copy */
433                                 RNA_id_pointer_create(newid, &idptr);
434                                 RNA_property_pointer_set(ptr, prop, idptr);
435                                 RNA_property_update(C, ptr, prop);
436                                 
437                                 return true;
438                         }
439                 }
440         }
441         
442         return false;
443 }
444
445 ListBase *which_libbase(Main *mainlib, short type)
446 {
447         switch (type) {
448                 case ID_SCE:
449                         return &(mainlib->scene);
450                 case ID_LI:
451                         return &(mainlib->library);
452                 case ID_OB:
453                         return &(mainlib->object);
454                 case ID_ME:
455                         return &(mainlib->mesh);
456                 case ID_CU:
457                         return &(mainlib->curve);
458                 case ID_MB:
459                         return &(mainlib->mball);
460                 case ID_MA:
461                         return &(mainlib->mat);
462                 case ID_TE:
463                         return &(mainlib->tex);
464                 case ID_IM:
465                         return &(mainlib->image);
466                 case ID_LT:
467                         return &(mainlib->latt);
468                 case ID_LA:
469                         return &(mainlib->lamp);
470                 case ID_CA:
471                         return &(mainlib->camera);
472                 case ID_IP:
473                         return &(mainlib->ipo);
474                 case ID_KE:
475                         return &(mainlib->key);
476                 case ID_WO:
477                         return &(mainlib->world);
478                 case ID_SCR:
479                         return &(mainlib->screen);
480                 case ID_VF:
481                         return &(mainlib->vfont);
482                 case ID_TXT:
483                         return &(mainlib->text);
484                 case ID_SCRIPT:
485                         return &(mainlib->script);
486                 case ID_SPK:
487                         return &(mainlib->speaker);
488                 case ID_SO:
489                         return &(mainlib->sound);
490                 case ID_GR:
491                         return &(mainlib->group);
492                 case ID_AR:
493                         return &(mainlib->armature);
494                 case ID_AC:
495                         return &(mainlib->action);
496                 case ID_NT:
497                         return &(mainlib->nodetree);
498                 case ID_BR:
499                         return &(mainlib->brush);
500                 case ID_PA:
501                         return &(mainlib->particle);
502                 case ID_WM:
503                         return &(mainlib->wm);
504                 case ID_GD:
505                         return &(mainlib->gpencil);
506                 case ID_MC:
507                         return &(mainlib->movieclip);
508                 case ID_MSK:
509                         return &(mainlib->mask);
510         }
511         return NULL;
512 }
513
514 /* Flag all ids in listbase */
515 void flag_listbase_ids(ListBase *lb, short flag, short value)
516 {
517         ID *id;
518         if (value) {
519                 for (id = lb->first; id; id = id->next) id->flag |= flag;
520         }
521         else {
522                 flag = ~flag;
523                 for (id = lb->first; id; id = id->next) id->flag &= flag;
524         }
525 }
526
527 /* Flag all ids in listbase */
528 void flag_all_listbases_ids(short flag, short value)
529 {
530         ListBase *lbarray[MAX_LIBARRAY];
531         int a;
532         a = set_listbasepointers(G.main, lbarray);
533         while (a--) flag_listbase_ids(lbarray[a], flag, value);
534 }
535
536 void recalc_all_library_objects(Main *main)
537 {
538         Object *ob;
539
540         /* flag for full recalc */
541         for (ob = main->object.first; ob; ob = ob->id.next)
542                 if (ob->id.lib)
543                         ob->recalc |= OB_RECALC_OB | OB_RECALC_DATA | OB_RECALC_TIME;
544 }
545
546 /**
547  * puts into array *lb pointers to all the ListBase structs in main,
548  * and returns the number of them as the function result. This is useful for
549  * generic traversal of all the blocks in a Main (by traversing all the
550  * lists in turn), without worrying about block types.
551  *
552  * \note MAX_LIBARRAY define should match this code */
553 int set_listbasepointers(Main *main, ListBase **lb)
554 {
555         int a = 0;
556
557         /* BACKWARDS! also watch order of free-ing! (mesh<->mat), first items freed last.
558          * This is important because freeing data decreases usercounts of other datablocks,
559          * if this data is its self freed it can crash. */
560         lb[a++] = &(main->ipo);
561         lb[a++] = &(main->action); // xxx moved here to avoid problems when freeing with animato (aligorith)
562         lb[a++] = &(main->key);
563         lb[a++] = &(main->gpencil); /* referenced by nodes, objects, view, scene etc, before to free after. */
564         lb[a++] = &(main->nodetree);
565         lb[a++] = &(main->image);
566         lb[a++] = &(main->tex);
567         lb[a++] = &(main->mat);
568         lb[a++] = &(main->vfont);
569         
570         /* Important!: When adding a new object type,
571          * the specific data should be inserted here 
572          */
573
574         lb[a++] = &(main->armature);
575
576         lb[a++] = &(main->mesh);
577         lb[a++] = &(main->curve);
578         lb[a++] = &(main->mball);
579
580         lb[a++] = &(main->latt);
581         lb[a++] = &(main->lamp);
582         lb[a++] = &(main->camera);
583
584         lb[a++] = &(main->text);
585         lb[a++] = &(main->sound);
586         lb[a++] = &(main->group);
587         lb[a++] = &(main->brush);
588         lb[a++] = &(main->script);
589         lb[a++] = &(main->particle);
590         lb[a++] = &(main->speaker);
591
592         lb[a++] = &(main->world);
593         lb[a++] = &(main->screen);
594         lb[a++] = &(main->object);
595         lb[a++] = &(main->scene);
596         lb[a++] = &(main->library);
597         lb[a++] = &(main->wm);
598         lb[a++] = &(main->movieclip);
599         lb[a++] = &(main->mask);
600         
601         lb[a] = NULL;
602
603         return a;
604 }
605
606 /* *********** ALLOC AND FREE *****************
607  *
608  * BKE_libblock_free(ListBase *lb, ID *id )
609  * provide a list-basis and datablock, but only ID is read
610  *
611  * void *BKE_libblock_alloc(ListBase *lb, type, name)
612  * inserts in list and returns a new ID
613  *
614  * **************************** */
615
616 /**
617  * Allocates and returns memory of the right size for the specified block type,
618  * initialized to zero.
619  */
620 static ID *alloc_libblock_notest(short type)
621 {
622         ID *id = NULL;
623         
624         switch (type) {
625                 case ID_SCE:
626                         id = MEM_callocN(sizeof(Scene), "scene");
627                         break;
628                 case ID_LI:
629                         id = MEM_callocN(sizeof(Library), "library");
630                         break;
631                 case ID_OB:
632                         id = MEM_callocN(sizeof(Object), "object");
633                         break;
634                 case ID_ME:
635                         id = MEM_callocN(sizeof(Mesh), "mesh");
636                         break;
637                 case ID_CU:
638                         id = MEM_callocN(sizeof(Curve), "curve");
639                         break;
640                 case ID_MB:
641                         id = MEM_callocN(sizeof(MetaBall), "mball");
642                         break;
643                 case ID_MA:
644                         id = MEM_callocN(sizeof(Material), "mat");
645                         break;
646                 case ID_TE:
647                         id = MEM_callocN(sizeof(Tex), "tex");
648                         break;
649                 case ID_IM:
650                         id = MEM_callocN(sizeof(Image), "image");
651                         break;
652                 case ID_LT:
653                         id = MEM_callocN(sizeof(Lattice), "latt");
654                         break;
655                 case ID_LA:
656                         id = MEM_callocN(sizeof(Lamp), "lamp");
657                         break;
658                 case ID_CA:
659                         id = MEM_callocN(sizeof(Camera), "camera");
660                         break;
661                 case ID_IP:
662                         id = MEM_callocN(sizeof(Ipo), "ipo");
663                         break;
664                 case ID_KE:
665                         id = MEM_callocN(sizeof(Key), "key");
666                         break;
667                 case ID_WO:
668                         id = MEM_callocN(sizeof(World), "world");
669                         break;
670                 case ID_SCR:
671                         id = MEM_callocN(sizeof(bScreen), "screen");
672                         break;
673                 case ID_VF:
674                         id = MEM_callocN(sizeof(VFont), "vfont");
675                         break;
676                 case ID_TXT:
677                         id = MEM_callocN(sizeof(Text), "text");
678                         break;
679                 case ID_SCRIPT:
680                         //XXX id = MEM_callocN(sizeof(Script), "script");
681                         break;
682                 case ID_SPK:
683                         id = MEM_callocN(sizeof(Speaker), "speaker");
684                         break;
685                 case ID_SO:
686                         id = MEM_callocN(sizeof(bSound), "sound");
687                         break;
688                 case ID_GR:
689                         id = MEM_callocN(sizeof(Group), "group");
690                         break;
691                 case ID_AR:
692                         id = MEM_callocN(sizeof(bArmature), "armature");
693                         break;
694                 case ID_AC:
695                         id = MEM_callocN(sizeof(bAction), "action");
696                         break;
697                 case ID_NT:
698                         id = MEM_callocN(sizeof(bNodeTree), "nodetree");
699                         break;
700                 case ID_BR:
701                         id = MEM_callocN(sizeof(Brush), "brush");
702                         break;
703                 case ID_PA:
704                         id = MEM_callocN(sizeof(ParticleSettings), "ParticleSettings");
705                         break;
706                 case ID_WM:
707                         id = MEM_callocN(sizeof(wmWindowManager), "Window manager");
708                         break;
709                 case ID_GD:
710                         id = MEM_callocN(sizeof(bGPdata), "Grease Pencil");
711                         break;
712                 case ID_MC:
713                         id = MEM_callocN(sizeof(MovieClip), "Movie Clip");
714                         break;
715                 case ID_MSK:
716                         id = MEM_callocN(sizeof(Mask), "Mask");
717                         break;
718         }
719         return id;
720 }
721
722 /**
723  * Allocates and returns a block of the specified type, with the specified name
724  * (adjusted as necessary to ensure uniqueness), and appended to the specified list.
725  * The user count is set to 1, all other content (apart from name and links) being
726  * initialized to zero.
727  */
728 void *BKE_libblock_alloc(ListBase *lb, short type, const char *name)
729 {
730         ID *id = NULL;
731         
732         id = alloc_libblock_notest(type);
733         if (id) {
734                 BLI_addtail(lb, id);
735                 id->us = 1;
736                 id->icon_id = 0;
737                 *( (short *)id->name) = type;
738                 new_id(lb, id, name);
739                 /* alphabetic insertion: is in new_id */
740         }
741         return id;
742 }
743
744 /* by spec, animdata is first item after ID */
745 /* and, trust that BKE_animdata_from_id() will only find AnimData for valid ID-types */
746 static void id_copy_animdata(ID *id, const bool do_action)
747 {
748         AnimData *adt = BKE_animdata_from_id(id);
749         
750         if (adt) {
751                 IdAdtTemplate *iat = (IdAdtTemplate *)id;
752                 iat->adt = BKE_copy_animdata(iat->adt, do_action); /* could be set to false, need to investigate */
753         }
754 }
755
756 /* material nodes use this since they are not treated as libdata */
757 void BKE_libblock_copy_data(ID *id, const ID *id_from, const bool do_action)
758 {
759         if (id_from->properties)
760                 id->properties = IDP_CopyProperty(id_from->properties);
761
762         /* the duplicate should get a copy of the animdata */
763         id_copy_animdata(id, do_action);
764 }
765
766 /* used everywhere in blenkernel */
767 void *BKE_libblock_copy_ex(Main *bmain, ID *id)
768 {
769         ID *idn;
770         ListBase *lb;
771         size_t idn_len;
772
773         lb = which_libbase(bmain, GS(id->name));
774         idn = BKE_libblock_alloc(lb, GS(id->name), id->name + 2);
775
776         assert(idn != NULL);
777
778         idn_len = MEM_allocN_len(idn);
779         if ((int)idn_len - (int)sizeof(ID) > 0) { /* signed to allow neg result */
780                 const char *cp = (const char *)id;
781                 char *cpn = (char *)idn;
782
783                 memcpy(cpn + sizeof(ID), cp + sizeof(ID), idn_len - sizeof(ID));
784         }
785         
786         id->newid = idn;
787         idn->flag |= LIB_NEW;
788
789         BKE_libblock_copy_data(idn, id, false);
790         
791         return idn;
792 }
793
794 void *BKE_libblock_copy(ID *id)
795 {
796         return BKE_libblock_copy_ex(G.main, id);
797 }
798
799 static void BKE_library_free(Library *lib)
800 {
801         if (lib->packedfile)
802                 freePackedFile(lib->packedfile);
803 }
804
805 static void (*free_windowmanager_cb)(bContext *, wmWindowManager *) = NULL;
806
807 void set_free_windowmanager_cb(void (*func)(bContext *C, wmWindowManager *) )
808 {
809         free_windowmanager_cb = func;
810 }
811
812 static void animdata_dtar_clear_cb(ID *UNUSED(id), AnimData *adt, void *userdata)
813 {
814         ChannelDriver *driver;
815         FCurve *fcu;
816
817         /* find the driver this belongs to and update it */
818         for (fcu = adt->drivers.first; fcu; fcu = fcu->next) {
819                 driver = fcu->driver;
820                 
821                 if (driver) {
822                         DriverVar *dvar;
823                         for (dvar = driver->variables.first; dvar; dvar = dvar->next) {
824                                 DRIVER_TARGETS_USED_LOOPER(dvar) 
825                                 {
826                                         if (dtar->id == userdata)
827                                                 dtar->id = NULL;
828                                 }
829                                 DRIVER_TARGETS_LOOPER_END
830                         }
831                 }
832         }
833 }
834
835 void BKE_libblock_free_data(ID *id)
836 {
837         Main *bmain = G.main;  /* should eventually be an arg */
838         
839         if (id->properties) {
840                 IDP_FreeProperty(id->properties);
841                 MEM_freeN(id->properties);
842         }
843         
844         /* this ID may be a driver target! */
845         BKE_animdata_main_cb(bmain, animdata_dtar_clear_cb, (void *)id);
846 }
847
848 /* used in headerbuttons.c image.c mesh.c screen.c sound.c and library.c */
849 void BKE_libblock_free(ListBase *lb, void *idv)
850 {
851         Main *bmain = G.main;  /* should eventually be an arg */
852         ID *id = idv;
853
854 #ifdef WITH_PYTHON
855         BPY_id_release(id);
856 #endif
857
858         switch (GS(id->name) ) {    /* GetShort from util.h */
859                 case ID_SCE:
860                         BKE_scene_free((Scene *)id);
861                         break;
862                 case ID_LI:
863                         BKE_library_free((Library *)id);
864                         break;
865                 case ID_OB:
866                         BKE_object_free((Object *)id);
867                         break;
868                 case ID_ME:
869                         BKE_mesh_free((Mesh *)id, 1);
870                         break;
871                 case ID_CU:
872                         BKE_curve_free((Curve *)id);
873                         break;
874                 case ID_MB:
875                         BKE_mball_free((MetaBall *)id);
876                         break;
877                 case ID_MA:
878                         BKE_material_free((Material *)id);
879                         break;
880                 case ID_TE:
881                         BKE_texture_free((Tex *)id);
882                         break;
883                 case ID_IM:
884                         BKE_image_free((Image *)id);
885                         break;
886                 case ID_LT:
887                         BKE_lattice_free((Lattice *)id);
888                         break;
889                 case ID_LA:
890                         BKE_lamp_free((Lamp *)id);
891                         break;
892                 case ID_CA:
893                         BKE_camera_free((Camera *) id);
894                         break;
895                 case ID_IP:
896                         BKE_ipo_free((Ipo *)id);
897                         break;
898                 case ID_KE:
899                         BKE_key_free((Key *)id);
900                         break;
901                 case ID_WO:
902                         BKE_world_free((World *)id);
903                         break;
904                 case ID_SCR:
905                         BKE_screen_free((bScreen *)id);
906                         break;
907                 case ID_VF:
908                         BKE_vfont_free((VFont *)id);
909                         break;
910                 case ID_TXT:
911                         BKE_text_free((Text *)id);
912                         break;
913                 case ID_SCRIPT:
914                         /* deprecated */
915                         break;
916                 case ID_SPK:
917                         BKE_speaker_free((Speaker *)id);
918                         break;
919                 case ID_SO:
920                         BKE_sound_free((bSound *)id);
921                         break;
922                 case ID_GR:
923                         BKE_group_free((Group *)id);
924                         break;
925                 case ID_AR:
926                         BKE_armature_free((bArmature *)id);
927                         break;
928                 case ID_AC:
929                         BKE_action_free((bAction *)id);
930                         break;
931                 case ID_NT:
932                         ntreeFreeTree((bNodeTree *)id);
933                         break;
934                 case ID_BR:
935                         BKE_brush_free((Brush *)id);
936                         break;
937                 case ID_PA:
938                         BKE_particlesettings_free((ParticleSettings *)id);
939                         break;
940                 case ID_WM:
941                         if (free_windowmanager_cb)
942                                 free_windowmanager_cb(NULL, (wmWindowManager *)id);
943                         break;
944                 case ID_GD:
945                         BKE_gpencil_free((bGPdata *)id);
946                         break;
947                 case ID_MC:
948                         BKE_movieclip_free((MovieClip *)id);
949                         break;
950                 case ID_MSK:
951                         BKE_mask_free(bmain, (Mask *)id);
952                         break;
953         }
954
955         BLI_remlink(lb, id);
956
957         BKE_libblock_free_data(id);
958
959         MEM_freeN(id);
960 }
961
962 void BKE_libblock_free_us(ListBase *lb, void *idv)      /* test users */
963 {
964         ID *id = idv;
965         
966         id->us--;
967
968         if (id->us < 0) {
969                 if (id->lib) printf("ERROR block %s %s users %d\n", id->lib->name, id->name, id->us);
970                 else printf("ERROR block %s users %d\n", id->name, id->us);
971         }
972         if (id->us == 0) {
973                 if (GS(id->name) == ID_OB) BKE_object_unlink((Object *)id);
974                 
975                 BKE_libblock_free(lb, id);
976         }
977 }
978
979
980 void free_main(Main *mainvar)
981 {
982         /* also call when reading a file, erase all, etc */
983         ListBase *lbarray[MAX_LIBARRAY];
984         int a;
985
986         a = set_listbasepointers(mainvar, lbarray);
987         while (a--) {
988                 ListBase *lb = lbarray[a];
989                 ID *id;
990                 
991                 while ( (id = lb->first) ) {
992 #if 1
993                         BKE_libblock_free(lb, id);
994 #else
995                         /* errors freeing ID's can be hard to track down,
996                          * enable this so valgrind will give the line number in its error log */
997                         switch (a) {
998                                 case   0: BKE_libblock_free(lb, id); break;
999                                 case   1: BKE_libblock_free(lb, id); break;
1000                                 case   2: BKE_libblock_free(lb, id); break;
1001                                 case   3: BKE_libblock_free(lb, id); break;
1002                                 case   4: BKE_libblock_free(lb, id); break;
1003                                 case   5: BKE_libblock_free(lb, id); break;
1004                                 case   6: BKE_libblock_free(lb, id); break;
1005                                 case   7: BKE_libblock_free(lb, id); break;
1006                                 case   8: BKE_libblock_free(lb, id); break;
1007                                 case   9: BKE_libblock_free(lb, id); break;
1008                                 case  10: BKE_libblock_free(lb, id); break;
1009                                 case  11: BKE_libblock_free(lb, id); break;
1010                                 case  12: BKE_libblock_free(lb, id); break;
1011                                 case  13: BKE_libblock_free(lb, id); break;
1012                                 case  14: BKE_libblock_free(lb, id); break;
1013                                 case  15: BKE_libblock_free(lb, id); break;
1014                                 case  16: BKE_libblock_free(lb, id); break;
1015                                 case  17: BKE_libblock_free(lb, id); break;
1016                                 case  18: BKE_libblock_free(lb, id); break;
1017                                 case  19: BKE_libblock_free(lb, id); break;
1018                                 case  20: BKE_libblock_free(lb, id); break;
1019                                 case  21: BKE_libblock_free(lb, id); break;
1020                                 case  22: BKE_libblock_free(lb, id); break;
1021                                 case  23: BKE_libblock_free(lb, id); break;
1022                                 case  24: BKE_libblock_free(lb, id); break;
1023                                 case  25: BKE_libblock_free(lb, id); break;
1024                                 case  26: BKE_libblock_free(lb, id); break;
1025                                 case  27: BKE_libblock_free(lb, id); break;
1026                                 case  28: BKE_libblock_free(lb, id); break;
1027                                 case  29: BKE_libblock_free(lb, id); break;
1028                                 case  30: BKE_libblock_free(lb, id); break;
1029                                 case  31: BKE_libblock_free(lb, id); break;
1030                                 case  32: BKE_libblock_free(lb, id); break;
1031                                 default:
1032                                         BLI_assert(0);
1033                         }
1034 #endif
1035                 }
1036         }
1037
1038         MEM_freeN(mainvar);
1039 }
1040
1041 /* ***************** ID ************************ */
1042
1043
1044 ID *BKE_libblock_find_name(const short type, const char *name)      /* type: "OB" or "MA" etc */
1045 {
1046         ListBase *lb = which_libbase(G.main, type);
1047         BLI_assert(lb != NULL);
1048         return BLI_findstring(lb, name, offsetof(ID, name) + 2);
1049 }
1050
1051 static void get_flags_for_id(ID *id, char *buf) 
1052 {
1053         int isfake = id->flag & LIB_FAKEUSER;
1054         int isnode = 0;
1055         /* Writeout the flags for the entry, note there
1056          * is a small hack that writes 5 spaces instead
1057          * of 4 if no flags are displayed... this makes
1058          * things usually line up ok - better would be
1059          * to have that explicit, oh well - zr
1060          */
1061
1062         if (GS(id->name) == ID_MA)
1063                 isnode = ((Material *)id)->use_nodes;
1064         if (GS(id->name) == ID_TE)
1065                 isnode = ((Tex *)id)->use_nodes;
1066         
1067         if (id->us < 0)
1068                 strcpy(buf, "-1W ");
1069         else if (!id->lib && !isfake && id->us && !isnode)
1070                 strcpy(buf, "     ");
1071         else if (isnode)
1072                 sprintf(buf, "%c%cN%c ", id->lib ? 'L' : ' ', isfake ? 'F' : ' ', (id->us == 0) ? 'O' : ' ');
1073         else
1074                 sprintf(buf, "%c%c%c ", id->lib ? 'L' : ' ', isfake ? 'F' : ' ', (id->us == 0) ? 'O' : ' ');
1075 }
1076
1077 #define IDPUP_NO_VIEWER 1
1078
1079 static void IDnames_to_dyn_pupstring(DynStr *pupds, ListBase *lb, ID *link, short *nr, int hideflag)
1080 {
1081         int i, nids = BLI_countlist(lb);
1082                 
1083         if (nr) *nr = -1;
1084         
1085         if (nr && nids > MAX_IDPUP) {
1086                 BLI_dynstr_append(pupds, "DataBrowse %x-2");
1087                 *nr = -2;
1088         }
1089         else {
1090                 ID *id;
1091                 
1092                 for (i = 0, id = lb->first; id; id = id->next, i++) {
1093                         char numstr[32];
1094                         
1095                         if (nr && id == link) *nr = i + 1;
1096
1097                         if (U.uiflag & USER_HIDE_DOT && id->name[2] == '.')
1098                                 continue;
1099                         if (hideflag & IDPUP_NO_VIEWER)
1100                                 if (GS(id->name) == ID_IM)
1101                                         if ( ((Image *)id)->source == IMA_SRC_VIEWER)
1102                                                 continue;
1103                         
1104                         get_flags_for_id(id, numstr);
1105                                 
1106                         BLI_dynstr_append(pupds, numstr);
1107                         BLI_dynstr_append(pupds, id->name + 2);
1108                         BLI_snprintf(numstr, sizeof(numstr), "%%x%d", i + 1);
1109                         BLI_dynstr_append(pupds, numstr);
1110                         
1111                         /* icon */
1112                         switch (GS(id->name)) {
1113                                 case ID_MA: /* fall through */
1114                                 case ID_TE: /* fall through */
1115                                 case ID_IM: /* fall through */
1116                                 case ID_WO: /* fall through */
1117                                 case ID_LA: /* fall through */
1118                                         BLI_snprintf(numstr, sizeof(numstr), "%%i%d", BKE_icon_getid(id));
1119                                         BLI_dynstr_append(pupds, numstr);
1120                                         break;
1121                                 default:
1122                                         break;
1123                         }
1124                         
1125                         if (id->next)
1126                                 BLI_dynstr_append(pupds, "|");
1127                 }
1128         }
1129 }
1130
1131
1132 /* used by headerbuttons.c buttons.c editobject.c editseq.c */
1133 /* if (nr == NULL) no MAX_IDPUP, this for non-header browsing */
1134 void IDnames_to_pupstring(const char **str, const char *title, const char *extraops, ListBase *lb, ID *link, short *nr)
1135 {
1136         DynStr *pupds = BLI_dynstr_new();
1137
1138         if (title) {
1139                 BLI_dynstr_append(pupds, title);
1140                 BLI_dynstr_append(pupds, "%t|");
1141         }
1142         
1143         if (extraops) {
1144                 BLI_dynstr_append(pupds, extraops);
1145                 if (BLI_dynstr_get_len(pupds))
1146                         BLI_dynstr_append(pupds, "|");
1147         }
1148
1149         IDnames_to_dyn_pupstring(pupds, lb, link, nr, 0);
1150         
1151         *str = BLI_dynstr_get_cstring(pupds);
1152         BLI_dynstr_free(pupds);
1153 }
1154
1155 /* skips viewer images */
1156 #if 0 /* unused */
1157 void IMAnames_to_pupstring(const char **str, const char *title, const char *extraops, ListBase *lb, ID *link, short *nr)
1158 {
1159         DynStr *pupds = BLI_dynstr_new();
1160         
1161         if (title) {
1162                 BLI_dynstr_append(pupds, title);
1163                 BLI_dynstr_append(pupds, "%t|");
1164         }
1165         
1166         if (extraops) {
1167                 BLI_dynstr_append(pupds, extraops);
1168                 if (BLI_dynstr_get_len(pupds))
1169                         BLI_dynstr_append(pupds, "|");
1170         }
1171         
1172         IDnames_to_dyn_pupstring(pupds, lb, link, nr, IDPUP_NO_VIEWER);
1173         
1174         *str = BLI_dynstr_get_cstring(pupds);
1175         BLI_dynstr_free(pupds);
1176 }
1177 #endif
1178
1179 void id_sort_by_name(ListBase *lb, ID *id)
1180 {
1181         ID *idtest;
1182         
1183         /* insert alphabetically */
1184         if (lb->first != lb->last) {
1185                 BLI_remlink(lb, id);
1186                 
1187                 idtest = lb->first;
1188                 while (idtest) {
1189                         if (BLI_strcasecmp(idtest->name, id->name) > 0 || (idtest->lib && !id->lib)) {
1190                                 BLI_insertlinkbefore(lb, idtest, id);
1191                                 break;
1192                         }
1193                         idtest = idtest->next;
1194                 }
1195                 /* as last */
1196                 if (idtest == NULL) {
1197                         BLI_addtail(lb, id);
1198                 }
1199         }
1200         
1201 }
1202
1203 /**
1204  * Check to see if there is an ID with the same name as 'name'.
1205  * Returns the ID if so, if not, returns NULL
1206  */
1207 static ID *is_dupid(ListBase *lb, ID *id, const char *name)
1208 {
1209         ID *idtest = NULL;
1210         
1211         for (idtest = lb->first; idtest; idtest = idtest->next) {
1212                 /* if idtest is not a lib */ 
1213                 if (id != idtest && idtest->lib == NULL) {
1214                         /* do not test alphabetic! */
1215                         /* optimized */
1216                         if (idtest->name[2] == name[0]) {
1217                                 if (strcmp(name, idtest->name + 2) == 0) break;
1218                         }
1219                 }
1220         }
1221         
1222         return idtest;
1223 }
1224
1225 /**
1226  * Check to see if an ID name is already used, and find a new one if so.
1227  * Return true if created a new name (returned in name).
1228  *
1229  * Normally the ID that's being check is already in the ListBase, so ID *id
1230  * points at the new entry.  The Python Library module needs to know what
1231  * the name of a datablock will be before it is appended; in this case ID *id
1232  * id is NULL
1233  */
1234
1235 static bool check_for_dupid(ListBase *lb, ID *id, char *name)
1236 {
1237         ID *idtest;
1238         int nr = 0, nrtest, a, left_len;
1239 #define MAX_IN_USE 64
1240         bool in_use[MAX_IN_USE];
1241         /* to speed up finding unused numbers within [1 .. MAX_IN_USE - 1] */
1242
1243         char left[MAX_ID_NAME + 8], leftest[MAX_ID_NAME + 8];
1244
1245         /* make sure input name is terminated properly */
1246         /* if ( strlen(name) > MAX_ID_NAME-3 ) name[MAX_ID_NAME-3] = 0; */
1247         /* removed since this is only ever called from one place - campbell */
1248
1249         while (true) {
1250
1251                 /* phase 1: id already exists? */
1252                 idtest = is_dupid(lb, id, name);
1253
1254                 /* if there is no double, done */
1255                 if (idtest == NULL) return false;
1256
1257                 /* we have a dup; need to make a new name */
1258                 /* quick check so we can reuse one of first MAX_IN_USE - 1 ids if vacant */
1259                 memset(in_use, false, sizeof(in_use));
1260
1261                 /* get name portion, number portion ("name.number") */
1262                 left_len = BLI_split_name_num(left, &nr, name, '.');
1263
1264                 /* if new name will be too long, truncate it */
1265                 if (nr > 999 && left_len > (MAX_ID_NAME - 8)) {  /* assumption: won't go beyond 9999 */
1266                         left[MAX_ID_NAME - 8] = 0;
1267                         left_len = MAX_ID_NAME - 8;
1268                 }
1269                 else if (left_len > (MAX_ID_NAME - 7)) {
1270                         left[MAX_ID_NAME - 7] = 0;
1271                         left_len = MAX_ID_NAME - 7;
1272                 }
1273
1274                 for (idtest = lb->first; idtest; idtest = idtest->next) {
1275                         if ( (id != idtest) &&
1276                              (idtest->lib == NULL) &&
1277                              (*name == *(idtest->name + 2)) &&
1278                              (strncmp(name, idtest->name + 2, left_len) == 0) &&
1279                              (BLI_split_name_num(leftest, &nrtest, idtest->name + 2, '.') == left_len)
1280                              )
1281                         {
1282                                 /* will get here at least once, otherwise is_dupid call above would have returned NULL */
1283                                 if (nrtest < MAX_IN_USE)
1284                                         in_use[nrtest] = true;  /* mark as used */
1285                                 if (nr <= nrtest)
1286                                         nr = nrtest + 1;    /* track largest unused */
1287                         }
1288                 }
1289                 /* At this point, nr will be at least 1. */
1290                 BLI_assert(nr >= 1);
1291
1292                 /* decide which value of nr to use */
1293                 for (a = 0; a < MAX_IN_USE; a++) {
1294                         if (a >= nr) break;  /* stop when we've checked up to biggest */  /* redundant check */
1295                         if (!in_use[a]) { /* found an unused value */
1296                                 nr = a;
1297                                 /* can only be zero if all potential duplicate names had
1298                                  * nonzero numeric suffixes, which means name itself has
1299                                  * nonzero numeric suffix (else no name conflict and wouldn't
1300                                  * have got here), which means name[left_len] is not a null */
1301                                 break;
1302                         }
1303                 }
1304                 /* At this point, nr is either the lowest unused number within [0 .. MAX_IN_USE - 1],
1305                  * or 1 greater than the largest used number if all those low ones are taken.
1306                  * We can't be bothered to look for the lowest unused number beyond (MAX_IN_USE - 1). */
1307
1308                 /* If the original name has no numeric suffix, 
1309                  * rather than just chopping and adding numbers, 
1310                  * shave off the end chars until we have a unique name.
1311                  * Check the null terminators match as well so we don't get Cube.000 -> Cube.00 */
1312                 if (nr == 0 && name[left_len] == '\0') {
1313                         int len;
1314                         /* FIXME: this code will never be executed, because either nr will be
1315                          * at least 1, or name will not end at left_len! */
1316                         BLI_assert(0);
1317
1318                         len = left_len - 1;
1319                         idtest = is_dupid(lb, id, name);
1320                         
1321                         while (idtest && len > 1) {
1322                                 name[len--] = '\0';
1323                                 idtest = is_dupid(lb, id, name);
1324                         }
1325                         if (idtest == NULL) return true;
1326                         /* otherwise just continue and use a number suffix */
1327                 }
1328                 
1329                 if (nr > 999 && left_len > (MAX_ID_NAME - 8)) {
1330                         /* this would overflow name buffer */
1331                         left[MAX_ID_NAME - 8] = 0;
1332                         /* left_len = MAX_ID_NAME - 8; */ /* for now this isn't used again */
1333                         memcpy(name, left, sizeof(char) * (MAX_ID_NAME - 7));
1334                         continue;
1335                 }
1336                 /* this format specifier is from hell... */
1337                 BLI_snprintf(name, sizeof(id->name) - 2, "%s.%.3d", left, nr);
1338
1339                 return true;
1340         }
1341
1342 #undef MAX_IN_USE
1343 }
1344
1345 /*
1346  * Only for local blocks: external en indirect blocks already have a
1347  * unique ID.
1348  *
1349  * return true: created a new name
1350  */
1351
1352 bool new_id(ListBase *lb, ID *id, const char *tname)
1353 {
1354         bool result;
1355         char name[MAX_ID_NAME - 2];
1356
1357         /* if library, don't rename */
1358         if (id->lib) return false;
1359
1360         /* if no libdata given, look up based on ID */
1361         if (lb == NULL) lb = which_libbase(G.main, GS(id->name));
1362
1363         /* if no name given, use name of current ID
1364          * else make a copy (tname args can be const) */
1365         if (tname == NULL)
1366                 tname = id->name + 2;
1367
1368         strncpy(name, tname, sizeof(name) - 1);
1369
1370         /* if result > MAX_ID_NAME-3, strncpy don't put the final '\0' to name.
1371          * easier to assign each time then to check if its needed */
1372         name[sizeof(name) - 1] = 0;
1373
1374         if (name[0] == '\0') {
1375                 /* disallow empty names */
1376                 strcpy(name, ID_FALLBACK_NAME);
1377         }
1378         else {
1379                 /* disallow non utf8 chars,
1380                  * the interface checks for this but new ID's based on file names don't */
1381                 BLI_utf8_invalid_strip(name, strlen(name));
1382         }
1383
1384         result = check_for_dupid(lb, id, name);
1385         strcpy(id->name + 2, name);
1386
1387         /* This was in 2.43 and previous releases
1388          * however all data in blender should be sorted, not just duplicate names
1389          * sorting should not hurt, but noting just incause it alters the way other
1390          * functions work, so sort every time */
1391 #if 0
1392         if (result)
1393                 id_sort_by_name(lb, id);
1394 #endif
1395
1396         id_sort_by_name(lb, id);
1397         
1398         return result;
1399 }
1400
1401 /* Pull an ID out of a library (make it local). Only call this for IDs that
1402  * don't have other library users. */
1403 void id_clear_lib_data(Main *bmain, ID *id)
1404 {
1405         BKE_id_lib_local_paths(bmain, id->lib, id);
1406
1407         id->lib = NULL;
1408         id->flag = LIB_LOCAL;
1409         new_id(which_libbase(bmain, GS(id->name)), id, NULL);
1410 }
1411
1412 /* next to indirect usage in read/writefile also in editobject.c scene.c */
1413 void clear_id_newpoins(void)
1414 {
1415         ListBase *lbarray[MAX_LIBARRAY];
1416         ID *id;
1417         int a;
1418
1419         a = set_listbasepointers(G.main, lbarray);
1420         while (a--) {
1421                 id = lbarray[a]->first;
1422                 while (id) {
1423                         id->newid = NULL;
1424                         id->flag &= ~LIB_NEW;
1425                         id = id->next;
1426                 }
1427         }
1428 }
1429
1430 static void lib_indirect_test_id(ID *id, Library *lib)
1431 {
1432 #define LIBTAG(a)   if (a && a->id.lib) { a->id.flag &= ~LIB_INDIRECT; a->id.flag |= LIB_EXTERN; } (void)0
1433         
1434         if (id->lib) {
1435                 /* datablocks that were indirectly related are now direct links
1436                  * without this, appending data that has a link to other data will fail to write */
1437                 if (lib && id->lib->parent == lib) {
1438                         id_lib_extern(id);
1439                 }
1440                 return;
1441         }
1442         
1443         if (GS(id->name) == ID_OB) {
1444                 Object *ob = (Object *)id;
1445                 Mesh *me;
1446
1447                 int a;
1448
1449 #if 0   /* XXX OLD ANIMSYS, NLASTRIPS ARE NO LONGER USED */
1450                 /* XXX old animation system! -------------------------------------- */
1451                 {
1452                         bActionStrip *strip;
1453                         for (strip = ob->nlastrips.first; strip; strip = strip->next) {
1454                                 LIBTAG(strip->object);
1455                                 LIBTAG(strip->act);
1456                                 LIBTAG(strip->ipo);
1457                         }
1458                 }
1459                 /* XXX: new animation system needs something like this? */
1460 #endif
1461
1462                 for (a = 0; a < ob->totcol; a++) {
1463                         LIBTAG(ob->mat[a]);
1464                 }
1465         
1466                 LIBTAG(ob->dup_group);
1467                 LIBTAG(ob->proxy);
1468                 
1469                 me = ob->data;
1470                 LIBTAG(me);
1471         }
1472
1473 #undef LIBTAG
1474 }
1475
1476 void tag_main_lb(ListBase *lb, const short tag)
1477 {
1478         ID *id;
1479         if (tag) {
1480                 for (id = lb->first; id; id = id->next) {
1481                         id->flag |= LIB_DOIT;
1482                 }
1483         }
1484         else {
1485                 for (id = lb->first; id; id = id->next) {
1486                         id->flag &= ~LIB_DOIT;
1487                 }
1488         }
1489 }
1490
1491 void tag_main_idcode(struct Main *mainvar, const short type, const short tag)
1492 {
1493         ListBase *lb = which_libbase(mainvar, type);
1494
1495         tag_main_lb(lb, tag);
1496 }
1497
1498 void tag_main(struct Main *mainvar, const short tag)
1499 {
1500         ListBase *lbarray[MAX_LIBARRAY];
1501         int a;
1502
1503         a = set_listbasepointers(mainvar, lbarray);
1504         while (a--) {
1505                 tag_main_lb(lbarray[a], tag);
1506         }
1507 }
1508
1509 /* if lib!=NULL, only all from lib local
1510  * bmain is almost certainly G.main */
1511 void BKE_library_make_local(Main *bmain, Library *lib, bool untagged_only)
1512 {
1513         ListBase *lbarray[MAX_LIBARRAY], tempbase = {NULL, NULL};
1514         ID *id, *idn;
1515         int a;
1516
1517         a = set_listbasepointers(bmain, lbarray);
1518         while (a--) {
1519                 id = lbarray[a]->first;
1520                 
1521                 while (id) {
1522                         id->newid = NULL;
1523                         idn = id->next;      /* id is possibly being inserted again */
1524                         
1525                         /* The check on the second line (LIB_PRE_EXISTING) is done so its
1526                          * possible to tag data you don't want to be made local, used for
1527                          * appending data, so any libdata already linked wont become local
1528                          * (very nasty to discover all your links are lost after appending)  
1529                          * */
1530                         if (id->flag & (LIB_EXTERN | LIB_INDIRECT | LIB_NEW) &&
1531                             ((untagged_only == false) || !(id->flag & LIB_PRE_EXISTING)))
1532                         {
1533                                 if (lib == NULL || id->lib == lib) {
1534                                         if (id->lib) {
1535                                                 id_clear_lib_data(bmain, id); /* sets 'id->flag' */
1536
1537                                                 /* why sort alphabetically here but not in
1538                                                  * id_clear_lib_data() ? - campbell */
1539                                                 id_sort_by_name(lbarray[a], id);
1540                                         }
1541                                         else {
1542                                                 id->flag &= ~(LIB_EXTERN | LIB_INDIRECT | LIB_NEW);
1543                                         }
1544                                 }
1545                         }
1546                         id = idn;
1547                 }
1548                 
1549                 /* patch2: make it aphabetically */
1550                 /* FIXME: but nothing is ever put into tempbase! */
1551                 while ( (id = tempbase.first) ) {
1552                         BLI_remlink(&tempbase, id);
1553                         BLI_addtail(lbarray[a], id);
1554                         new_id(lbarray[a], id, NULL);
1555                 }
1556         }
1557
1558         /* patch 3: make sure library data isn't indirect falsely... */
1559         a = set_listbasepointers(bmain, lbarray);
1560         while (a--) {
1561                 for (id = lbarray[a]->first; id; id = id->next)
1562                         lib_indirect_test_id(id, lib);
1563         }
1564 }
1565
1566
1567 void test_idbutton(char *name)
1568 {
1569         /* called from buttons: when name already exists: call new_id */
1570         ListBase *lb;
1571         ID *idtest;
1572         
1573
1574         lb = which_libbase(G.main, GS(name - 2) );
1575         if (lb == NULL) return;
1576         
1577         /* search for id */
1578         idtest = BLI_findstring(lb, name, offsetof(ID, name) + 2);
1579
1580         if (idtest && !new_id(lb, idtest, name)) {
1581                 id_sort_by_name(lb, idtest);
1582         }
1583 }
1584
1585 /**
1586  * Puts into *text a descriptive block type prefix to be displayed before the block name.
1587  */
1588 /* Not actually used anywhere any more. */
1589 void text_idbutton(const struct ID *id, char *text)
1590 {
1591         if (id) {
1592                 if (GS(id->name) == ID_SCE)
1593                         strcpy(text, "SCE: ");
1594                 else if (GS(id->name) == ID_SCR)
1595                         strcpy(text, "SCR: ");
1596                 else if (GS(id->name) == ID_MA && ((Material *)id)->use_nodes)
1597                         strcpy(text, "NT: ");
1598                 else {
1599                         text[0] = id->name[0];
1600                         text[1] = id->name[1];
1601                         text[2] = ':';
1602                         text[3] = ' ';
1603                         text[4] = 0;
1604                 }
1605         }
1606         else {
1607                 text[0] = '\0';
1608         }
1609 }
1610
1611 /**
1612  * Sets the name of a block to name, suitably adjusted for uniqueness.
1613  */
1614 void rename_id(ID *id, const char *name)
1615 {
1616         ListBase *lb;
1617
1618         BLI_strncpy(id->name + 2, name, sizeof(id->name) - 2);
1619         lb = which_libbase(G.main, GS(id->name) );
1620         
1621         new_id(lb, id, name);
1622 }
1623
1624 /**
1625  * Returns in name the name of the block, with a 3-character prefix prepended
1626  * indicating whether it comes from a library, has a fake user, or no users.
1627  */
1628 void name_uiprefix_id(char *name, const ID *id)
1629 {
1630         name[0] = id->lib ? 'L' : ' ';
1631         name[1] = id->flag & LIB_FAKEUSER ? 'F' : (id->us == 0) ? '0' : ' ';
1632         name[2] = ' ';
1633
1634         strcpy(name + 3, id->name + 2);
1635 }
1636
1637 void BKE_library_filepath_set(Library *lib, const char *filepath)
1638 {
1639         /* in some cases this is used to update the absolute path from the
1640          * relative */
1641         if (lib->name != filepath) {
1642                 BLI_strncpy(lib->name, filepath, sizeof(lib->name));
1643         }
1644
1645         BLI_strncpy(lib->filepath, filepath, sizeof(lib->filepath));
1646
1647         /* not essential but set filepath is an absolute copy of value which
1648          * is more useful if its kept in sync */
1649         if (BLI_path_is_rel(lib->filepath)) {
1650                 /* note that the file may be unsaved, in this case, setting the
1651                  * filepath on an indirectly linked path is not allowed from the
1652                  * outliner, and its not really supported but allow from here for now
1653                  * since making local could cause this to be directly linked - campbell
1654                  */
1655                 const char *basepath = lib->parent ? lib->parent->filepath : G.main->name;
1656                 BLI_path_abs(lib->filepath, basepath);
1657         }
1658 }