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