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