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