Merge branch 'blender2.7'
[blender.git] / source / blender / blenkernel / intern / library_query.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) 2014 by Blender Foundation.
19  * All rights reserved.
20  *
21  * Contributor(s): Sergey Sharybin.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file blender/blenkernel/intern/library_query.c
27  *  \ingroup bke
28  */
29
30 #include <stdlib.h>
31
32 #include "MEM_guardedalloc.h"
33
34 #include "DNA_anim_types.h"
35 #include "DNA_armature_types.h"
36 #include "DNA_brush_types.h"
37 #include "DNA_camera_types.h"
38 #include "DNA_collection_types.h"
39 #include "DNA_constraint_types.h"
40 #include "DNA_gpencil_types.h"
41 #include "DNA_key_types.h"
42 #include "DNA_lamp_types.h"
43 #include "DNA_lattice_types.h"
44 #include "DNA_linestyle_types.h"
45 #include "DNA_material_types.h"
46 #include "DNA_mesh_types.h"
47 #include "DNA_meshdata_types.h"
48 #include "DNA_meta_types.h"
49 #include "DNA_movieclip_types.h"
50 #include "DNA_mask_types.h"
51 #include "DNA_node_types.h"
52 #include "DNA_object_force_types.h"
53 #include "DNA_lightprobe_types.h"
54 #include "DNA_rigidbody_types.h"
55 #include "DNA_scene_types.h"
56 #include "DNA_sequence_types.h"
57 #include "DNA_screen_types.h"
58 #include "DNA_speaker_types.h"
59 #include "DNA_sound_types.h"
60 #include "DNA_text_types.h"
61 #include "DNA_vfont_types.h"
62 #include "DNA_windowmanager_types.h"
63 #include "DNA_workspace_types.h"
64 #include "DNA_world_types.h"
65
66 #include "BLI_utildefines.h"
67 #include "BLI_listbase.h"
68 #include "BLI_ghash.h"
69 #include "BLI_linklist_stack.h"
70
71 #include "BKE_animsys.h"
72 #include "BKE_collection.h"
73 #include "BKE_constraint.h"
74 #include "BKE_fcurve.h"
75 #include "BKE_gpencil_modifier.h"
76 #include "BKE_idprop.h"
77 #include "BKE_library.h"
78 #include "BKE_library_query.h"
79 #include "BKE_main.h"
80 #include "BKE_modifier.h"
81 #include "BKE_node.h"
82 #include "BKE_particle.h"
83 #include "BKE_rigidbody.h"
84 #include "BKE_sequencer.h"
85 #include "BKE_tracking.h"
86 #include "BKE_workspace.h"
87
88
89 #define FOREACH_FINALIZE _finalize
90 #define FOREACH_FINALIZE_VOID \
91         if (0) { goto FOREACH_FINALIZE; } \
92         FOREACH_FINALIZE: ((void)0)
93
94 #define FOREACH_CALLBACK_INVOKE_ID_PP(_data, id_pp, _cb_flag) \
95         CHECK_TYPE(id_pp, ID **); \
96         if (!((_data)->status & IDWALK_STOP)) { \
97                 const int _flag = (_data)->flag; \
98                 ID *old_id = *(id_pp); \
99                 const int callback_return = (_data)->callback((_data)->user_data, (_data)->self_id, id_pp, _cb_flag | (_data)->cb_flag); \
100                 if (_flag & IDWALK_READONLY) { \
101                         BLI_assert(*(id_pp) == old_id); \
102                 } \
103                 if (old_id && (_flag & IDWALK_RECURSE)) { \
104                         if (BLI_gset_add((_data)->ids_handled, old_id)) { \
105                                 if (!(callback_return & IDWALK_RET_STOP_RECURSION)) { \
106                                         BLI_LINKSTACK_PUSH((_data)->ids_todo, old_id); \
107                                 } \
108                         } \
109                 } \
110                 if (callback_return & IDWALK_RET_STOP_ITER) { \
111                         (_data)->status |= IDWALK_STOP; \
112                         goto FOREACH_FINALIZE; \
113                 } \
114         } \
115         else { \
116                 goto FOREACH_FINALIZE; \
117         } ((void)0)
118
119 #define FOREACH_CALLBACK_INVOKE_ID(_data, id, cb_flag) \
120         { \
121                 CHECK_TYPE_ANY(id, ID *, void *); \
122                 FOREACH_CALLBACK_INVOKE_ID_PP(_data, (ID **)&(id), cb_flag); \
123         } ((void)0)
124
125 #define FOREACH_CALLBACK_INVOKE(_data, id_super, cb_flag) \
126         { \
127                 CHECK_TYPE(&((id_super)->id), ID *); \
128                 FOREACH_CALLBACK_INVOKE_ID_PP(_data, (ID **)&(id_super), cb_flag); \
129         } ((void)0)
130
131 /* status */
132 enum {
133         IDWALK_STOP     = 1 << 0,
134 };
135
136 typedef struct LibraryForeachIDData {
137         ID *self_id;
138         int flag;
139         int cb_flag;
140         LibraryIDLinkCallback callback;
141         void *user_data;
142         int status;
143
144         /* To handle recursion. */
145         GSet *ids_handled;  /* All IDs that are either already done, or still in ids_todo stack. */
146         BLI_LINKSTACK_DECLARE(ids_todo, ID *);
147 } LibraryForeachIDData;
148
149 static void library_foreach_idproperty_ID_link(LibraryForeachIDData *data, IDProperty *prop, int flag)
150 {
151         if (!prop)
152                 return;
153
154         switch (prop->type) {
155                 case IDP_GROUP:
156                 {
157                         for (IDProperty *loop = prop->data.group.first; loop; loop = loop->next) {
158                                 library_foreach_idproperty_ID_link(data, loop, flag);
159                         }
160                         break;
161                 }
162                 case IDP_IDPARRAY:
163                 {
164                         IDProperty *loop = IDP_Array(prop);
165                         for (int i = 0; i < prop->len; i++) {
166                                 library_foreach_idproperty_ID_link(data, &loop[i], flag);
167                         }
168                         break;
169                 }
170                 case IDP_ID:
171                         FOREACH_CALLBACK_INVOKE_ID(data, prop->data.pointer, flag);
172                         break;
173                 default:
174                         break;  /* Nothing to do here with other types of IDProperties... */
175         }
176
177         FOREACH_FINALIZE_VOID;
178 }
179
180 static void library_foreach_rigidbodyworldSceneLooper(
181         struct RigidBodyWorld *UNUSED(rbw), ID **id_pointer, void *user_data, int cb_flag)
182 {
183         LibraryForeachIDData *data = (LibraryForeachIDData *) user_data;
184         FOREACH_CALLBACK_INVOKE_ID_PP(data, id_pointer, cb_flag);
185
186         FOREACH_FINALIZE_VOID;
187 }
188
189 static void library_foreach_modifiersForeachIDLink(
190         void *user_data, Object *UNUSED(object), ID **id_pointer, int cb_flag)
191 {
192         LibraryForeachIDData *data = (LibraryForeachIDData *) user_data;
193         FOREACH_CALLBACK_INVOKE_ID_PP(data, id_pointer, cb_flag);
194
195         FOREACH_FINALIZE_VOID;
196 }
197
198 static void library_foreach_gpencil_modifiersForeachIDLink(
199         void *user_data, Object *UNUSED(object), ID **id_pointer, int cb_flag)
200 {
201         LibraryForeachIDData *data = (LibraryForeachIDData *) user_data;
202         FOREACH_CALLBACK_INVOKE_ID_PP(data, id_pointer, cb_flag);
203
204         FOREACH_FINALIZE_VOID;
205 }
206
207 static void library_foreach_constraintObjectLooper(bConstraint *UNUSED(con), ID **id_pointer,
208                                                    bool is_reference, void *user_data)
209 {
210         LibraryForeachIDData *data = (LibraryForeachIDData *) user_data;
211         const int cb_flag = is_reference ? IDWALK_CB_USER : IDWALK_CB_NOP;
212         FOREACH_CALLBACK_INVOKE_ID_PP(data, id_pointer, cb_flag);
213
214         FOREACH_FINALIZE_VOID;
215 }
216
217 static void library_foreach_particlesystemsObjectLooper(
218         ParticleSystem *UNUSED(psys), ID **id_pointer, void *user_data, int cb_flag)
219 {
220         LibraryForeachIDData *data = (LibraryForeachIDData *) user_data;
221         FOREACH_CALLBACK_INVOKE_ID_PP(data, id_pointer, cb_flag);
222
223         FOREACH_FINALIZE_VOID;
224 }
225
226 static void library_foreach_nla_strip(LibraryForeachIDData *data, NlaStrip *strip)
227 {
228         NlaStrip *substrip;
229
230         FOREACH_CALLBACK_INVOKE(data, strip->act, IDWALK_CB_USER);
231
232         for (substrip = strip->strips.first; substrip; substrip = substrip->next) {
233                 library_foreach_nla_strip(data, substrip);
234         }
235
236         FOREACH_FINALIZE_VOID;
237 }
238
239 static void library_foreach_animationData(LibraryForeachIDData *data, AnimData *adt)
240 {
241         FCurve *fcu;
242         NlaTrack *nla_track;
243         NlaStrip *nla_strip;
244
245         for (fcu = adt->drivers.first; fcu; fcu = fcu->next) {
246                 ChannelDriver *driver = fcu->driver;
247                 DriverVar *dvar;
248
249                 for (dvar = driver->variables.first; dvar; dvar = dvar->next) {
250                         /* only used targets */
251                         DRIVER_TARGETS_USED_LOOPER_BEGIN(dvar)
252                         {
253                                 FOREACH_CALLBACK_INVOKE_ID(data, dtar->id, IDWALK_CB_NOP);
254                         }
255                         DRIVER_TARGETS_LOOPER_END;
256                 }
257         }
258
259         FOREACH_CALLBACK_INVOKE(data, adt->action, IDWALK_CB_USER);
260         FOREACH_CALLBACK_INVOKE(data, adt->tmpact, IDWALK_CB_USER);
261
262         for (nla_track = adt->nla_tracks.first; nla_track; nla_track = nla_track->next) {
263                 for (nla_strip = nla_track->strips.first; nla_strip; nla_strip = nla_strip->next) {
264                         library_foreach_nla_strip(data, nla_strip);
265                 }
266         }
267
268         FOREACH_FINALIZE_VOID;
269 }
270
271 static void library_foreach_mtex(LibraryForeachIDData *data, MTex *mtex)
272 {
273         FOREACH_CALLBACK_INVOKE(data, mtex->object, IDWALK_CB_NOP);
274         FOREACH_CALLBACK_INVOKE(data, mtex->tex, IDWALK_CB_USER);
275
276         FOREACH_FINALIZE_VOID;
277 }
278
279 static void library_foreach_paint(LibraryForeachIDData *data, Paint *paint)
280 {
281         FOREACH_CALLBACK_INVOKE(data, paint->brush, IDWALK_CB_USER);
282         for (int i = 0; i < paint->tool_slots_len; i++) {
283                 FOREACH_CALLBACK_INVOKE(data, paint->tool_slots[i].brush, IDWALK_CB_USER);
284         }
285         FOREACH_CALLBACK_INVOKE(data, paint->palette, IDWALK_CB_USER);
286
287         FOREACH_FINALIZE_VOID;
288 }
289
290 static void library_foreach_bone(LibraryForeachIDData *data, Bone *bone)
291 {
292         library_foreach_idproperty_ID_link(data, bone->prop, IDWALK_CB_USER);
293
294         for (Bone *curbone = bone->childbase.first; curbone; curbone = curbone->next) {
295                 library_foreach_bone(data, curbone);
296         }
297
298         FOREACH_FINALIZE_VOID;
299 }
300
301 static void library_foreach_layer_collection(LibraryForeachIDData *data, ListBase *lb)
302 {
303         for (LayerCollection *lc = lb->first; lc; lc = lc->next) {
304                 FOREACH_CALLBACK_INVOKE(data, lc->collection, IDWALK_CB_NOP);
305                 library_foreach_layer_collection(data, &lc->layer_collections);
306         }
307
308         FOREACH_FINALIZE_VOID;
309 }
310
311 static void library_foreach_ID_as_subdata_link(
312         ID **id_pp, LibraryIDLinkCallback callback, void *user_data, int flag, LibraryForeachIDData *data)
313 {
314         /* Needed e.g. for callbacks handling relationships... This call shall be absolutely readonly. */
315         ID *id = *id_pp;
316         FOREACH_CALLBACK_INVOKE_ID_PP(data, id_pp, IDWALK_CB_PRIVATE);
317         BLI_assert(id == *id_pp);
318
319         if (flag & IDWALK_RECURSE) {
320                 /* Defer handling into main loop, recursively calling BKE_library_foreach_ID_link in IDWALK_RECURSE case is
321                  * troublesome, see T49553. */
322                 if (BLI_gset_add(data->ids_handled, id)) {
323                         BLI_LINKSTACK_PUSH(data->ids_todo, id);
324                 }
325         }
326         else {
327                 BKE_library_foreach_ID_link(NULL, id, callback, user_data, flag);
328         }
329
330         FOREACH_FINALIZE_VOID;
331 }
332
333 /**
334  * Loop over all of the ID's this datablock links to.
335  *
336  * \note: May be extended to be recursive in the future.
337  */
338 void BKE_library_foreach_ID_link(Main *bmain, ID *id, LibraryIDLinkCallback callback, void *user_data, int flag)
339 {
340         LibraryForeachIDData data;
341         int i;
342
343         if (flag & IDWALK_RECURSE) {
344                 /* For now, recusion implies read-only. */
345                 flag |= IDWALK_READONLY;
346
347                 data.ids_handled = BLI_gset_new(BLI_ghashutil_ptrhash, BLI_ghashutil_ptrcmp, __func__);
348                 BLI_LINKSTACK_INIT(data.ids_todo);
349
350                 BLI_gset_add(data.ids_handled, id);
351         }
352         else {
353                 data.ids_handled = NULL;
354         }
355         data.flag = flag;
356         data.status = 0;
357         data.callback = callback;
358         data.user_data = user_data;
359
360 #define CALLBACK_INVOKE_ID(check_id, cb_flag) \
361         FOREACH_CALLBACK_INVOKE_ID(&data, check_id, cb_flag)
362
363 #define CALLBACK_INVOKE(check_id_super, cb_flag) \
364         FOREACH_CALLBACK_INVOKE(&data, check_id_super, cb_flag)
365
366         for (; id != NULL; id = (flag & IDWALK_RECURSE) ? BLI_LINKSTACK_POP(data.ids_todo) : NULL) {
367                 data.self_id = id;
368                 data.cb_flag = ID_IS_LINKED(id) ? IDWALK_CB_INDIRECT_USAGE : 0;
369
370                 if (bmain != NULL && bmain->relations != NULL && (flag & IDWALK_READONLY)) {
371                         /* Note that this is minor optimization, even in worst cases (like id being an object with lots of
372                          * drivers and constraints and modifiers, or material etc. with huge node tree),
373                          * but we might as well use it (Main->relations is always assumed valid, it's responsibility of code
374                          * creating it to free it, especially if/when it starts modifying Main database). */
375                         MainIDRelationsEntry *entry = BLI_ghash_lookup(bmain->relations->id_user_to_used, id);
376                         for (; entry != NULL; entry = entry->next) {
377                                 FOREACH_CALLBACK_INVOKE_ID_PP(&data, entry->id_pointer, entry->usage_flag);
378                         }
379                         continue;
380                 }
381
382                 if (id->override_static != NULL) {
383                         CALLBACK_INVOKE_ID(id->override_static->reference, IDWALK_CB_USER | IDWALK_CB_STATIC_OVERRIDE_REFERENCE);
384                         CALLBACK_INVOKE_ID(id->override_static->storage, IDWALK_CB_USER | IDWALK_CB_STATIC_OVERRIDE_REFERENCE);
385                 }
386
387                 library_foreach_idproperty_ID_link(&data, id->properties, IDWALK_CB_USER);
388
389                 AnimData *adt = BKE_animdata_from_id(id);
390                 if (adt) {
391                         library_foreach_animationData(&data, adt);
392                 }
393
394                 switch ((ID_Type)GS(id->name)) {
395                         case ID_LI:
396                         {
397                                 Library *lib = (Library *) id;
398                                 CALLBACK_INVOKE(lib->parent, IDWALK_CB_NOP);
399                                 break;
400                         }
401                         case ID_SCE:
402                         {
403                                 Scene *scene = (Scene *) id;
404                                 ToolSettings *toolsett = scene->toolsettings;
405
406                                 CALLBACK_INVOKE(scene->camera, IDWALK_CB_NOP);
407                                 CALLBACK_INVOKE(scene->world, IDWALK_CB_USER);
408                                 CALLBACK_INVOKE(scene->set, IDWALK_CB_NOP);
409                                 CALLBACK_INVOKE(scene->clip, IDWALK_CB_USER);
410                                 CALLBACK_INVOKE(scene->r.bake.cage_object, IDWALK_CB_NOP);
411                                 if (scene->nodetree) {
412                                         /* nodetree **are owned by IDs**, treat them as mere sub-data and not real ID! */
413                                         library_foreach_ID_as_subdata_link((ID **)&scene->nodetree, callback, user_data, flag, &data);
414                                 }
415                                 if (scene->ed) {
416                                         Sequence *seq;
417                                         SEQP_BEGIN(scene->ed, seq)
418                                         {
419                                                 CALLBACK_INVOKE(seq->scene, IDWALK_CB_NOP);
420                                                 CALLBACK_INVOKE(seq->scene_camera, IDWALK_CB_NOP);
421                                                 CALLBACK_INVOKE(seq->clip, IDWALK_CB_USER);
422                                                 CALLBACK_INVOKE(seq->mask, IDWALK_CB_USER);
423                                                 CALLBACK_INVOKE(seq->sound, IDWALK_CB_USER);
424                                                 library_foreach_idproperty_ID_link(&data, seq->prop, IDWALK_CB_USER);
425                                                 for (SequenceModifierData *smd = seq->modifiers.first; smd; smd = smd->next) {
426                                                         CALLBACK_INVOKE(smd->mask_id, IDWALK_CB_USER);
427                                                 }
428
429                                                 if (seq->type == SEQ_TYPE_TEXT && seq->effectdata) {
430                                                         TextVars *text_data = seq->effectdata;
431                                                         CALLBACK_INVOKE(text_data->text_font, IDWALK_CB_USER);
432                                                 }
433                                         } SEQ_END;
434                                 }
435
436
437                                 for (CollectionObject *cob = scene->master_collection->gobject.first; cob; cob = cob->next) {
438                                         CALLBACK_INVOKE(cob->ob, IDWALK_CB_USER);
439                                 }
440                                 for (CollectionChild *child = scene->master_collection->children.first; child; child = child->next) {
441                                         CALLBACK_INVOKE(child->collection, IDWALK_CB_USER);
442                                 }
443
444                                 ViewLayer *view_layer;
445                                 for (view_layer = scene->view_layers.first; view_layer; view_layer = view_layer->next) {
446                                         CALLBACK_INVOKE(view_layer->mat_override, IDWALK_CB_USER);
447
448                                         for (Base *base = view_layer->object_bases.first; base; base = base->next) {
449                                                 CALLBACK_INVOKE(base->object, IDWALK_CB_NOP);
450                                         }
451
452                                         library_foreach_layer_collection(&data, &view_layer->layer_collections);
453
454                                         for (FreestyleModuleConfig  *fmc = view_layer->freestyle_config.modules.first; fmc; fmc = fmc->next) {
455                                                 if (fmc->script) {
456                                                         CALLBACK_INVOKE(fmc->script, IDWALK_CB_NOP);
457                                                 }
458                                         }
459
460                                         for (FreestyleLineSet *fls = view_layer->freestyle_config.linesets.first; fls; fls = fls->next) {
461                                                 if (fls->group) {
462                                                         CALLBACK_INVOKE(fls->group, IDWALK_CB_USER);
463                                                 }
464
465                                                 if (fls->linestyle) {
466                                                         CALLBACK_INVOKE(fls->linestyle, IDWALK_CB_USER);
467                                                 }
468                                         }
469                                 }
470
471                                 for (TimeMarker *marker = scene->markers.first; marker; marker = marker->next) {
472                                         CALLBACK_INVOKE(marker->camera, IDWALK_CB_NOP);
473                                 }
474                                 
475                                 if (toolsett) {
476                                         CALLBACK_INVOKE(toolsett->particle.scene, IDWALK_CB_NOP);
477                                         CALLBACK_INVOKE(toolsett->particle.object, IDWALK_CB_NOP);
478                                         CALLBACK_INVOKE(toolsett->particle.shape_object, IDWALK_CB_NOP);
479
480                                         library_foreach_paint(&data, &toolsett->imapaint.paint);
481                                         CALLBACK_INVOKE(toolsett->imapaint.stencil, IDWALK_CB_USER);
482                                         CALLBACK_INVOKE(toolsett->imapaint.clone, IDWALK_CB_USER);
483                                         CALLBACK_INVOKE(toolsett->imapaint.canvas, IDWALK_CB_USER);
484
485                                         if (toolsett->vpaint) {
486                                                 library_foreach_paint(&data, &toolsett->vpaint->paint);
487                                         }
488                                         if (toolsett->wpaint) {
489                                                 library_foreach_paint(&data, &toolsett->wpaint->paint);
490                                         }
491                                         if (toolsett->sculpt) {
492                                                 library_foreach_paint(&data, &toolsett->sculpt->paint);
493                                                 CALLBACK_INVOKE(toolsett->sculpt->gravity_object, IDWALK_CB_NOP);
494                                         }
495                                         if (toolsett->uvsculpt) {
496                                                 library_foreach_paint(&data, &toolsett->uvsculpt->paint);
497                                         }
498                                         if (toolsett->gp_paint) {
499                                                 library_foreach_paint(&data, &toolsett->gp_paint->paint);
500                                         }
501
502                                         CALLBACK_INVOKE(toolsett->gp_sculpt.guide.reference_object, IDWALK_CB_NOP);
503
504                                 }
505
506                                 if (scene->rigidbody_world) {
507                                         BKE_rigidbody_world_id_loop(scene->rigidbody_world, library_foreach_rigidbodyworldSceneLooper, &data);
508                                 }
509
510                                 break;
511                         }
512
513                         case ID_OB:
514                         {
515                                 Object *object = (Object *) id;
516                                 ParticleSystem *psys;
517
518                                 /* Object is special, proxies make things hard... */
519                                 const int data_cb_flag = data.cb_flag;
520                                 const int proxy_cb_flag = ((data.flag & IDWALK_NO_INDIRECT_PROXY_DATA_USAGE) == 0 && (object->proxy || object->proxy_group)) ?
521                                                               IDWALK_CB_INDIRECT_USAGE : 0;
522
523                                 /* object data special case */
524                                 data.cb_flag |= proxy_cb_flag;
525                                 if (object->type == OB_EMPTY) {
526                                         /* empty can have NULL or Image */
527                                         CALLBACK_INVOKE_ID(object->data, IDWALK_CB_USER);
528                                 }
529                                 else {
530                                         /* when set, this can't be NULL */
531                                         if (object->data) {
532                                                 CALLBACK_INVOKE_ID(object->data, IDWALK_CB_USER | IDWALK_CB_NEVER_NULL);
533                                         }
534                                 }
535                                 data.cb_flag = data_cb_flag;
536
537                                 CALLBACK_INVOKE(object->parent, IDWALK_CB_NOP);
538                                 CALLBACK_INVOKE(object->track, IDWALK_CB_NOP);
539                                 /* object->proxy is refcounted, but not object->proxy_group... *sigh* */
540                                 CALLBACK_INVOKE(object->proxy, IDWALK_CB_USER);
541                                 CALLBACK_INVOKE(object->proxy_group, IDWALK_CB_NOP);
542
543                                 /* Special case!
544                                  * Since this field is set/owned by 'user' of this ID (and not ID itself), it is only indirect usage
545                                  * if proxy object is linked... Twisted. */
546                                 if (object->proxy_from) {
547                                         data.cb_flag = ID_IS_LINKED(object->proxy_from) ? IDWALK_CB_INDIRECT_USAGE : 0;
548                                 }
549                                 CALLBACK_INVOKE(object->proxy_from, IDWALK_CB_LOOPBACK);
550                                 data.cb_flag = data_cb_flag;
551
552                                 CALLBACK_INVOKE(object->poselib, IDWALK_CB_USER);
553
554                                 data.cb_flag |= proxy_cb_flag;
555                                 for (i = 0; i < object->totcol; i++) {
556                                         CALLBACK_INVOKE(object->mat[i], IDWALK_CB_USER);
557                                 }
558                                 data.cb_flag = data_cb_flag;
559
560                                 CALLBACK_INVOKE(object->gpd, IDWALK_CB_USER);
561                                 CALLBACK_INVOKE(object->dup_group, IDWALK_CB_USER);
562
563                                 if (object->pd) {
564                                         CALLBACK_INVOKE(object->pd->tex, IDWALK_CB_USER);
565                                         CALLBACK_INVOKE(object->pd->f_source, IDWALK_CB_NOP);
566                                 }
567                                 /* Note that ob->effect is deprecated, so no need to handle it here. */
568
569                                 if (object->pose) {
570                                         bPoseChannel *pchan;
571
572                                         data.cb_flag |= proxy_cb_flag;
573                                         for (pchan = object->pose->chanbase.first; pchan; pchan = pchan->next) {
574                                                 library_foreach_idproperty_ID_link(&data, pchan->prop, IDWALK_CB_USER);
575                                                 CALLBACK_INVOKE(pchan->custom, IDWALK_CB_USER);
576                                                 BKE_constraints_id_loop(&pchan->constraints, library_foreach_constraintObjectLooper, &data);
577                                         }
578                                         data.cb_flag = data_cb_flag;
579                                 }
580
581                                 if (object->rigidbody_constraint) {
582                                         CALLBACK_INVOKE(object->rigidbody_constraint->ob1, IDWALK_CB_NOP);
583                                         CALLBACK_INVOKE(object->rigidbody_constraint->ob2, IDWALK_CB_NOP);
584                                 }
585
586                                 if (object->lodlevels.first) {
587                                         LodLevel *level;
588                                         for (level = object->lodlevels.first; level; level = level->next) {
589                                                 CALLBACK_INVOKE(level->source, IDWALK_CB_NOP);
590                                         }
591                                 }
592
593                                 modifiers_foreachIDLink(object, library_foreach_modifiersForeachIDLink, &data);
594                                 BKE_gpencil_modifiers_foreachIDLink(object, library_foreach_gpencil_modifiersForeachIDLink, &data);
595                                 BKE_constraints_id_loop(&object->constraints, library_foreach_constraintObjectLooper, &data);
596
597                                 for (psys = object->particlesystem.first; psys; psys = psys->next) {
598                                         BKE_particlesystem_id_loop(psys, library_foreach_particlesystemsObjectLooper, &data);
599                                 }
600
601                                 if (object->soft) {
602                                         CALLBACK_INVOKE(object->soft->collision_group, IDWALK_CB_NOP);
603
604                                         if (object->soft->effector_weights) {
605                                                 CALLBACK_INVOKE(object->soft->effector_weights->group, IDWALK_CB_NOP);
606                                         }
607                                 }
608                                 break;
609                         }
610
611                         case ID_AR:
612                         {
613                                 bArmature *arm = (bArmature *)id;
614
615                                 for (Bone *bone = arm->bonebase.first; bone; bone = bone->next) {
616                                         library_foreach_bone(&data, bone);
617                                 }
618                                 break;
619                         }
620
621                         case ID_ME:
622                         {
623                                 Mesh *mesh = (Mesh *) id;
624                                 CALLBACK_INVOKE(mesh->texcomesh, IDWALK_CB_USER);
625                                 CALLBACK_INVOKE(mesh->key, IDWALK_CB_USER);
626                                 for (i = 0; i < mesh->totcol; i++) {
627                                         CALLBACK_INVOKE(mesh->mat[i], IDWALK_CB_USER);
628                                 }
629                                 break;
630                         }
631
632                         case ID_CU:
633                         {
634                                 Curve *curve = (Curve *) id;
635                                 CALLBACK_INVOKE(curve->bevobj, IDWALK_CB_NOP);
636                                 CALLBACK_INVOKE(curve->taperobj, IDWALK_CB_NOP);
637                                 CALLBACK_INVOKE(curve->textoncurve, IDWALK_CB_NOP);
638                                 CALLBACK_INVOKE(curve->key, IDWALK_CB_USER);
639                                 for (i = 0; i < curve->totcol; i++) {
640                                         CALLBACK_INVOKE(curve->mat[i], IDWALK_CB_USER);
641                                 }
642                                 CALLBACK_INVOKE(curve->vfont, IDWALK_CB_USER);
643                                 CALLBACK_INVOKE(curve->vfontb, IDWALK_CB_USER);
644                                 CALLBACK_INVOKE(curve->vfonti, IDWALK_CB_USER);
645                                 CALLBACK_INVOKE(curve->vfontbi, IDWALK_CB_USER);
646                                 break;
647                         }
648
649                         case ID_MB:
650                         {
651                                 MetaBall *metaball = (MetaBall *) id;
652                                 for (i = 0; i < metaball->totcol; i++) {
653                                         CALLBACK_INVOKE(metaball->mat[i], IDWALK_CB_USER);
654                                 }
655                                 break;
656                         }
657
658                         case ID_MA:
659                         {
660                                 Material *material = (Material *) id;
661                                 if (material->nodetree) {
662                                         /* nodetree **are owned by IDs**, treat them as mere sub-data and not real ID! */
663                                         library_foreach_ID_as_subdata_link((ID **)&material->nodetree, callback, user_data, flag, &data);
664                                 }
665                                 if (material->texpaintslot != NULL) {
666                                         CALLBACK_INVOKE(material->texpaintslot->ima, IDWALK_CB_NOP);
667                                 }
668                                 if (material->gp_style != NULL) {
669                                         CALLBACK_INVOKE(material->gp_style->sima, IDWALK_CB_USER);
670                                         CALLBACK_INVOKE(material->gp_style->ima, IDWALK_CB_USER);
671                                 }
672                                 break;
673                         }
674
675                         case ID_TE:
676                         {
677                                 Tex *texture = (Tex *) id;
678                                 if (texture->nodetree) {
679                                         /* nodetree **are owned by IDs**, treat them as mere sub-data and not real ID! */
680                                         library_foreach_ID_as_subdata_link((ID **)&texture->nodetree, callback, user_data, flag, &data);
681                                 }
682                                 CALLBACK_INVOKE(texture->ima, IDWALK_CB_USER);
683                                 break;
684                         }
685
686                         case ID_LT:
687                         {
688                                 Lattice *lattice = (Lattice *) id;
689                                 CALLBACK_INVOKE(lattice->key, IDWALK_CB_USER);
690                                 break;
691                         }
692
693                         case ID_LA:
694                         {
695                                 Lamp *lamp = (Lamp *) id;
696                                 if (lamp->nodetree) {
697                                         /* nodetree **are owned by IDs**, treat them as mere sub-data and not real ID! */
698                                         library_foreach_ID_as_subdata_link((ID **)&lamp->nodetree, callback, user_data, flag, &data);
699                                 }
700                                 break;
701                         }
702
703                         case ID_CA:
704                         {
705                                 Camera *camera = (Camera *) id;
706                                 CALLBACK_INVOKE(camera->dof_ob, IDWALK_CB_NOP);
707                                 for (CameraBGImage *bgpic = camera->bg_images.first; bgpic; bgpic = bgpic->next) {
708                                         if (bgpic->source == CAM_BGIMG_SOURCE_IMAGE) {
709                                                 CALLBACK_INVOKE(bgpic->ima, IDWALK_CB_USER);
710                                         }
711                                         else if (bgpic->source == CAM_BGIMG_SOURCE_MOVIE) {
712                                                 CALLBACK_INVOKE(bgpic->clip, IDWALK_CB_USER);
713                                         }
714                                 }
715
716                                 break;
717                         }
718
719                         case ID_KE:
720                         {
721                                 Key *key = (Key *) id;
722                                 CALLBACK_INVOKE_ID(key->from, IDWALK_CB_LOOPBACK);
723                                 break;
724                         }
725
726                         case ID_WO:
727                         {
728                                 World *world = (World *) id;
729                                 if (world->nodetree) {
730                                         /* nodetree **are owned by IDs**, treat them as mere sub-data and not real ID! */
731                                         library_foreach_ID_as_subdata_link((ID **)&world->nodetree, callback, user_data, flag, &data);
732                                 }
733                                 break;
734                         }
735
736                         case ID_SPK:
737                         {
738                                 Speaker *speaker = (Speaker *) id;
739                                 CALLBACK_INVOKE(speaker->sound, IDWALK_CB_USER);
740                                 break;
741                         }
742
743                         case ID_LP:
744                         {
745                                 LightProbe *probe = (LightProbe *) id;
746                                 CALLBACK_INVOKE(probe->image, IDWALK_CB_USER);
747                                 CALLBACK_INVOKE(probe->visibility_grp, IDWALK_CB_NOP);
748                                 break;
749                         }
750
751                         case ID_GR:
752                         {
753                                 Collection *collection = (Collection *) id;
754                                 for (CollectionObject *cob = collection->gobject.first; cob; cob = cob->next) {
755                                         CALLBACK_INVOKE(cob->ob, IDWALK_CB_USER);
756                                 }
757                                 for (CollectionChild *child = collection->children.first; child; child = child->next) {
758                                         CALLBACK_INVOKE(child->collection, IDWALK_CB_USER);
759                                 }
760                                 for (CollectionParent *parent = collection->parents.first; parent; parent = parent->next) {
761                                         CALLBACK_INVOKE(parent->collection, IDWALK_CB_NOP);
762                                 }
763                                 break;
764                         }
765
766                         case ID_NT:
767                         {
768                                 bNodeTree *ntree = (bNodeTree *) id;
769                                 bNode *node;
770                                 bNodeSocket *sock;
771
772                                 CALLBACK_INVOKE(ntree->gpd, IDWALK_CB_USER);
773
774                                 for (node = ntree->nodes.first; node; node = node->next) {
775                                         CALLBACK_INVOKE_ID(node->id, IDWALK_CB_USER);
776
777                                         library_foreach_idproperty_ID_link(&data, node->prop, IDWALK_CB_USER);
778                                         for (sock = node->inputs.first; sock; sock = sock->next) {
779                                                 library_foreach_idproperty_ID_link(&data, sock->prop, IDWALK_CB_USER);
780                                         }
781                                         for (sock = node->outputs.first; sock; sock = sock->next) {
782                                                 library_foreach_idproperty_ID_link(&data, sock->prop, IDWALK_CB_USER);
783                                         }
784                                 }
785
786                                 for (sock = ntree->inputs.first; sock; sock = sock->next) {
787                                         library_foreach_idproperty_ID_link(&data, sock->prop, IDWALK_CB_USER);
788                                 }
789                                 for (sock = ntree->outputs.first; sock; sock = sock->next) {
790                                         library_foreach_idproperty_ID_link(&data, sock->prop, IDWALK_CB_USER);
791                                 }
792                                 break;
793                         }
794
795                         case ID_BR:
796                         {
797                                 Brush *brush = (Brush *) id;
798                                 CALLBACK_INVOKE(brush->toggle_brush, IDWALK_CB_NOP);
799                                 CALLBACK_INVOKE(brush->clone.image, IDWALK_CB_NOP);
800                                 CALLBACK_INVOKE(brush->paint_curve, IDWALK_CB_USER);
801                                 if (brush->gpencil_settings) {
802                                         CALLBACK_INVOKE(brush->gpencil_settings->material, IDWALK_CB_USER);
803                                 }
804                                 library_foreach_mtex(&data, &brush->mtex);
805                                 library_foreach_mtex(&data, &brush->mask_mtex);
806                                 break;
807                         }
808
809                         case ID_PA:
810                         {
811                                 ParticleSettings *psett = (ParticleSettings *) id;
812                                 CALLBACK_INVOKE(psett->dup_group, IDWALK_CB_NOP);
813                                 CALLBACK_INVOKE(psett->dup_ob, IDWALK_CB_NOP);
814                                 CALLBACK_INVOKE(psett->bb_ob, IDWALK_CB_NOP);
815                                 CALLBACK_INVOKE(psett->collision_group, IDWALK_CB_NOP);
816
817                                 for (i = 0; i < MAX_MTEX; i++) {
818                                         if (psett->mtex[i]) {
819                                                 library_foreach_mtex(&data, psett->mtex[i]);
820                                         }
821                                 }
822
823                                 if (psett->effector_weights) {
824                                         CALLBACK_INVOKE(psett->effector_weights->group, IDWALK_CB_NOP);
825                                 }
826
827                                 if (psett->pd) {
828                                         CALLBACK_INVOKE(psett->pd->tex, IDWALK_CB_USER);
829                                         CALLBACK_INVOKE(psett->pd->f_source, IDWALK_CB_NOP);
830                                 }
831                                 if (psett->pd2) {
832                                         CALLBACK_INVOKE(psett->pd2->tex, IDWALK_CB_USER);
833                                         CALLBACK_INVOKE(psett->pd2->f_source, IDWALK_CB_NOP);
834                                 }
835
836                                 if (psett->boids) {
837                                         BoidState *state;
838                                         BoidRule *rule;
839
840                                         for (state = psett->boids->states.first; state; state = state->next) {
841                                                 for (rule = state->rules.first; rule; rule = rule->next) {
842                                                         if (rule->type == eBoidRuleType_Avoid) {
843                                                                 BoidRuleGoalAvoid *gabr = (BoidRuleGoalAvoid *)rule;
844                                                                 CALLBACK_INVOKE(gabr->ob, IDWALK_CB_NOP);
845                                                         }
846                                                         else if (rule->type == eBoidRuleType_FollowLeader) {
847                                                                 BoidRuleFollowLeader *flbr = (BoidRuleFollowLeader *)rule;
848                                                                 CALLBACK_INVOKE(flbr->ob, IDWALK_CB_NOP);
849                                                         }
850                                                 }
851                                         }
852                                 }
853
854                                 for (ParticleDupliWeight *dw = psett->dupliweights.first; dw; dw = dw->next) {
855                                         CALLBACK_INVOKE(dw->ob, IDWALK_CB_NOP);
856                                 }
857                                 break;
858                         }
859
860                         case ID_MC:
861                         {
862                                 MovieClip *clip = (MovieClip *) id;
863                                 MovieTracking *tracking = &clip->tracking;
864                                 MovieTrackingObject *object;
865                                 MovieTrackingTrack *track;
866                                 MovieTrackingPlaneTrack *plane_track;
867
868                                 CALLBACK_INVOKE(clip->gpd, IDWALK_CB_USER);
869
870                                 for (track = tracking->tracks.first; track; track = track->next) {
871                                         CALLBACK_INVOKE(track->gpd, IDWALK_CB_USER);
872                                 }
873                                 for (object = tracking->objects.first; object; object = object->next) {
874                                         for (track = object->tracks.first; track; track = track->next) {
875                                                 CALLBACK_INVOKE(track->gpd, IDWALK_CB_USER);
876                                         }
877                                 }
878
879                                 for (plane_track = tracking->plane_tracks.first; plane_track; plane_track = plane_track->next) {
880                                         CALLBACK_INVOKE(plane_track->image, IDWALK_CB_USER);
881                                 }
882                                 break;
883                         }
884
885                         case ID_MSK:
886                         {
887                                 Mask *mask = (Mask *) id;
888                                 MaskLayer *mask_layer;
889                                 for (mask_layer = mask->masklayers.first; mask_layer; mask_layer = mask_layer->next) {
890                                         MaskSpline *mask_spline;
891
892                                         for (mask_spline = mask_layer->splines.first; mask_spline; mask_spline = mask_spline->next) {
893                                                 for (i = 0; i < mask_spline->tot_point; i++) {
894                                                         MaskSplinePoint *point = &mask_spline->points[i];
895                                                         CALLBACK_INVOKE_ID(point->parent.id, IDWALK_CB_USER);
896                                                 }
897                                         }
898                                 }
899                                 break;
900                         }
901
902                         case ID_LS:
903                         {
904                                 FreestyleLineStyle *linestyle = (FreestyleLineStyle *) id;
905                                 LineStyleModifier *lsm;
906                                 for (i = 0; i < MAX_MTEX; i++) {
907                                         if (linestyle->mtex[i]) {
908                                                 library_foreach_mtex(&data, linestyle->mtex[i]);
909                                         }
910                                 }
911                                 if (linestyle->nodetree) {
912                                         /* nodetree **are owned by IDs**, treat them as mere sub-data and not real ID! */
913                                         library_foreach_ID_as_subdata_link((ID **)&linestyle->nodetree, callback, user_data, flag, &data);
914                                 }
915
916                                 for (lsm = linestyle->color_modifiers.first; lsm; lsm = lsm->next) {
917                                         if (lsm->type == LS_MODIFIER_DISTANCE_FROM_OBJECT) {
918                                                 LineStyleColorModifier_DistanceFromObject *p = (LineStyleColorModifier_DistanceFromObject *)lsm;
919                                                 if (p->target) {
920                                                         CALLBACK_INVOKE(p->target, IDWALK_CB_NOP);
921                                                 }
922                                         }
923                                 }
924                                 for (lsm = linestyle->alpha_modifiers.first; lsm; lsm = lsm->next) {
925                                         if (lsm->type == LS_MODIFIER_DISTANCE_FROM_OBJECT) {
926                                                 LineStyleAlphaModifier_DistanceFromObject *p = (LineStyleAlphaModifier_DistanceFromObject *)lsm;
927                                                 if (p->target) {
928                                                         CALLBACK_INVOKE(p->target, IDWALK_CB_NOP);
929                                                 }
930                                         }
931                                 }
932                                 for (lsm = linestyle->thickness_modifiers.first; lsm; lsm = lsm->next) {
933                                         if (lsm->type == LS_MODIFIER_DISTANCE_FROM_OBJECT) {
934                                                 LineStyleThicknessModifier_DistanceFromObject *p = (LineStyleThicknessModifier_DistanceFromObject *)lsm;
935                                                 if (p->target) {
936                                                         CALLBACK_INVOKE(p->target, IDWALK_CB_NOP);
937                                                 }
938                                         }
939                                 }
940                                 break;
941                         }
942                         case ID_AC:
943                         {
944                                 bAction *act = (bAction *) id;
945
946                                 for (TimeMarker *marker = act->markers.first; marker; marker = marker->next) {
947                                         CALLBACK_INVOKE(marker->camera, IDWALK_CB_NOP);
948                                 }
949                                 break;
950                         }
951
952                         case ID_WM:
953                         {
954                                 wmWindowManager *wm = (wmWindowManager *)id;
955
956                                 for (wmWindow *win = wm->windows.first; win; win = win->next) {
957                                         ID *workspace = (ID *)BKE_workspace_active_get(win->workspace_hook);
958
959                                         CALLBACK_INVOKE(win->scene, IDWALK_CB_USER_ONE);
960
961                                         CALLBACK_INVOKE_ID(workspace, IDWALK_CB_NOP);
962                                         /* allow callback to set a different workspace */
963                                         BKE_workspace_active_set(win->workspace_hook, (WorkSpace *)workspace);
964                                 }
965                                 break;
966                         }
967
968                         case ID_WS:
969                         {
970                                 WorkSpace *workspace = (WorkSpace *)id;
971                                 ListBase *layouts = BKE_workspace_layouts_get(workspace);
972
973                                 for (WorkSpaceLayout *layout = layouts->first; layout; layout = layout->next) {
974                                         bScreen *screen = BKE_workspace_layout_screen_get(layout);
975
976                                         /* CALLBACK_INVOKE expects an actual pointer, not a variable holding the pointer.
977                                          * However we can't access layout->screen here since we are outside the workspace project. */
978                                         CALLBACK_INVOKE(screen, IDWALK_CB_USER);
979                                         /* allow callback to set a different screen */
980                                         BKE_workspace_layout_screen_set(layout, screen);
981                                 }
982                                 break;
983                         }
984                         case ID_GD:
985                         {
986                                 bGPdata *gpencil = (bGPdata *) id;
987                                 /* materials */
988                                 for (i = 0; i < gpencil->totcol; i++) {
989                                         CALLBACK_INVOKE(gpencil->mat[i], IDWALK_CB_USER);
990                                 }
991
992                                 for (bGPDlayer *gplayer = gpencil->layers.first; gplayer != NULL; gplayer = gplayer->next) {
993                                         CALLBACK_INVOKE(gplayer->parent, IDWALK_CB_NOP);
994                                 }
995
996                                 break;
997                         }
998
999                         /* Nothing needed for those... */
1000                         case ID_SCR:
1001                         case ID_IM:
1002                         case ID_VF:
1003                         case ID_TXT:
1004                         case ID_SO:
1005                         case ID_PAL:
1006                         case ID_PC:
1007                         case ID_CF:
1008                                 break;
1009
1010                         /* Deprecated. */
1011                         case ID_IP:
1012                                 break;
1013
1014                 }
1015         }
1016
1017 FOREACH_FINALIZE:
1018         if (data.ids_handled) {
1019                 BLI_gset_free(data.ids_handled, NULL);
1020                 BLI_LINKSTACK_FREE(data.ids_todo);
1021         }
1022
1023 #undef CALLBACK_INVOKE_ID
1024 #undef CALLBACK_INVOKE
1025 }
1026
1027 #undef FOREACH_CALLBACK_INVOKE_ID
1028 #undef FOREACH_CALLBACK_INVOKE
1029
1030 /**
1031  * re-usable function, use when replacing ID's
1032  */
1033 void BKE_library_update_ID_link_user(ID *id_dst, ID *id_src, const int cb_flag)
1034 {
1035         if (cb_flag & IDWALK_CB_USER) {
1036                 id_us_min(id_src);
1037                 id_us_plus(id_dst);
1038         }
1039         else if (cb_flag & IDWALK_CB_USER_ONE) {
1040                 id_us_ensure_real(id_dst);
1041         }
1042 }
1043
1044 /**
1045  * Say whether given \a id_type_owner can use (in any way) a datablock of \a id_type_used.
1046  *
1047  * This is a 'simplified' abstract version of #BKE_library_foreach_ID_link() above, quite useful to reduce
1048  * useless iterations in some cases.
1049  */
1050 /* XXX This has to be fully rethink, basing check on ID type is not really working anymore (and even worth once
1051  *     IDProps will support ID pointers), we'll have to do some quick checks on IDs themselves... */
1052 bool BKE_library_id_can_use_idtype(ID *id_owner, const short id_type_used)
1053 {
1054         /* any type of ID can be used in custom props. */
1055         if (id_owner->properties) {
1056                 return true;
1057         }
1058
1059         const short id_type_owner = GS(id_owner->name);
1060
1061         /* IDProps of armature bones and nodes, and bNode->id can use virtually any type of ID. */
1062         if (ELEM(id_type_owner, ID_NT, ID_AR)) {
1063                 return true;
1064         }
1065
1066         if (ntreeFromID(id_owner)) {
1067                 return true;
1068         }
1069
1070         if (BKE_animdata_from_id(id_owner)) {
1071                 return true;  /* AnimationData can use virtually any kind of datablocks, through drivers especially. */
1072         }
1073
1074         switch ((ID_Type)id_type_owner) {
1075                 case ID_LI:
1076                         return ELEM(id_type_used, ID_LI);
1077                 case ID_SCE:
1078                         return (ELEM(id_type_used, ID_OB, ID_WO, ID_SCE, ID_MC, ID_MA, ID_GR, ID_TXT,
1079                                                    ID_LS, ID_MSK, ID_SO, ID_GD, ID_BR, ID_PAL, ID_IM, ID_NT));
1080                 case ID_OB:
1081                         /* Could be more specific, but simpler to just always say 'yes' here. */
1082                         return true;
1083                 case ID_ME:
1084                         return ELEM(id_type_used, ID_ME, ID_KE, ID_MA, ID_IM);
1085                 case ID_CU:
1086                         return ELEM(id_type_used, ID_OB, ID_KE, ID_MA, ID_VF);
1087                 case ID_MB:
1088                         return ELEM(id_type_used, ID_MA);
1089                 case ID_MA:
1090                         return (ELEM(id_type_used, ID_TE, ID_GR));
1091                 case ID_TE:
1092                         return (ELEM(id_type_used, ID_IM, ID_OB));
1093                 case ID_LT:
1094                         return ELEM(id_type_used, ID_KE);
1095                 case ID_LA:
1096                         return (ELEM(id_type_used, ID_TE));
1097                 case ID_CA:
1098                         return ELEM(id_type_used, ID_OB);
1099                 case ID_KE:
1100                         return ELEM(id_type_used, ID_ME, ID_CU, ID_LT);  /* Warning! key->from, could be more types in future? */
1101                 case ID_SCR:
1102                         return ELEM(id_type_used, ID_SCE);
1103                 case ID_WO:
1104                         return (ELEM(id_type_used, ID_TE));
1105                 case ID_SPK:
1106                         return ELEM(id_type_used, ID_SO);
1107                 case ID_GR:
1108                         return ELEM(id_type_used, ID_OB, ID_GR);
1109                 case ID_NT:
1110                         /* Could be more specific, but node.id has no type restriction... */
1111                         return true;
1112                 case ID_BR:
1113                         return ELEM(id_type_used, ID_BR, ID_IM, ID_PC, ID_TE, ID_MA);
1114                 case ID_PA:
1115                         return ELEM(id_type_used, ID_OB, ID_GR, ID_TE);
1116                 case ID_MC:
1117                         return ELEM(id_type_used, ID_GD, ID_IM);
1118                 case ID_MSK:
1119                         return ELEM(id_type_used, ID_MC);  /* WARNING! mask->parent.id, not typed. */
1120                 case ID_LS:
1121                         return (ELEM(id_type_used, ID_TE, ID_OB));
1122                 case ID_LP:
1123                         return ELEM(id_type_used, ID_IM);
1124                 case ID_GD:
1125                         return ELEM(id_type_used, ID_MA);
1126                 case ID_WS:
1127                         return ELEM(id_type_used, ID_SCR, ID_SCE);
1128                 case ID_IM:
1129                 case ID_VF:
1130                 case ID_TXT:
1131                 case ID_SO:
1132                 case ID_AR:
1133                 case ID_AC:
1134                 case ID_WM:
1135                 case ID_PAL:
1136                 case ID_PC:
1137                 case ID_CF:
1138                         /* Those types never use/reference other IDs... */
1139                         return false;
1140                 case ID_IP:
1141                         /* Deprecated... */
1142                         return false;
1143         }
1144         return false;
1145 }
1146
1147
1148 /* ***** ID users iterator. ***** */
1149 typedef struct IDUsersIter {
1150         ID *id;
1151
1152         ListBase *lb_array[MAX_LIBARRAY];
1153         int lb_idx;
1154
1155         ID *curr_id;
1156         int count_direct, count_indirect;  /* Set by callback. */
1157 } IDUsersIter;
1158
1159 static int foreach_libblock_id_users_callback(void *user_data, ID *UNUSED(self_id), ID **id_p, int cb_flag)
1160 {
1161         IDUsersIter *iter = user_data;
1162
1163         if (*id_p) {
1164                 /* 'Loopback' ID pointers (the ugly 'from' ones, Object->proxy_from and Key->from).
1165                  * Those are not actually ID usage, we can ignore them here.
1166                  */
1167                 if (cb_flag & IDWALK_CB_LOOPBACK) {
1168                         return IDWALK_RET_NOP;
1169                 }
1170
1171                 if (*id_p == iter->id) {
1172 #if 0
1173                         printf("%s uses %s (refcounted: %d, userone: %d, used_one: %d, used_one_active: %d, indirect_usage: %d)\n",
1174                                    iter->curr_id->name, iter->id->name, (cb_flag & IDWALK_USER) ? 1 : 0, (cb_flag & IDWALK_USER_ONE) ? 1 : 0,
1175                                    (iter->id->tag & LIB_TAG_EXTRAUSER) ? 1 : 0, (iter->id->tag & LIB_TAG_EXTRAUSER_SET) ? 1 : 0,
1176                                    (cb_flag & IDWALK_INDIRECT_USAGE) ? 1 : 0);
1177 #endif
1178                         if (cb_flag & IDWALK_CB_INDIRECT_USAGE) {
1179                                 iter->count_indirect++;
1180                         }
1181                         else {
1182                                 iter->count_direct++;
1183                         }
1184                 }
1185         }
1186
1187         return IDWALK_RET_NOP;
1188 }
1189
1190 /**
1191  * Return the number of times given \a id_user uses/references \a id_used.
1192  *
1193  * \note This only checks for pointer references of an ID, shallow usages (like e.g. by RNA paths, as done
1194  *       for FCurves) are not detected at all.
1195  *
1196  * \param id_user: the ID which is supposed to use (reference) \a id_used.
1197  * \param id_used: the ID which is supposed to be used (referenced) by \a id_user.
1198  * \return the number of direct usages/references of \a id_used by \a id_user.
1199  */
1200 int BKE_library_ID_use_ID(ID *id_user, ID *id_used)
1201 {
1202         IDUsersIter iter;
1203
1204         /* We do not care about iter.lb_array/lb_idx here... */
1205         iter.id = id_used;
1206         iter.curr_id = id_user;
1207         iter.count_direct = iter.count_indirect = 0;
1208
1209         BKE_library_foreach_ID_link(NULL, iter.curr_id, foreach_libblock_id_users_callback, (void *)&iter, IDWALK_READONLY);
1210
1211         return iter.count_direct + iter.count_indirect;
1212 }
1213
1214 static bool library_ID_is_used(Main *bmain, void *idv, const bool check_linked)
1215 {
1216         IDUsersIter iter;
1217         ListBase *lb_array[MAX_LIBARRAY];
1218         ID *id = idv;
1219         int i = set_listbasepointers(bmain, lb_array);
1220         bool is_defined = false;
1221
1222         iter.id = id;
1223         iter.count_direct = iter.count_indirect = 0;
1224         while (i-- && !is_defined) {
1225                 ID *id_curr = lb_array[i]->first;
1226
1227                 if (!id_curr || !BKE_library_id_can_use_idtype(id_curr, GS(id->name))) {
1228                         continue;
1229                 }
1230
1231                 for (; id_curr && !is_defined; id_curr = id_curr->next) {
1232                         if (id_curr == id) {
1233                                 /* We are not interested in self-usages (mostly from drivers or bone constraints...). */
1234                                 continue;
1235                         }
1236                         iter.curr_id = id_curr;
1237                         BKE_library_foreach_ID_link(
1238                                     bmain, id_curr, foreach_libblock_id_users_callback, &iter, IDWALK_READONLY);
1239
1240                         is_defined = ((check_linked ? iter.count_indirect : iter.count_direct) != 0);
1241                 }
1242         }
1243
1244         return is_defined;
1245 }
1246
1247 /**
1248  * Check whether given ID is used locally (i.e. by another non-linked ID).
1249  */
1250 bool BKE_library_ID_is_locally_used(Main *bmain, void *idv)
1251 {
1252         return library_ID_is_used(bmain, idv, false);
1253 }
1254
1255 /**
1256  * Check whether given ID is used indirectly (i.e. by another linked ID).
1257  */
1258 bool BKE_library_ID_is_indirectly_used(Main *bmain, void *idv)
1259 {
1260         return library_ID_is_used(bmain, idv, true);
1261 }
1262
1263 /**
1264  * Combine \a BKE_library_ID_is_locally_used() and \a BKE_library_ID_is_indirectly_used() in a single call.
1265  */
1266 void BKE_library_ID_test_usages(Main *bmain, void *idv, bool *is_used_local, bool *is_used_linked)
1267 {
1268         IDUsersIter iter;
1269         ListBase *lb_array[MAX_LIBARRAY];
1270         ID *id = idv;
1271         int i = set_listbasepointers(bmain, lb_array);
1272         bool is_defined = false;
1273
1274         iter.id = id;
1275         iter.count_direct = iter.count_indirect = 0;
1276         while (i-- && !is_defined) {
1277                 ID *id_curr = lb_array[i]->first;
1278
1279                 if (!id_curr || !BKE_library_id_can_use_idtype(id_curr, GS(id->name))) {
1280                         continue;
1281                 }
1282
1283                 for (; id_curr && !is_defined; id_curr = id_curr->next) {
1284                         if (id_curr == id) {
1285                                 /* We are not interested in self-usages (mostly from drivers or bone constraints...). */
1286                                 continue;
1287                         }
1288                         iter.curr_id = id_curr;
1289                         BKE_library_foreach_ID_link(bmain, id_curr, foreach_libblock_id_users_callback, &iter, IDWALK_READONLY);
1290
1291                         is_defined = (iter.count_direct != 0 && iter.count_indirect != 0);
1292                 }
1293         }
1294
1295         *is_used_local = (iter.count_direct != 0);
1296         *is_used_linked = (iter.count_indirect != 0);
1297 }
1298
1299 /* ***** IDs usages.checking/tagging. ***** */
1300 static int foreach_libblock_used_linked_data_tag_clear_cb(
1301         void *user_data, ID *self_id, ID **id_p, int UNUSED(cb_flag))
1302 {
1303         bool *is_changed = user_data;
1304
1305         if (*id_p) {
1306                 /* XXX This is actually some kind of hack...
1307                  * Issue is, shapekeys' 'from' ID pointer is not actually ID usage.
1308                  * Maybe we should even nuke it from BKE_library_foreach_ID_link, not 100% sure yet...
1309                  */
1310                 if ((GS(self_id->name) == ID_KE) && (((Key *)self_id)->from == *id_p)) {
1311                         return IDWALK_RET_NOP;
1312                 }
1313                 /* XXX another hack, for similar reasons as above one. */
1314                 if ((GS(self_id->name) == ID_OB) && (((Object *)self_id)->proxy_from == (Object *)*id_p)) {
1315                         return IDWALK_RET_NOP;
1316                 }
1317
1318                 /* If checked id is used by an assumed used ID, then it is also used and not part of any linked archipelago. */
1319                 if (!(self_id->tag & LIB_TAG_DOIT) && ((*id_p)->tag & LIB_TAG_DOIT)) {
1320                         (*id_p)->tag &= ~LIB_TAG_DOIT;
1321                         *is_changed = true;
1322                 }
1323         }
1324
1325         return IDWALK_RET_NOP;
1326 }
1327
1328 /**
1329  * Detect orphaned linked data blocks (i.e. linked data not used (directly or indirectly) in any way by any local data),
1330  * including complex cases like 'linked archipelagoes', i.e. linked datablocks that use each other in loops,
1331  * which prevents their deletion by 'basic' usage checks...
1332  *
1333  * \param do_init_tag: if \a true, all linked data are checked, if \a false, only linked datablocks already tagged with
1334  *                    LIB_TAG_DOIT are checked.
1335  */
1336 void BKE_library_unused_linked_data_set_tag(Main *bmain, const bool do_init_tag)
1337 {
1338         ListBase *lb_array[MAX_LIBARRAY];
1339
1340         if (do_init_tag) {
1341                 int i = set_listbasepointers(bmain, lb_array);
1342
1343                 while (i--) {
1344                         for (ID *id = lb_array[i]->first; id; id = id->next) {
1345                                 if (id->lib && (id->tag & LIB_TAG_INDIRECT) != 0) {
1346                                         id->tag |= LIB_TAG_DOIT;
1347                                 }
1348                                 else {
1349                                         id->tag &= ~LIB_TAG_DOIT;
1350                                 }
1351                         }
1352                 }
1353         }
1354
1355         bool do_loop = true;
1356         while (do_loop) {
1357                 int i = set_listbasepointers(bmain, lb_array);
1358                 do_loop = false;
1359
1360                 while (i--) {
1361                         for (ID *id = lb_array[i]->first; id; id = id->next) {
1362                                 if (id->tag & LIB_TAG_DOIT) {
1363                                         /* Unused ID (so far), no need to check it further. */
1364                                         continue;
1365                                 }
1366                                 BKE_library_foreach_ID_link(
1367                                             bmain, id, foreach_libblock_used_linked_data_tag_clear_cb, &do_loop, IDWALK_READONLY);
1368                         }
1369                 }
1370         }
1371 }
1372
1373 /**
1374  * Untag linked data blocks used by other untagged linked datablocks.
1375  * Used to detect datablocks that we can forcefully make local (instead of copying them to later get rid of original):
1376  * All datablocks we want to make local are tagged by caller, after this function has ran caller knows datablocks still
1377  * tagged can directly be made local, since they are only used by other datablocks that will also be made fully local.
1378  */
1379 void BKE_library_indirectly_used_data_tag_clear(Main *bmain)
1380 {
1381         ListBase *lb_array[MAX_LIBARRAY];
1382
1383         bool do_loop = true;
1384         while (do_loop) {
1385                 int i = set_listbasepointers(bmain, lb_array);
1386                 do_loop = false;
1387
1388                 while (i--) {
1389                         for (ID *id = lb_array[i]->first; id; id = id->next) {
1390                                 if (id->lib == NULL || id->tag & LIB_TAG_DOIT) {
1391                                         /* Local or non-indirectly-used ID (so far), no need to check it further. */
1392                                         continue;
1393                                 }
1394                                 BKE_library_foreach_ID_link(
1395                                             bmain, id, foreach_libblock_used_linked_data_tag_clear_cb, &do_loop, IDWALK_READONLY);
1396                         }
1397                 }
1398         }
1399 }