ClangFormat: apply to source, most of intern
[blender.git] / source / blender / blenkernel / intern / library_remap.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file
18  * \ingroup bke
19  *
20  * Contains management of ID's and libraries remap, unlink and free logic.
21  */
22
23 #include <stdio.h>
24 #include <ctype.h>
25 #include <string.h>
26 #include <stdlib.h>
27 #include <stddef.h>
28 #include <assert.h>
29
30 #include "CLG_log.h"
31
32 #include "MEM_guardedalloc.h"
33
34 /* all types are needed here, in order to do memory operations */
35 #include "DNA_anim_types.h"
36 #include "DNA_armature_types.h"
37 #include "DNA_brush_types.h"
38 #include "DNA_camera_types.h"
39 #include "DNA_cachefile_types.h"
40 #include "DNA_collection_types.h"
41 #include "DNA_gpencil_types.h"
42 #include "DNA_ipo_types.h"
43 #include "DNA_key_types.h"
44 #include "DNA_light_types.h"
45 #include "DNA_lattice_types.h"
46 #include "DNA_linestyle_types.h"
47 #include "DNA_material_types.h"
48 #include "DNA_mesh_types.h"
49 #include "DNA_meta_types.h"
50 #include "DNA_movieclip_types.h"
51 #include "DNA_mask_types.h"
52 #include "DNA_node_types.h"
53 #include "DNA_object_types.h"
54 #include "DNA_lightprobe_types.h"
55 #include "DNA_scene_types.h"
56 #include "DNA_screen_types.h"
57 #include "DNA_speaker_types.h"
58 #include "DNA_sound_types.h"
59 #include "DNA_text_types.h"
60 #include "DNA_vfont_types.h"
61 #include "DNA_windowmanager_types.h"
62 #include "DNA_workspace_types.h"
63 #include "DNA_world_types.h"
64
65 #include "BLI_blenlib.h"
66 #include "BLI_utildefines.h"
67
68 #include "BKE_action.h"
69 #include "BKE_animsys.h"
70 #include "BKE_armature.h"
71 #include "BKE_brush.h"
72 #include "BKE_camera.h"
73 #include "BKE_cachefile.h"
74 #include "BKE_collection.h"
75 #include "BKE_curve.h"
76 #include "BKE_fcurve.h"
77 #include "BKE_font.h"
78 #include "BKE_gpencil.h"
79 #include "BKE_idprop.h"
80 #include "BKE_image.h"
81 #include "BKE_ipo.h"
82 #include "BKE_key.h"
83 #include "BKE_light.h"
84 #include "BKE_lattice.h"
85 #include "BKE_layer.h"
86 #include "BKE_library.h"
87 #include "BKE_library_override.h"
88 #include "BKE_library_query.h"
89 #include "BKE_library_remap.h"
90 #include "BKE_linestyle.h"
91 #include "BKE_mesh.h"
92 #include "BKE_material.h"
93 #include "BKE_main.h"
94 #include "BKE_mask.h"
95 #include "BKE_mball.h"
96 #include "BKE_modifier.h"
97 #include "BKE_movieclip.h"
98 #include "BKE_multires.h"
99 #include "BKE_node.h"
100 #include "BKE_object.h"
101 #include "BKE_paint.h"
102 #include "BKE_particle.h"
103 #include "BKE_lightprobe.h"
104 #include "BKE_speaker.h"
105 #include "BKE_sound.h"
106 #include "BKE_screen.h"
107 #include "BKE_scene.h"
108 #include "BKE_text.h"
109 #include "BKE_texture.h"
110 #include "BKE_workspace.h"
111 #include "BKE_world.h"
112
113 #include "DEG_depsgraph.h"
114 #include "DEG_depsgraph_build.h"
115
116 #ifdef WITH_PYTHON
117 #  include "BPY_extern.h"
118 #endif
119
120 static CLG_LogRef LOG = {"bke.library_remap"};
121
122 static BKE_library_free_window_manager_cb free_windowmanager_cb = NULL;
123
124 void BKE_library_callback_free_window_manager_set(BKE_library_free_window_manager_cb func)
125 {
126   free_windowmanager_cb = func;
127 }
128
129 static BKE_library_free_notifier_reference_cb free_notifier_reference_cb = NULL;
130
131 void BKE_library_callback_free_notifier_reference_set(BKE_library_free_notifier_reference_cb func)
132 {
133   free_notifier_reference_cb = func;
134 }
135
136 static BKE_library_remap_editor_id_reference_cb remap_editor_id_reference_cb = NULL;
137
138 void BKE_library_callback_remap_editor_id_reference_set(
139     BKE_library_remap_editor_id_reference_cb func)
140 {
141   remap_editor_id_reference_cb = func;
142 }
143
144 typedef struct IDRemap {
145   Main *bmain; /* Only used to trigger depsgraph updates in the right bmain. */
146   ID *old_id;
147   ID *new_id;
148   ID *id; /* The ID in which we are replacing old_id by new_id usages. */
149   short flag;
150
151   /* 'Output' data. */
152   short status;
153   int skipped_direct; /* Number of direct usecases that could not be remapped (e.g.: obdata when in edit mode). */
154   int skipped_indirect;   /* Number of indirect usecases that could not be remapped. */
155   int skipped_refcounted; /* Number of skipped usecases that refcount the datablock. */
156 } IDRemap;
157
158 /* IDRemap->flag enums defined in BKE_library.h */
159
160 /* IDRemap->status */
161 enum {
162   /* *** Set by callback. *** */
163   ID_REMAP_IS_LINKED_DIRECT = 1 << 0,    /* new_id is directly linked in current .blend. */
164   ID_REMAP_IS_USER_ONE_SKIPPED = 1 << 1, /* There was some skipped 'user_one' usages of old_id. */
165 };
166
167 static int foreach_libblock_remap_callback(void *user_data, ID *id_self, ID **id_p, int cb_flag)
168 {
169   if (cb_flag & IDWALK_CB_PRIVATE) {
170     return IDWALK_RET_NOP;
171   }
172
173   IDRemap *id_remap_data = user_data;
174   ID *old_id = id_remap_data->old_id;
175   ID *new_id = id_remap_data->new_id;
176   ID *id = id_remap_data->id;
177
178   if (!old_id) { /* Used to cleanup all IDs used by a specific one. */
179     BLI_assert(!new_id);
180     old_id = *id_p;
181   }
182
183   if (*id_p && (*id_p == old_id)) {
184     /* Better remap to NULL than not remapping at all, then we can handle it as a regular remap-to-NULL case... */
185     if ((cb_flag & IDWALK_CB_NEVER_SELF) && (new_id == id_self)) {
186       new_id = NULL;
187     }
188
189     const bool is_reference = (cb_flag & IDWALK_CB_STATIC_OVERRIDE_REFERENCE) != 0;
190     const bool is_indirect = (cb_flag & IDWALK_CB_INDIRECT_USAGE) != 0;
191     const bool skip_indirect = (id_remap_data->flag & ID_REMAP_SKIP_INDIRECT_USAGE) != 0;
192     /* Note: proxy usage implies LIB_TAG_EXTERN, so on this aspect it is direct,
193      *       on the other hand since they get reset to lib data on file open/reload it is indirect too...
194      *       Edit Mode is also a 'skip direct' case. */
195     const bool is_obj = (GS(id->name) == ID_OB);
196     const bool is_obj_proxy = (is_obj && (((Object *)id)->proxy || ((Object *)id)->proxy_group));
197     const bool is_obj_editmode = (is_obj && BKE_object_is_in_editmode((Object *)id));
198     const bool is_never_null = ((cb_flag & IDWALK_CB_NEVER_NULL) && (new_id == NULL) &&
199                                 (id_remap_data->flag & ID_REMAP_FORCE_NEVER_NULL_USAGE) == 0);
200     const bool skip_reference = (id_remap_data->flag & ID_REMAP_SKIP_STATIC_OVERRIDE) != 0;
201     const bool skip_never_null = (id_remap_data->flag & ID_REMAP_SKIP_NEVER_NULL_USAGE) != 0;
202
203 #ifdef DEBUG_PRINT
204     printf(
205         "In %s (lib %p): Remapping %s (%p) to %s (%p) "
206         "(is_indirect: %d, skip_indirect: %d, is_reference: %d, skip_reference: %d)\n",
207         id->name,
208         id->lib,
209         old_id->name,
210         old_id,
211         new_id ? new_id->name : "<NONE>",
212         new_id,
213         is_indirect,
214         skip_indirect,
215         is_reference,
216         skip_reference);
217 #endif
218
219     if ((id_remap_data->flag & ID_REMAP_FLAG_NEVER_NULL_USAGE) &&
220         (cb_flag & IDWALK_CB_NEVER_NULL)) {
221       id->tag |= LIB_TAG_DOIT;
222     }
223
224     /* Special hack in case it's Object->data and we are in edit mode, and new_id is not NULL
225      * (otherwise, we follow common NEVER_NULL flags).
226      * (skipped_indirect too). */
227     if ((is_never_null && skip_never_null) ||
228         (is_obj_editmode && (((Object *)id)->data == *id_p) && new_id != NULL) ||
229         (skip_indirect && is_indirect) || (is_reference && skip_reference)) {
230       if (is_indirect) {
231         id_remap_data->skipped_indirect++;
232         if (is_obj) {
233           Object *ob = (Object *)id;
234           if (ob->data == *id_p && ob->proxy != NULL) {
235             /* And another 'Proudly brought to you by Proxy Hell' hack!
236              * This will allow us to avoid clearing 'LIB_EXTERN' flag of obdata of proxies... */
237             id_remap_data->skipped_direct++;
238           }
239         }
240       }
241       else if (is_never_null || is_obj_editmode || is_reference) {
242         id_remap_data->skipped_direct++;
243       }
244       else {
245         BLI_assert(0);
246       }
247       if (cb_flag & IDWALK_CB_USER) {
248         id_remap_data->skipped_refcounted++;
249       }
250       else if (cb_flag & IDWALK_CB_USER_ONE) {
251         /* No need to count number of times this happens, just a flag is enough. */
252         id_remap_data->status |= ID_REMAP_IS_USER_ONE_SKIPPED;
253       }
254     }
255     else {
256       if (!is_never_null) {
257         *id_p = new_id;
258         DEG_id_tag_update_ex(id_remap_data->bmain,
259                              id_self,
260                              ID_RECALC_COPY_ON_WRITE | ID_RECALC_TRANSFORM | ID_RECALC_GEOMETRY);
261       }
262       if (cb_flag & IDWALK_CB_USER) {
263         /* NOTE: We don't user-count IDs which are not in the main database.
264          * This is because in certain conditions we can have datablocks in
265          * the main which are referencing datablocks outside of it.
266          * For example, BKE_mesh_new_from_object() called on an evaluated
267          * object will cause such situation.
268          */
269         if ((old_id->tag & LIB_TAG_NO_MAIN) == 0) {
270           id_us_min(old_id);
271         }
272         if (new_id != NULL && (new_id->tag & LIB_TAG_NO_MAIN) == 0) {
273           /* We do not want to handle LIB_TAG_INDIRECT/LIB_TAG_EXTERN here. */
274           new_id->us++;
275         }
276       }
277       else if (cb_flag & IDWALK_CB_USER_ONE) {
278         id_us_ensure_real(new_id);
279         /* We cannot affect old_id->us directly, LIB_TAG_EXTRAUSER(_SET) are assumed to be set as needed,
280          * that extra user is processed in final handling... */
281       }
282       if (!is_indirect || is_obj_proxy) {
283         id_remap_data->status |= ID_REMAP_IS_LINKED_DIRECT;
284       }
285     }
286   }
287
288   return IDWALK_RET_NOP;
289 }
290
291 static void libblock_remap_data_preprocess(IDRemap *r_id_remap_data)
292 {
293   switch (GS(r_id_remap_data->id->name)) {
294     case ID_OB: {
295       ID *old_id = r_id_remap_data->old_id;
296       if (!old_id || GS(old_id->name) == ID_AR) {
297         Object *ob = (Object *)r_id_remap_data->id;
298         /* Object's pose holds reference to armature bones... sic */
299         /* Note that in theory, we should have to bother about linked/non-linked/never-null/etc. flags/states.
300          * Fortunately, this is just a tag, so we can accept to 'over-tag' a bit for pose recalc, and avoid
301          * another complex and risky condition nightmare like the one we have in
302          * foreach_libblock_remap_callback()... */
303         if (ob->pose && (!old_id || ob->data == old_id)) {
304           BLI_assert(ob->type == OB_ARMATURE);
305           ob->pose->flag |= POSE_RECALC;
306           /* We need to clear pose bone pointers immediately, things like undo writefile may be called
307            * before pose is actually recomputed, can lead to segfault... */
308           BKE_pose_clear_pointers(ob->pose);
309         }
310       }
311       break;
312     }
313     default:
314       break;
315   }
316 }
317
318 /* Can be called with both old_ob and new_ob being NULL, this means we have to check whole Main database then. */
319 static void libblock_remap_data_postprocess_object_update(Main *bmain,
320                                                           Object *old_ob,
321                                                           Object *new_ob)
322 {
323   if (new_ob == NULL) {
324     /* In case we unlinked old_ob (new_ob is NULL), the object has already
325      * been removed from the scenes and their collections. We still have
326      * to remove the NULL children from collections not used in any scene. */
327     BKE_collections_object_remove_nulls(bmain);
328   }
329
330   BKE_main_collection_sync_remap(bmain);
331
332   if (old_ob == NULL) {
333     for (Object *ob = bmain->objects.first; ob != NULL; ob = ob->id.next) {
334       if (ob->type == OB_MBALL && BKE_mball_is_basis(ob)) {
335         DEG_id_tag_update(&ob->id, ID_RECALC_GEOMETRY);
336       }
337     }
338   }
339   else {
340     for (Object *ob = bmain->objects.first; ob != NULL; ob = ob->id.next) {
341       if (ob->type == OB_MBALL && BKE_mball_is_basis_for(ob, old_ob)) {
342         DEG_id_tag_update(&ob->id, ID_RECALC_GEOMETRY);
343         break; /* There is only one basis... */
344       }
345     }
346   }
347 }
348
349 /* Can be called with both old_collection and new_collection being NULL,
350  * this means we have to check whole Main database then. */
351 static void libblock_remap_data_postprocess_collection_update(Main *bmain,
352                                                               Collection *UNUSED(old_collection),
353                                                               Collection *new_collection)
354 {
355   if (new_collection == NULL) {
356     /* XXX Complex cases can lead to NULL pointers in other collections than old_collection,
357      * and BKE_main_collection_sync_remap() does not tolerate any of those, so for now always check whole
358      * existing collections for NULL pointers.
359      * I'd consider optimizing that whole collection remapping process a TODO for later. */
360     BKE_collections_child_remove_nulls(bmain, NULL /*old_collection*/);
361   }
362
363   BKE_main_collection_sync_remap(bmain);
364 }
365
366 static void libblock_remap_data_postprocess_obdata_relink(Main *bmain, Object *ob, ID *new_id)
367 {
368   if (ob->data == new_id) {
369     switch (GS(new_id->name)) {
370       case ID_ME:
371         multires_force_update(ob);
372         break;
373       case ID_CU:
374         BKE_curve_type_test(ob);
375         break;
376       default:
377         break;
378     }
379     test_object_modifiers(ob);
380     test_object_materials(bmain, ob, new_id);
381   }
382 }
383
384 static void libblock_remap_data_postprocess_nodetree_update(Main *bmain, ID *new_id)
385 {
386   /* Verify all nodetree user nodes. */
387   ntreeVerifyNodes(bmain, new_id);
388
389   /* Update node trees as necessary. */
390   FOREACH_NODETREE_BEGIN (bmain, ntree, id) {
391     /* make an update call for the tree */
392     ntreeUpdateTree(bmain, ntree);
393   }
394   FOREACH_NODETREE_END;
395 }
396
397 /**
398  * Execute the 'data' part of the remapping (that is, all ID pointers from other ID datablocks).
399  *
400  * Behavior differs depending on whether given \a id is NULL or not:
401  * - \a id NULL: \a old_id must be non-NULL, \a new_id may be NULL (unlinking \a old_id) or not
402  *   (remapping \a old_id to \a new_id). The whole \a bmain database is checked, and all pointers to \a old_id
403  *   are remapped to \a new_id.
404  * - \a id is non-NULL:
405  *   + If \a old_id is NULL, \a new_id must also be NULL, and all ID pointers from \a id are cleared (i.e. \a id
406  *     does not references any other datablock anymore).
407  *   + If \a old_id is non-NULL, behavior is as with a NULL \a id, but only within given \a id.
408  *
409  * \param bmain: the Main data storage to operate on (must never be NULL).
410  * \param id: the datablock to operate on (can be NULL, in which case we operate over all IDs from given bmain).
411  * \param old_id: the datablock to dereference (may be NULL if \a id is non-NULL).
412  * \param new_id: the new datablock to replace \a old_id references with (may be NULL).
413  * \param r_id_remap_data: if non-NULL, the IDRemap struct to use (uselful to retrieve info about remapping process).
414  */
415 ATTR_NONNULL(1)
416 static void libblock_remap_data(
417     Main *bmain, ID *id, ID *old_id, ID *new_id, const short remap_flags, IDRemap *r_id_remap_data)
418 {
419   IDRemap id_remap_data;
420   const int foreach_id_flags = (remap_flags & ID_REMAP_NO_INDIRECT_PROXY_DATA_USAGE) != 0 ?
421                                    IDWALK_NO_INDIRECT_PROXY_DATA_USAGE :
422                                    IDWALK_NOP;
423
424   if (r_id_remap_data == NULL) {
425     r_id_remap_data = &id_remap_data;
426   }
427   r_id_remap_data->bmain = bmain;
428   r_id_remap_data->old_id = old_id;
429   r_id_remap_data->new_id = new_id;
430   r_id_remap_data->id = NULL;
431   r_id_remap_data->flag = remap_flags;
432   r_id_remap_data->status = 0;
433   r_id_remap_data->skipped_direct = 0;
434   r_id_remap_data->skipped_indirect = 0;
435   r_id_remap_data->skipped_refcounted = 0;
436
437   if (id) {
438 #ifdef DEBUG_PRINT
439     printf("\tchecking id %s (%p, %p)\n", id->name, id, id->lib);
440 #endif
441     r_id_remap_data->id = id;
442     libblock_remap_data_preprocess(r_id_remap_data);
443     BKE_library_foreach_ID_link(
444         NULL, id, foreach_libblock_remap_callback, (void *)r_id_remap_data, foreach_id_flags);
445   }
446   else {
447     /* Note that this is a very 'brute force' approach, maybe we could use some depsgraph to only process
448      * objects actually using given old_id... sounds rather unlikely currently, though, so this will do for now. */
449     ID *id_curr;
450
451     FOREACH_MAIN_ID_BEGIN(bmain, id_curr)
452     {
453       if (BKE_library_id_can_use_idtype(id_curr, GS(old_id->name))) {
454         /* Note that we cannot skip indirect usages of old_id here (if requested), we still need to check it for
455          * the user count handling...
456          * XXX No more true (except for debug usage of those skipping counters). */
457         r_id_remap_data->id = id_curr;
458         libblock_remap_data_preprocess(r_id_remap_data);
459         BKE_library_foreach_ID_link(NULL,
460                                     id_curr,
461                                     foreach_libblock_remap_callback,
462                                     (void *)r_id_remap_data,
463                                     foreach_id_flags);
464       }
465     }
466     FOREACH_MAIN_ID_END;
467   }
468
469   /* XXX We may not want to always 'transfer' fakeuser from old to new id... Think for now it's desired behavior
470    *     though, we can always add an option (flag) to control this later if needed. */
471   if (old_id && (old_id->flag & LIB_FAKEUSER)) {
472     id_fake_user_clear(old_id);
473     id_fake_user_set(new_id);
474   }
475
476   id_us_clear_real(old_id);
477
478   if (new_id && (new_id->tag & LIB_TAG_INDIRECT) &&
479       (r_id_remap_data->status & ID_REMAP_IS_LINKED_DIRECT)) {
480     new_id->tag &= ~LIB_TAG_INDIRECT;
481     new_id->tag |= LIB_TAG_EXTERN;
482   }
483
484 #ifdef DEBUG_PRINT
485   printf("%s: %d occurrences skipped (%d direct and %d indirect ones)\n",
486          __func__,
487          r_id_remap_data->skipped_direct + r_id_remap_data->skipped_indirect,
488          r_id_remap_data->skipped_direct,
489          r_id_remap_data->skipped_indirect);
490 #endif
491 }
492
493 /**
494  * Replace all references in given Main to \a old_id by \a new_id
495  * (if \a new_id is NULL, it unlinks \a old_id).
496  */
497 void BKE_libblock_remap_locked(Main *bmain, void *old_idv, void *new_idv, const short remap_flags)
498 {
499   IDRemap id_remap_data;
500   ID *old_id = old_idv;
501   ID *new_id = new_idv;
502   int skipped_direct, skipped_refcounted;
503
504   BLI_assert(old_id != NULL);
505   BLI_assert((new_id == NULL) || GS(old_id->name) == GS(new_id->name));
506   BLI_assert(old_id != new_id);
507
508   libblock_remap_data(bmain, NULL, old_id, new_id, remap_flags, &id_remap_data);
509
510   if (free_notifier_reference_cb) {
511     free_notifier_reference_cb(old_id);
512   }
513
514   /* We assume editors do not hold references to their IDs... This is false in some cases
515    * (Image is especially tricky here), editors' code is to handle refcount (id->us) itself then. */
516   if (remap_editor_id_reference_cb) {
517     remap_editor_id_reference_cb(old_id, new_id);
518   }
519
520   skipped_direct = id_remap_data.skipped_direct;
521   skipped_refcounted = id_remap_data.skipped_refcounted;
522
523   /* If old_id was used by some ugly 'user_one' stuff (like Image or Clip editors...), and user count has actually
524    * been incremented for that, we have to decrease once more its user count... unless we had to skip
525    * some 'user_one' cases. */
526   if ((old_id->tag & LIB_TAG_EXTRAUSER_SET) &&
527       !(id_remap_data.status & ID_REMAP_IS_USER_ONE_SKIPPED)) {
528     id_us_clear_real(old_id);
529   }
530
531   if (old_id->us - skipped_refcounted < 0) {
532     CLOG_ERROR(&LOG,
533                "Error in remapping process from '%s' (%p) to '%s' (%p): "
534                "wrong user count in old ID after process (summing up to %d)",
535                old_id->name,
536                old_id,
537                new_id ? new_id->name : "<NULL>",
538                new_id,
539                old_id->us - skipped_refcounted);
540     BLI_assert(0);
541   }
542
543   if (skipped_direct == 0) {
544     /* old_id is assumed to not be used directly anymore... */
545     if (old_id->lib && (old_id->tag & LIB_TAG_EXTERN)) {
546       old_id->tag &= ~LIB_TAG_EXTERN;
547       old_id->tag |= LIB_TAG_INDIRECT;
548     }
549   }
550
551   /* Some after-process updates.
552    * This is a bit ugly, but cannot see a way to avoid it. Maybe we should do a per-ID callback for this instead?
553    */
554   switch (GS(old_id->name)) {
555     case ID_OB:
556       libblock_remap_data_postprocess_object_update(bmain, (Object *)old_id, (Object *)new_id);
557       break;
558     case ID_GR:
559       libblock_remap_data_postprocess_collection_update(
560           bmain, (Collection *)old_id, (Collection *)new_id);
561       break;
562     case ID_ME:
563     case ID_CU:
564     case ID_MB:
565       if (new_id) { /* Only affects us in case obdata was relinked (changed). */
566         for (Object *ob = bmain->objects.first; ob; ob = ob->id.next) {
567           libblock_remap_data_postprocess_obdata_relink(bmain, ob, new_id);
568         }
569       }
570       break;
571     default:
572       break;
573   }
574
575   /* Node trees may virtually use any kind of data-block... */
576   /* XXX Yuck!!!! nodetree update can do pretty much any thing when talking about py nodes,
577    *     including creating new data-blocks (see T50385), so we need to unlock main here. :(
578    *     Why can't we have re-entrent locks? */
579   BKE_main_unlock(bmain);
580   libblock_remap_data_postprocess_nodetree_update(bmain, new_id);
581   BKE_main_lock(bmain);
582
583   /* Full rebuild of DEG! */
584   DEG_relations_tag_update(bmain);
585 }
586
587 void BKE_libblock_remap(Main *bmain, void *old_idv, void *new_idv, const short remap_flags)
588 {
589   BKE_main_lock(bmain);
590
591   BKE_libblock_remap_locked(bmain, old_idv, new_idv, remap_flags);
592
593   BKE_main_unlock(bmain);
594 }
595
596 /**
597  * Unlink given \a id from given \a bmain (does not touch to indirect, i.e. library, usages of the ID).
598  *
599  * \param do_flag_never_null: If true, all IDs using \a idv in a 'non-NULL' way are flagged by \a LIB_TAG_DOIT flag
600  * (quite obviously, 'non-NULL' usages can never be unlinked by this function...).
601  */
602 void BKE_libblock_unlink(Main *bmain,
603                          void *idv,
604                          const bool do_flag_never_null,
605                          const bool do_skip_indirect)
606 {
607   const short remap_flags = (do_skip_indirect ? ID_REMAP_SKIP_INDIRECT_USAGE : 0) |
608                             (do_flag_never_null ? ID_REMAP_FLAG_NEVER_NULL_USAGE : 0);
609
610   BKE_main_lock(bmain);
611
612   BKE_libblock_remap_locked(bmain, idv, NULL, remap_flags);
613
614   BKE_main_unlock(bmain);
615 }
616
617 /** Similar to libblock_remap, but only affects IDs used by given \a idv ID.
618  *
619  * \param old_idv: Unlike BKE_libblock_remap, can be NULL,
620  * in which case all ID usages by given \a idv will be cleared.
621  * \param us_min_never_null: If \a true and new_id is NULL,
622  * 'NEVER_NULL' ID usages keep their old id, but this one still gets its user count decremented
623  * (needed when given \a idv is going to be deleted right after being unlinked).
624  */
625 /* Should be able to replace all _relink() funcs (constraints, rigidbody, etc.) ? */
626 /* XXX Arg! Naming... :(
627  *     _relink? avoids confusion with _remap, but is confusing with _unlink
628  *     _remap_used_ids?
629  *     _remap_datablocks?
630  *     BKE_id_remap maybe?
631  *     ... sigh
632  */
633 void BKE_libblock_relink_ex(
634     Main *bmain, void *idv, void *old_idv, void *new_idv, const bool us_min_never_null)
635 {
636   ID *id = idv;
637   ID *old_id = old_idv;
638   ID *new_id = new_idv;
639   int remap_flags = us_min_never_null ? 0 : ID_REMAP_SKIP_NEVER_NULL_USAGE;
640
641   /* No need to lock here, we are only affecting given ID, not bmain database. */
642
643   BLI_assert(id);
644   if (old_id) {
645     BLI_assert((new_id == NULL) || GS(old_id->name) == GS(new_id->name));
646     BLI_assert(old_id != new_id);
647   }
648   else {
649     BLI_assert(new_id == NULL);
650   }
651
652   libblock_remap_data(bmain, id, old_id, new_id, remap_flags, NULL);
653
654   /* Some after-process updates.
655    * This is a bit ugly, but cannot see a way to avoid it. Maybe we should do a per-ID callback for this instead?
656    */
657   switch (GS(id->name)) {
658     case ID_SCE: {
659       if (old_id) {
660         switch (GS(old_id->name)) {
661           case ID_OB:
662             libblock_remap_data_postprocess_object_update(
663                 bmain, (Object *)old_id, (Object *)new_id);
664             break;
665           case ID_GR:
666             libblock_remap_data_postprocess_collection_update(
667                 bmain, (Collection *)old_id, (Collection *)new_id);
668             break;
669           default:
670             break;
671         }
672       }
673       else {
674         /* No choice but to check whole objects/collections. */
675         libblock_remap_data_postprocess_collection_update(bmain, NULL, NULL);
676         libblock_remap_data_postprocess_object_update(bmain, NULL, NULL);
677       }
678       break;
679     }
680     case ID_OB:
681       if (new_id) { /* Only affects us in case obdata was relinked (changed). */
682         libblock_remap_data_postprocess_obdata_relink(bmain, (Object *)id, new_id);
683       }
684       break;
685     default:
686       break;
687   }
688 }
689
690 static int id_relink_to_newid_looper(void *UNUSED(user_data),
691                                      ID *UNUSED(self_id),
692                                      ID **id_pointer,
693                                      const int cb_flag)
694 {
695   if (cb_flag & IDWALK_CB_PRIVATE) {
696     return IDWALK_RET_NOP;
697   }
698
699   ID *id = *id_pointer;
700   if (id) {
701     /* See: NEW_ID macro */
702     if (id->newid) {
703       BKE_library_update_ID_link_user(id->newid, id, cb_flag);
704       *id_pointer = id->newid;
705     }
706     else if (id->tag & LIB_TAG_NEW) {
707       id->tag &= ~LIB_TAG_NEW;
708       BKE_libblock_relink_to_newid(id);
709     }
710   }
711   return IDWALK_RET_NOP;
712 }
713
714 /** Similar to libblock_relink_ex, but is remapping IDs to their newid value if non-NULL, in given \a id.
715  *
716  * Very specific usage, not sure we'll keep it on the long run, currently only used in Object/Collection duplication code...
717  */
718 void BKE_libblock_relink_to_newid(ID *id)
719 {
720   if (ID_IS_LINKED(id))
721     return;
722
723   BKE_library_foreach_ID_link(NULL, id, id_relink_to_newid_looper, NULL, 0);
724 }
725
726 void BKE_libblock_free_data(ID *id, const bool do_id_user)
727 {
728   if (id->properties) {
729     IDP_FreeProperty_ex(id->properties, do_id_user);
730     MEM_freeN(id->properties);
731   }
732
733   if (id->override_static) {
734     BKE_override_static_free(&id->override_static);
735   }
736
737   /* XXX TODO remove animdata handling from each type's freeing func, and do it here, like for copy! */
738 }
739
740 void BKE_libblock_free_datablock(ID *id, const int UNUSED(flag))
741 {
742   const short type = GS(id->name);
743   switch (type) {
744     case ID_SCE:
745       BKE_scene_free_ex((Scene *)id, false);
746       break;
747     case ID_LI:
748       BKE_library_free((Library *)id);
749       break;
750     case ID_OB:
751       BKE_object_free((Object *)id);
752       break;
753     case ID_ME:
754       BKE_mesh_free((Mesh *)id);
755       break;
756     case ID_CU:
757       BKE_curve_free((Curve *)id);
758       break;
759     case ID_MB:
760       BKE_mball_free((MetaBall *)id);
761       break;
762     case ID_MA:
763       BKE_material_free((Material *)id);
764       break;
765     case ID_TE:
766       BKE_texture_free((Tex *)id);
767       break;
768     case ID_IM:
769       BKE_image_free((Image *)id);
770       break;
771     case ID_LT:
772       BKE_lattice_free((Lattice *)id);
773       break;
774     case ID_LA:
775       BKE_light_free((Light *)id);
776       break;
777     case ID_CA:
778       BKE_camera_free((Camera *)id);
779       break;
780     case ID_IP: /* Deprecated. */
781       BKE_ipo_free((Ipo *)id);
782       break;
783     case ID_KE:
784       BKE_key_free((Key *)id);
785       break;
786     case ID_WO:
787       BKE_world_free((World *)id);
788       break;
789     case ID_SCR:
790       BKE_screen_free((bScreen *)id);
791       break;
792     case ID_VF:
793       BKE_vfont_free((VFont *)id);
794       break;
795     case ID_TXT:
796       BKE_text_free((Text *)id);
797       break;
798     case ID_SPK:
799       BKE_speaker_free((Speaker *)id);
800       break;
801     case ID_LP:
802       BKE_lightprobe_free((LightProbe *)id);
803       break;
804     case ID_SO:
805       BKE_sound_free((bSound *)id);
806       break;
807     case ID_GR:
808       BKE_collection_free((Collection *)id);
809       break;
810     case ID_AR:
811       BKE_armature_free((bArmature *)id);
812       break;
813     case ID_AC:
814       BKE_action_free((bAction *)id);
815       break;
816     case ID_NT:
817       ntreeFreeTree((bNodeTree *)id);
818       break;
819     case ID_BR:
820       BKE_brush_free((Brush *)id);
821       break;
822     case ID_PA:
823       BKE_particlesettings_free((ParticleSettings *)id);
824       break;
825     case ID_WM:
826       if (free_windowmanager_cb)
827         free_windowmanager_cb(NULL, (wmWindowManager *)id);
828       break;
829     case ID_GD:
830       BKE_gpencil_free((bGPdata *)id, true);
831       break;
832     case ID_MC:
833       BKE_movieclip_free((MovieClip *)id);
834       break;
835     case ID_MSK:
836       BKE_mask_free((Mask *)id);
837       break;
838     case ID_LS:
839       BKE_linestyle_free((FreestyleLineStyle *)id);
840       break;
841     case ID_PAL:
842       BKE_palette_free((Palette *)id);
843       break;
844     case ID_PC:
845       BKE_paint_curve_free((PaintCurve *)id);
846       break;
847     case ID_CF:
848       BKE_cachefile_free((CacheFile *)id);
849       break;
850     case ID_WS:
851       BKE_workspace_free((WorkSpace *)id);
852       break;
853   }
854 }
855
856 /**
857  * Complete ID freeing, extended version for corner cases.
858  * Can override default (and safe!) freeing process, to gain some speed up.
859  *
860  * At that point, given id is assumed to not be used by any other data-block already
861  * (might not be actually true, in case e.g. several inter-related IDs get freed together...).
862  * However, they might still be using (referencing) other IDs, this code takes care of it if
863  * \a LIB_TAG_NO_USER_REFCOUNT is not defined.
864  *
865  * \param bmain: Main database containing the freed ID, can be NULL in case it's a temp ID outside of any Main.
866  * \param idv: Pointer to ID to be freed.
867  * \param flag: Set of \a LIB_ID_FREE_... flags controlling/overriding usual freeing process,
868  * 0 to get default safe behavior.
869  * \param use_flag_from_idtag: Still use freeing info flags from given ID datablock,
870  * even if some overriding ones are passed in \a flag parameter.
871  */
872 void BKE_id_free_ex(Main *bmain, void *idv, int flag, const bool use_flag_from_idtag)
873 {
874   ID *id = idv;
875
876   if (use_flag_from_idtag) {
877     if ((id->tag & LIB_TAG_NO_MAIN) != 0) {
878       flag |= LIB_ID_FREE_NO_MAIN | LIB_ID_FREE_NO_UI_USER | LIB_ID_FREE_NO_DEG_TAG;
879     }
880     else {
881       flag &= ~LIB_ID_FREE_NO_MAIN;
882     }
883
884     if ((id->tag & LIB_TAG_NO_USER_REFCOUNT) != 0) {
885       flag |= LIB_ID_FREE_NO_USER_REFCOUNT;
886     }
887     else {
888       flag &= ~LIB_ID_FREE_NO_USER_REFCOUNT;
889     }
890
891     if ((id->tag & LIB_TAG_NOT_ALLOCATED) != 0) {
892       flag |= LIB_ID_FREE_NOT_ALLOCATED;
893     }
894     else {
895       flag &= ~LIB_ID_FREE_NOT_ALLOCATED;
896     }
897   }
898
899   BLI_assert((flag & LIB_ID_FREE_NO_MAIN) != 0 || bmain != NULL);
900   BLI_assert((flag & LIB_ID_FREE_NO_MAIN) != 0 || (flag & LIB_ID_FREE_NOT_ALLOCATED) == 0);
901   BLI_assert((flag & LIB_ID_FREE_NO_MAIN) != 0 || (flag & LIB_ID_FREE_NO_USER_REFCOUNT) == 0);
902
903   const short type = GS(id->name);
904
905   if (bmain && (flag & LIB_ID_FREE_NO_DEG_TAG) == 0) {
906     DEG_id_type_tag(bmain, type);
907   }
908
909 #ifdef WITH_PYTHON
910 #  ifdef WITH_PYTHON_SAFETY
911   BPY_id_release(id);
912 #  endif
913   if (id->py_instance) {
914     BPY_DECREF_RNA_INVALIDATE(id->py_instance);
915   }
916 #endif
917
918   if ((flag & LIB_ID_FREE_NO_USER_REFCOUNT) == 0) {
919     BKE_libblock_relink_ex(bmain, id, NULL, NULL, true);
920   }
921
922   BKE_libblock_free_datablock(id, flag);
923
924   /* avoid notifying on removed data */
925   if ((flag & LIB_ID_FREE_NO_MAIN) == 0) {
926     BKE_main_lock(bmain);
927   }
928
929   if ((flag & LIB_ID_FREE_NO_UI_USER) == 0) {
930     if (free_notifier_reference_cb) {
931       free_notifier_reference_cb(id);
932     }
933
934     if (remap_editor_id_reference_cb) {
935       remap_editor_id_reference_cb(id, NULL);
936     }
937   }
938
939   if ((flag & LIB_ID_FREE_NO_MAIN) == 0) {
940     ListBase *lb = which_libbase(bmain, type);
941     BLI_remlink(lb, id);
942   }
943
944   BKE_libblock_free_data(id, (flag & LIB_ID_FREE_NO_USER_REFCOUNT) == 0);
945
946   if ((flag & LIB_ID_FREE_NO_MAIN) == 0) {
947     BKE_main_unlock(bmain);
948   }
949
950   if ((flag & LIB_ID_FREE_NOT_ALLOCATED) == 0) {
951     MEM_freeN(id);
952   }
953 }
954
955 /**
956  * Complete ID freeing, should be usable in most cases (even for out-of-Main IDs).
957  *
958  * See #BKE_id_free_ex description for full details.
959  *
960  * \param bmain: Main database containing the freed ID, can be NULL in case it's a temp ID outside of any Main.
961  * \param idv: Pointer to ID to be freed.
962  */
963 void BKE_id_free(Main *bmain, void *idv)
964 {
965   BKE_id_free_ex(bmain, idv, 0, true);
966 }
967
968 /**
969  * Not really a freeing function by itself, it decrements usercount of given id, and only frees it if it reaches 0.
970  */
971 void BKE_id_free_us(Main *bmain, void *idv) /* test users */
972 {
973   ID *id = idv;
974
975   id_us_min(id);
976
977   /* XXX This is a temp (2.77) hack so that we keep same behavior as in 2.76 regarding collections when deleting an object.
978    *     Since only 'user_one' usage of objects is collections, and only 'real user' usage of objects is scenes,
979    *     removing that 'user_one' tag when there is no more real (scene) users of an object ensures it gets
980    *     fully unlinked.
981    *     But only for local objects, not linked ones!
982    *     Otherwise, there is no real way to get rid of an object anymore - better handling of this is TODO.
983    */
984   if ((GS(id->name) == ID_OB) && (id->us == 1) && (id->lib == NULL)) {
985     id_us_clear_real(id);
986   }
987
988   if (id->us == 0) {
989     BKE_libblock_unlink(bmain, id, false, false);
990
991     BKE_id_free(bmain, id);
992   }
993 }
994
995 static void id_delete(Main *bmain, const bool do_tagged_deletion)
996 {
997   const int tag = LIB_TAG_DOIT;
998   ListBase *lbarray[MAX_LIBARRAY];
999   Link dummy_link = {0};
1000   int base_count, i;
1001
1002   /* Used by batch tagged deletion, when we call BKE_id_free then, id is no more in Main database,
1003    * and has already properly unlinked its other IDs usages.
1004    * UI users are always cleared in BKE_libblock_remap_locked() call, so we can always skip it. */
1005   const int free_flag = LIB_ID_FREE_NO_UI_USER |
1006                         (do_tagged_deletion ? LIB_ID_FREE_NO_MAIN | LIB_ID_FREE_NO_USER_REFCOUNT :
1007                                               0);
1008   ListBase tagged_deleted_ids = {NULL};
1009
1010   base_count = set_listbasepointers(bmain, lbarray);
1011
1012   BKE_main_lock(bmain);
1013   if (do_tagged_deletion) {
1014     /* Main idea of batch deletion is to remove all IDs to be deleted from Main database.
1015      * This means that we won't have to loop over all deleted IDs to remove usages
1016      * of other deleted IDs.
1017      * This gives tremendous speed-up when deleting a large amount of IDs from a Main
1018      * containing thousands of those.
1019      * This also means that we have to be very careful here, as we by-pass many 'common'
1020      * processing, hence risking to 'corrupt' at least user counts, if not IDs themselves. */
1021     bool keep_looping = true;
1022     while (keep_looping) {
1023       ID *id, *id_next;
1024       ID *last_remapped_id = tagged_deleted_ids.last;
1025       keep_looping = false;
1026
1027       /* First tag and remove from Main all datablocks directly from target lib.
1028        * Note that we go forward here, since we want to check dependencies before users
1029        * (e.g. meshes before objects). Avoids to have to loop twice. */
1030       for (i = 0; i < base_count; i++) {
1031         ListBase *lb = lbarray[i];
1032
1033         for (id = lb->first; id; id = id_next) {
1034           id_next = id->next;
1035           /* Note: in case we delete a library, we also delete all its datablocks! */
1036           if ((id->tag & tag) || (id->lib != NULL && (id->lib->id.tag & tag))) {
1037             BLI_remlink(lb, id);
1038             BLI_addtail(&tagged_deleted_ids, id);
1039             /* Do not tag as no_main now, we want to unlink it first (lower-level ID management code
1040              * has some specific handling of 'nom main' IDs that would be a problem in that case). */
1041             id->tag |= tag;
1042             keep_looping = true;
1043           }
1044         }
1045       }
1046       if (last_remapped_id == NULL) {
1047         dummy_link.next = tagged_deleted_ids.first;
1048         last_remapped_id = (ID *)(&dummy_link);
1049       }
1050       for (id = last_remapped_id->next; id; id = id->next) {
1051         /* Will tag 'never NULL' users of this ID too.
1052          * Note that we cannot use BKE_libblock_unlink() here, since it would ignore indirect (and proxy!)
1053          * links, this can lead to nasty crashing here in second, actual deleting loop.
1054          * Also, this will also flag users of deleted data that cannot be unlinked
1055          * (object using deleted obdata, etc.), so that they also get deleted. */
1056         BKE_libblock_remap_locked(
1057             bmain, id, NULL, ID_REMAP_FLAG_NEVER_NULL_USAGE | ID_REMAP_FORCE_NEVER_NULL_USAGE);
1058         /* Since we removed ID from Main, we also need to unlink its own other IDs usages ourself. */
1059         BKE_libblock_relink_ex(bmain, id, NULL, NULL, true);
1060         /* Now we can safely mark that ID as not being in Main database anymore. */
1061         id->tag |= LIB_TAG_NO_MAIN;
1062         /* This is needed because we may not have remapped usages of that ID by other deleted ones. */
1063         //              id->us = 0;  /* Is it actually? */
1064       }
1065     }
1066   }
1067   else {
1068     /* First tag all datablocks directly from target lib.
1069      * Note that we go forward here, since we want to check dependencies before users (e.g. meshes before objects).
1070      * Avoids to have to loop twice. */
1071     for (i = 0; i < base_count; i++) {
1072       ListBase *lb = lbarray[i];
1073       ID *id, *id_next;
1074
1075       for (id = lb->first; id; id = id_next) {
1076         id_next = id->next;
1077         /* Note: in case we delete a library, we also delete all its datablocks! */
1078         if ((id->tag & tag) || (id->lib != NULL && (id->lib->id.tag & tag))) {
1079           id->tag |= tag;
1080
1081           /* Will tag 'never NULL' users of this ID too.
1082            * Note that we cannot use BKE_libblock_unlink() here, since it would ignore indirect (and proxy!)
1083            * links, this can lead to nasty crashing here in second, actual deleting loop.
1084            * Also, this will also flag users of deleted data that cannot be unlinked
1085            * (object using deleted obdata, etc.), so that they also get deleted. */
1086           BKE_libblock_remap_locked(
1087               bmain, id, NULL, ID_REMAP_FLAG_NEVER_NULL_USAGE | ID_REMAP_FORCE_NEVER_NULL_USAGE);
1088         }
1089       }
1090     }
1091   }
1092   BKE_main_unlock(bmain);
1093
1094   /* In usual reversed order, such that all usage of a given ID, even 'never NULL' ones, have been already cleared
1095    * when we reach it (e.g. Objects being processed before meshes, they'll have already released their 'reference'
1096    * over meshes when we come to freeing obdata). */
1097   for (i = do_tagged_deletion ? 1 : base_count; i--;) {
1098     ListBase *lb = lbarray[i];
1099     ID *id, *id_next;
1100
1101     for (id = do_tagged_deletion ? tagged_deleted_ids.first : lb->first; id; id = id_next) {
1102       id_next = id->next;
1103       if (id->tag & tag) {
1104         if (id->us != 0) {
1105 #ifdef DEBUG_PRINT
1106           printf("%s: deleting %s (%d)\n", __func__, id->name, id->us);
1107 #endif
1108           BLI_assert(id->us == 0);
1109         }
1110         BKE_id_free_ex(bmain, id, free_flag, !do_tagged_deletion);
1111       }
1112     }
1113   }
1114
1115   bmain->is_memfile_undo_written = false;
1116 }
1117
1118 /**
1119  * Properly delete a single ID from given \a bmain database.
1120  */
1121 void BKE_id_delete(Main *bmain, void *idv)
1122 {
1123   BKE_main_id_tag_all(bmain, LIB_TAG_DOIT, false);
1124   ((ID *)idv)->tag |= LIB_TAG_DOIT;
1125
1126   id_delete(bmain, false);
1127 }
1128
1129 /**
1130  * Properly delete all IDs tagged with \a LIB_TAG_DOIT, in given \a bmain database.
1131  *
1132  * This is more efficient than calling #BKE_id_delete repetitively on a large set of IDs
1133  * (several times faster when deleting most of the IDs at once)...
1134  *
1135  * \warning Considered experimental for now, seems to be working OK but this is
1136  *          risky code in a complicated area.
1137  */
1138 void BKE_id_multi_tagged_delete(Main *bmain)
1139 {
1140   id_delete(bmain, true);
1141 }