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