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