Merge branch 'blender2.7'
[blender.git] / source / blender / blenkernel / BKE_library_remap.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * ***** END GPL LICENSE BLOCK *****
19  */
20 #ifndef __BKE_LIBRARY_REMAP_H__
21 #define __BKE_LIBRARY_REMAP_H__
22
23 /** \file BKE_library_remap.h
24  *  \ingroup bke
25  */
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29
30 #include "BLI_compiler_attrs.h"
31
32 /* BKE_libblock_free, delete are declared in BKE_library.h for convenience. */
33
34 /* Also IDRemap->flag. */
35 enum {
36         /* Do not remap indirect usages of IDs (that is, when user is some linked data). */
37         ID_REMAP_SKIP_INDIRECT_USAGE    = 1 << 0,
38         /* This flag should always be set, *except for 'unlink' scenarios* (only relevant when new_id == NULL).
39          * Basically, when unset, NEVER_NULL ID usages will keep pointing to old_id, but (if needed) old_id user count
40          * will still be decremented. This is mandatory for 'delete ID' case, but in all other situation this would lead
41          * to invalid user counts! */
42         ID_REMAP_SKIP_NEVER_NULL_USAGE  = 1 << 1,
43         /* This tells the callback func to flag with LIB_DOIT all IDs using target one with a 'never NULL' pointer
44          * (like e.g. Object->data). */
45         ID_REMAP_FLAG_NEVER_NULL_USAGE  = 1 << 2,
46         /* This tells the callback func to force setting IDs using target one with a 'never NULL' pointer to NULL.
47          * WARNING! Use with extreme care, this will leave database in broken state and can cause crashes very easily! */
48         ID_REMAP_FORCE_NEVER_NULL_USAGE = 1 << 3,
49         /* Do not consider proxy/_group pointers of local objects as indirect usages...
50          * Our oh-so-beloved proxies again... Do not consider data used by local proxy object as indirect usage.
51          * This is needed e.g. in reload scenario, since we have to ensure remapping of Armature data of local proxy
52          * is also performed. Usual nightmare... */
53         ID_REMAP_NO_INDIRECT_PROXY_DATA_USAGE = 1 << 4,
54         /* Do not remap static override pointers. */
55         ID_REMAP_SKIP_STATIC_OVERRIDE = 1 << 5,
56 };
57
58 /* Note: Requiring new_id to be non-null, this *may* not be the case ultimately, but makes things simpler for now. */
59 void BKE_libblock_remap_locked(
60         struct Main *bmain, void *old_idv, void *new_idv,
61         const short remap_flags) ATTR_NONNULL(1, 2);
62 void BKE_libblock_remap(
63         struct Main *bmain, void *old_idv, void *new_idv,
64         const short remap_flags) ATTR_NONNULL(1, 2);
65
66 void BKE_libblock_unlink(
67         struct Main *bmain, void *idv,
68         const bool do_flag_never_null, const bool do_skip_indirect) ATTR_NONNULL();
69
70 void BKE_libblock_relink_ex(
71         struct Main *bmain, void *idv, void *old_idv, void *new_idv,
72         const bool us_min_never_null) ATTR_NONNULL(1, 2);
73
74 void  BKE_libblock_relink_to_newid(struct ID *id) ATTR_NONNULL();
75
76 typedef void (*BKE_library_free_window_manager_cb)(struct bContext *, struct wmWindowManager *);
77 typedef void (*BKE_library_free_notifier_reference_cb)(const void *);
78 typedef void (*BKE_library_remap_editor_id_reference_cb)(struct ID *, struct ID *);
79
80 void BKE_library_callback_free_window_manager_set(BKE_library_free_window_manager_cb func);
81 void BKE_library_callback_free_notifier_reference_set(BKE_library_free_notifier_reference_cb func);
82 void BKE_library_callback_remap_editor_id_reference_set(BKE_library_remap_editor_id_reference_cb func);
83
84 #ifdef __cplusplus
85 }
86 #endif
87
88 #endif  /* __BKE_LIBRARY_REMAP_H__ */