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