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