Merge branch 'blender-v2.82-release'
[blender.git] / source / blender / blenkernel / intern / lib_id_delete.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 for freeing & deletion.
21  */
22
23 #include "CLG_log.h"
24
25 #include "MEM_guardedalloc.h"
26
27 /* all types are needed here, in order to do memory operations */
28 #include "DNA_anim_types.h"
29 #include "DNA_armature_types.h"
30 #include "DNA_brush_types.h"
31 #include "DNA_camera_types.h"
32 #include "DNA_cachefile_types.h"
33 #include "DNA_collection_types.h"
34 #include "DNA_gpencil_types.h"
35 #include "DNA_ipo_types.h"
36 #include "DNA_key_types.h"
37 #include "DNA_light_types.h"
38 #include "DNA_lattice_types.h"
39 #include "DNA_linestyle_types.h"
40 #include "DNA_material_types.h"
41 #include "DNA_mesh_types.h"
42 #include "DNA_meta_types.h"
43 #include "DNA_movieclip_types.h"
44 #include "DNA_mask_types.h"
45 #include "DNA_node_types.h"
46 #include "DNA_object_types.h"
47 #include "DNA_lightprobe_types.h"
48 #include "DNA_scene_types.h"
49 #include "DNA_screen_types.h"
50 #include "DNA_speaker_types.h"
51 #include "DNA_sound_types.h"
52 #include "DNA_text_types.h"
53 #include "DNA_vfont_types.h"
54 #include "DNA_windowmanager_types.h"
55 #include "DNA_workspace_types.h"
56 #include "DNA_world_types.h"
57
58 #include "BLI_utildefines.h"
59
60 #include "BLI_listbase.h"
61
62 #include "BKE_action.h"
63 #include "BKE_armature.h"
64 #include "BKE_brush.h"
65 #include "BKE_camera.h"
66 #include "BKE_cachefile.h"
67 #include "BKE_collection.h"
68 #include "BKE_curve.h"
69 #include "BKE_fcurve.h"
70 #include "BKE_font.h"
71 #include "BKE_gpencil.h"
72 #include "BKE_idprop.h"
73 #include "BKE_image.h"
74 #include "BKE_ipo.h"
75 #include "BKE_key.h"
76 #include "BKE_light.h"
77 #include "BKE_lattice.h"
78 #include "BKE_lib_id.h"
79 #include "BKE_lib_override.h"
80 #include "BKE_lib_remap.h"
81 #include "BKE_linestyle.h"
82 #include "BKE_mesh.h"
83 #include "BKE_material.h"
84 #include "BKE_main.h"
85 #include "BKE_mask.h"
86 #include "BKE_mball.h"
87 #include "BKE_movieclip.h"
88 #include "BKE_node.h"
89 #include "BKE_object.h"
90 #include "BKE_paint.h"
91 #include "BKE_particle.h"
92 #include "BKE_lightprobe.h"
93 #include "BKE_speaker.h"
94 #include "BKE_sound.h"
95 #include "BKE_screen.h"
96 #include "BKE_scene.h"
97 #include "BKE_text.h"
98 #include "BKE_texture.h"
99 #include "BKE_workspace.h"
100 #include "BKE_world.h"
101
102 #include "lib_intern.h"
103
104 #include "DEG_depsgraph.h"
105
106 #ifdef WITH_PYTHON
107 #  include "BPY_extern.h"
108 #endif
109
110 /* Not used currently. */
111 // static CLG_LogRef LOG = {.identifier = "bke.lib.id.delete"};
112
113 void BKE_libblock_free_data(ID *id, const bool do_id_user)
114 {
115   if (id->properties) {
116     IDP_FreePropertyContent_ex(id->properties, do_id_user);
117     MEM_freeN(id->properties);
118   }
119
120   if (id->override_library) {
121     BKE_override_library_free(&id->override_library, do_id_user);
122   }
123
124   /* XXX TODO remove animdata handling from each type's freeing func,
125    * and do it here, like for copy! */
126 }
127
128 void BKE_libblock_free_datablock(ID *id, const int UNUSED(flag))
129 {
130   const short type = GS(id->name);
131   switch (type) {
132     case ID_SCE:
133       BKE_scene_free_ex((Scene *)id, false);
134       break;
135     case ID_LI:
136       BKE_library_free((Library *)id);
137       break;
138     case ID_OB:
139       BKE_object_free((Object *)id);
140       break;
141     case ID_ME:
142       BKE_mesh_free((Mesh *)id);
143       break;
144     case ID_CU:
145       BKE_curve_free((Curve *)id);
146       break;
147     case ID_MB:
148       BKE_mball_free((MetaBall *)id);
149       break;
150     case ID_MA:
151       BKE_material_free((Material *)id);
152       break;
153     case ID_TE:
154       BKE_texture_free((Tex *)id);
155       break;
156     case ID_IM:
157       BKE_image_free((Image *)id);
158       break;
159     case ID_LT:
160       BKE_lattice_free((Lattice *)id);
161       break;
162     case ID_LA:
163       BKE_light_free((Light *)id);
164       break;
165     case ID_CA:
166       BKE_camera_free((Camera *)id);
167       break;
168     case ID_IP: /* Deprecated. */
169       BKE_ipo_free((Ipo *)id);
170       break;
171     case ID_KE:
172       BKE_key_free((Key *)id);
173       break;
174     case ID_WO:
175       BKE_world_free((World *)id);
176       break;
177     case ID_SCR:
178       BKE_screen_free((bScreen *)id);
179       break;
180     case ID_VF:
181       BKE_vfont_free((VFont *)id);
182       break;
183     case ID_TXT:
184       BKE_text_free((Text *)id);
185       break;
186     case ID_SPK:
187       BKE_speaker_free((Speaker *)id);
188       break;
189     case ID_LP:
190       BKE_lightprobe_free((LightProbe *)id);
191       break;
192     case ID_SO:
193       BKE_sound_free((bSound *)id);
194       break;
195     case ID_GR:
196       BKE_collection_free((Collection *)id);
197       break;
198     case ID_AR:
199       BKE_armature_free((bArmature *)id);
200       break;
201     case ID_AC:
202       BKE_action_free((bAction *)id);
203       break;
204     case ID_NT:
205       ntreeFreeTree((bNodeTree *)id);
206       break;
207     case ID_BR:
208       BKE_brush_free((Brush *)id);
209       break;
210     case ID_PA:
211       BKE_particlesettings_free((ParticleSettings *)id);
212       break;
213     case ID_WM:
214       if (free_windowmanager_cb) {
215         free_windowmanager_cb(NULL, (wmWindowManager *)id);
216       }
217       break;
218     case ID_GD:
219       BKE_gpencil_free((bGPdata *)id, true);
220       break;
221     case ID_MC:
222       BKE_movieclip_free((MovieClip *)id);
223       break;
224     case ID_MSK:
225       BKE_mask_free((Mask *)id);
226       break;
227     case ID_LS:
228       BKE_linestyle_free((FreestyleLineStyle *)id);
229       break;
230     case ID_PAL:
231       BKE_palette_free((Palette *)id);
232       break;
233     case ID_PC:
234       BKE_paint_curve_free((PaintCurve *)id);
235       break;
236     case ID_CF:
237       BKE_cachefile_free((CacheFile *)id);
238       break;
239     case ID_WS:
240       BKE_workspace_free((WorkSpace *)id);
241       break;
242   }
243 }
244
245 /**
246  * Complete ID freeing, extended version for corner cases.
247  * Can override default (and safe!) freeing process, to gain some speed up.
248  *
249  * At that point, given id is assumed to not be used by any other data-block already
250  * (might not be actually true, in case e.g. several inter-related IDs get freed together...).
251  * However, they might still be using (referencing) other IDs, this code takes care of it if
252  * #LIB_TAG_NO_USER_REFCOUNT is not defined.
253  *
254  * \param bmain: #Main database containing the freed #ID,
255  * can be NULL in case it's a temp ID outside of any #Main.
256  * \param idv: Pointer to ID to be freed.
257  * \param flag: Set of \a LIB_ID_FREE_... flags controlling/overriding usual freeing process,
258  * 0 to get default safe behavior.
259  * \param use_flag_from_idtag: Still use freeing info flags from given #ID datablock,
260  * even if some overriding ones are passed in \a flag parameter.
261  */
262 void BKE_id_free_ex(Main *bmain, void *idv, int flag, const bool use_flag_from_idtag)
263 {
264   ID *id = idv;
265
266   if (use_flag_from_idtag) {
267     if ((id->tag & LIB_TAG_NO_MAIN) != 0) {
268       flag |= LIB_ID_FREE_NO_MAIN | LIB_ID_FREE_NO_UI_USER | LIB_ID_FREE_NO_DEG_TAG;
269     }
270     else {
271       flag &= ~LIB_ID_FREE_NO_MAIN;
272     }
273
274     if ((id->tag & LIB_TAG_NO_USER_REFCOUNT) != 0) {
275       flag |= LIB_ID_FREE_NO_USER_REFCOUNT;
276     }
277     else {
278       flag &= ~LIB_ID_FREE_NO_USER_REFCOUNT;
279     }
280
281     if ((id->tag & LIB_TAG_NOT_ALLOCATED) != 0) {
282       flag |= LIB_ID_FREE_NOT_ALLOCATED;
283     }
284     else {
285       flag &= ~LIB_ID_FREE_NOT_ALLOCATED;
286     }
287   }
288
289   BLI_assert((flag & LIB_ID_FREE_NO_MAIN) != 0 || bmain != NULL);
290   BLI_assert((flag & LIB_ID_FREE_NO_MAIN) != 0 || (flag & LIB_ID_FREE_NOT_ALLOCATED) == 0);
291   BLI_assert((flag & LIB_ID_FREE_NO_MAIN) != 0 || (flag & LIB_ID_FREE_NO_USER_REFCOUNT) == 0);
292
293   const short type = GS(id->name);
294
295   if (bmain && (flag & LIB_ID_FREE_NO_DEG_TAG) == 0) {
296     DEG_id_type_tag(bmain, type);
297   }
298
299 #ifdef WITH_PYTHON
300 #  ifdef WITH_PYTHON_SAFETY
301   BPY_id_release(id);
302 #  endif
303   if (id->py_instance) {
304     BPY_DECREF_RNA_INVALIDATE(id->py_instance);
305   }
306 #endif
307
308   if ((flag & LIB_ID_FREE_NO_USER_REFCOUNT) == 0) {
309     BKE_libblock_relink_ex(bmain, id, NULL, NULL, 0);
310   }
311
312   BKE_libblock_free_datablock(id, flag);
313
314   /* avoid notifying on removed data */
315   if ((flag & LIB_ID_FREE_NO_MAIN) == 0) {
316     BKE_main_lock(bmain);
317   }
318
319   if ((flag & LIB_ID_FREE_NO_UI_USER) == 0) {
320     if (free_notifier_reference_cb) {
321       free_notifier_reference_cb(id);
322     }
323
324     if (remap_editor_id_reference_cb) {
325       remap_editor_id_reference_cb(id, NULL);
326     }
327   }
328
329   if ((flag & LIB_ID_FREE_NO_MAIN) == 0) {
330     ListBase *lb = which_libbase(bmain, type);
331     BLI_remlink(lb, id);
332   }
333
334   BKE_libblock_free_data(id, (flag & LIB_ID_FREE_NO_USER_REFCOUNT) == 0);
335
336   if ((flag & LIB_ID_FREE_NO_MAIN) == 0) {
337     BKE_main_unlock(bmain);
338   }
339
340   if ((flag & LIB_ID_FREE_NOT_ALLOCATED) == 0) {
341     MEM_freeN(id);
342   }
343 }
344
345 /**
346  * Complete ID freeing, should be usable in most cases (even for out-of-Main IDs).
347  *
348  * See #BKE_id_free_ex description for full details.
349  *
350  * \param bmain: Main database containing the freed ID,
351  * can be NULL in case it's a temp ID outside of any Main.
352  * \param idv: Pointer to ID to be freed.
353  */
354 void BKE_id_free(Main *bmain, void *idv)
355 {
356   BKE_id_free_ex(bmain, idv, 0, true);
357 }
358
359 /**
360  * Not really a freeing function by itself,
361  * it decrements usercount of given id, and only frees it if it reaches 0.
362  */
363 void BKE_id_free_us(Main *bmain, void *idv) /* test users */
364 {
365   ID *id = idv;
366
367   id_us_min(id);
368
369   /* XXX This is a temp (2.77) hack so that we keep same behavior as in 2.76 regarding collections
370    *     when deleting an object. Since only 'user_one' usage of objects is collections,
371    *     and only 'real user' usage of objects is scenes, removing that 'user_one' tag when there
372    *     is no more real (scene) users of an object ensures it gets fully unlinked.
373    *     But only for local objects, not linked ones!
374    *     Otherwise, there is no real way to get rid of an object anymore -
375    *     better handling of this is TODO.
376    */
377   if ((GS(id->name) == ID_OB) && (id->us == 1) && (id->lib == NULL)) {
378     id_us_clear_real(id);
379   }
380
381   if (id->us == 0) {
382     BKE_libblock_unlink(bmain, id, false, false);
383
384     BKE_id_free(bmain, id);
385   }
386 }
387
388 static void id_delete(Main *bmain, const bool do_tagged_deletion)
389 {
390   const int tag = LIB_TAG_DOIT;
391   ListBase *lbarray[MAX_LIBARRAY];
392   Link dummy_link = {0};
393   int base_count, i;
394
395   /* Used by batch tagged deletion, when we call BKE_id_free then, id is no more in Main database,
396    * and has already properly unlinked its other IDs usages.
397    * UI users are always cleared in BKE_libblock_remap_locked() call, so we can always skip it. */
398   const int free_flag = LIB_ID_FREE_NO_UI_USER |
399                         (do_tagged_deletion ? LIB_ID_FREE_NO_MAIN | LIB_ID_FREE_NO_USER_REFCOUNT :
400                                               0);
401   ListBase tagged_deleted_ids = {NULL};
402
403   base_count = set_listbasepointers(bmain, lbarray);
404
405   BKE_main_lock(bmain);
406   if (do_tagged_deletion) {
407     /* Main idea of batch deletion is to remove all IDs to be deleted from Main database.
408      * This means that we won't have to loop over all deleted IDs to remove usages
409      * of other deleted IDs.
410      * This gives tremendous speed-up when deleting a large amount of IDs from a Main
411      * containing thousands of those.
412      * This also means that we have to be very careful here, as we by-pass many 'common'
413      * processing, hence risking to 'corrupt' at least user counts, if not IDs themselves. */
414     bool keep_looping = true;
415     while (keep_looping) {
416       ID *id, *id_next;
417       ID *last_remapped_id = tagged_deleted_ids.last;
418       keep_looping = false;
419
420       /* First tag and remove from Main all datablocks directly from target lib.
421        * Note that we go forward here, since we want to check dependencies before users
422        * (e.g. meshes before objects). Avoids to have to loop twice. */
423       for (i = 0; i < base_count; i++) {
424         ListBase *lb = lbarray[i];
425
426         for (id = lb->first; id; id = id_next) {
427           id_next = id->next;
428           /* Note: in case we delete a library, we also delete all its datablocks! */
429           if ((id->tag & tag) || (id->lib != NULL && (id->lib->id.tag & tag))) {
430             BLI_remlink(lb, id);
431             BLI_addtail(&tagged_deleted_ids, id);
432             /* Do not tag as no_main now, we want to unlink it first (lower-level ID management
433              * code has some specific handling of 'nom main'
434              * IDs that would be a problem in that case). */
435             id->tag |= tag;
436             keep_looping = true;
437           }
438         }
439       }
440       if (last_remapped_id == NULL) {
441         dummy_link.next = tagged_deleted_ids.first;
442         last_remapped_id = (ID *)(&dummy_link);
443       }
444       for (id = last_remapped_id->next; id; id = id->next) {
445         /* Will tag 'never NULL' users of this ID too.
446          * Note that we cannot use BKE_libblock_unlink() here,
447          * since it would ignore indirect (and proxy!)
448          * links, this can lead to nasty crashing here in second, actual deleting loop.
449          * Also, this will also flag users of deleted data that cannot be unlinked
450          * (object using deleted obdata, etc.), so that they also get deleted. */
451         BKE_libblock_remap_locked(
452             bmain, id, NULL, ID_REMAP_FLAG_NEVER_NULL_USAGE | ID_REMAP_FORCE_NEVER_NULL_USAGE);
453         /* Since we removed ID from Main,
454          * we also need to unlink its own other IDs usages ourself. */
455         BKE_libblock_relink_ex(bmain, id, NULL, NULL, 0);
456         /* Now we can safely mark that ID as not being in Main database anymore. */
457         id->tag |= LIB_TAG_NO_MAIN;
458         /* This is needed because we may not have remapped usages
459          * of that ID by other deleted ones. */
460         // id->us = 0;  /* Is it actually? */
461       }
462     }
463   }
464   else {
465     /* First tag all datablocks directly from target lib.
466      * Note that we go forward here, since we want to check dependencies before users
467      * (e.g. meshes before objects).
468      * Avoids to have to loop twice. */
469     for (i = 0; i < base_count; i++) {
470       ListBase *lb = lbarray[i];
471       ID *id, *id_next;
472
473       for (id = lb->first; id; id = id_next) {
474         id_next = id->next;
475         /* Note: in case we delete a library, we also delete all its datablocks! */
476         if ((id->tag & tag) || (id->lib != NULL && (id->lib->id.tag & tag))) {
477           id->tag |= tag;
478
479           /* Will tag 'never NULL' users of this ID too.
480            * Note that we cannot use BKE_libblock_unlink() here, since it would ignore indirect
481            * (and proxy!) links, this can lead to nasty crashing here in second,
482            * actual deleting loop.
483            * Also, this will also flag users of deleted data that cannot be unlinked
484            * (object using deleted obdata, etc.), so that they also get deleted. */
485           BKE_libblock_remap_locked(
486               bmain, id, NULL, ID_REMAP_FLAG_NEVER_NULL_USAGE | ID_REMAP_FORCE_NEVER_NULL_USAGE);
487         }
488       }
489     }
490   }
491   BKE_main_unlock(bmain);
492
493   /* In usual reversed order, such that all usage of a given ID, even 'never NULL' ones,
494    * have been already cleared when we reach it
495    * (e.g. Objects being processed before meshes, they'll have already released their 'reference'
496    * over meshes when we come to freeing obdata). */
497   for (i = do_tagged_deletion ? 1 : base_count; i--;) {
498     ListBase *lb = lbarray[i];
499     ID *id, *id_next;
500
501     for (id = do_tagged_deletion ? tagged_deleted_ids.first : lb->first; id; id = id_next) {
502       id_next = id->next;
503       if (id->tag & tag) {
504         if (id->us != 0) {
505 #ifdef DEBUG_PRINT
506           printf("%s: deleting %s (%d)\n", __func__, id->name, id->us);
507 #endif
508           BLI_assert(id->us == 0);
509         }
510         BKE_id_free_ex(bmain, id, free_flag, !do_tagged_deletion);
511       }
512     }
513   }
514
515   bmain->is_memfile_undo_written = false;
516 }
517
518 /**
519  * Properly delete a single ID from given \a bmain database.
520  */
521 void BKE_id_delete(Main *bmain, void *idv)
522 {
523   BKE_main_id_tag_all(bmain, LIB_TAG_DOIT, false);
524   ((ID *)idv)->tag |= LIB_TAG_DOIT;
525
526   id_delete(bmain, false);
527 }
528
529 /**
530  * Properly delete all IDs tagged with \a LIB_TAG_DOIT, in given \a bmain database.
531  *
532  * This is more efficient than calling #BKE_id_delete repetitively on a large set of IDs
533  * (several times faster when deleting most of the IDs at once)...
534  *
535  * \warning Considered experimental for now, seems to be working OK but this is
536  *          risky code in a complicated area.
537  */
538 void BKE_id_multi_tagged_delete(Main *bmain)
539 {
540   id_delete(bmain, true);
541 }