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