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