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