Merge branch 'blender2.7'
[blender.git] / source / blender / blenkernel / BKE_library_remap.h
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 #ifndef __BKE_LIBRARY_REMAP_H__
17 #define __BKE_LIBRARY_REMAP_H__
18
19 /** \file
20  * \ingroup bke
21  */
22 #ifdef __cplusplus
23 extern "C" {
24 #endif
25
26 #include "BLI_compiler_attrs.h"
27
28 /* BKE_libblock_free, delete are declared in BKE_library.h for convenience. */
29
30 /* Also IDRemap->flag. */
31 enum {
32         /* Do not remap indirect usages of IDs (that is, when user is some linked data). */
33         ID_REMAP_SKIP_INDIRECT_USAGE    = 1 << 0,
34         /* This flag should always be set, *except for 'unlink' scenarios* (only relevant when new_id == NULL).
35          * Basically, when unset, NEVER_NULL ID usages will keep pointing to old_id, but (if needed) old_id user count
36          * will still be decremented. This is mandatory for 'delete ID' case, but in all other situation this would lead
37          * to invalid user counts! */
38         ID_REMAP_SKIP_NEVER_NULL_USAGE  = 1 << 1,
39         /* This tells the callback func to flag with LIB_DOIT all IDs using target one with a 'never NULL' pointer
40          * (like e.g. Object->data). */
41         ID_REMAP_FLAG_NEVER_NULL_USAGE  = 1 << 2,
42         /* This tells the callback func to force setting IDs using target one with a 'never NULL' pointer to NULL.
43          * WARNING! Use with extreme care, this will leave database in broken state and can cause crashes very easily! */
44         ID_REMAP_FORCE_NEVER_NULL_USAGE = 1 << 3,
45         /* Do not consider proxy/_group pointers of local objects as indirect usages...
46          * Our oh-so-beloved proxies again... Do not consider data used by local proxy object as indirect usage.
47          * This is needed e.g. in reload scenario, since we have to ensure remapping of Armature data of local proxy
48          * is also performed. Usual nightmare... */
49         ID_REMAP_NO_INDIRECT_PROXY_DATA_USAGE = 1 << 4,
50         /* Do not remap static override pointers. */
51         ID_REMAP_SKIP_STATIC_OVERRIDE = 1 << 5,
52 };
53
54 /* Note: Requiring new_id to be non-null, this *may* not be the case ultimately, but makes things simpler for now. */
55 void BKE_libblock_remap_locked(
56         struct Main *bmain, void *old_idv, void *new_idv,
57         const short remap_flags) ATTR_NONNULL(1, 2);
58 void BKE_libblock_remap(
59         struct Main *bmain, void *old_idv, void *new_idv,
60         const short remap_flags) ATTR_NONNULL(1, 2);
61
62 void BKE_libblock_unlink(
63         struct Main *bmain, void *idv,
64         const bool do_flag_never_null, const bool do_skip_indirect) ATTR_NONNULL();
65
66 void BKE_libblock_relink_ex(
67         struct Main *bmain, void *idv, void *old_idv, void *new_idv,
68         const bool us_min_never_null) ATTR_NONNULL(1, 2);
69
70 void  BKE_libblock_relink_to_newid(struct ID *id) ATTR_NONNULL();
71
72 typedef void (*BKE_library_free_window_manager_cb)(struct bContext *, struct wmWindowManager *);
73 typedef void (*BKE_library_free_notifier_reference_cb)(const void *);
74 typedef void (*BKE_library_remap_editor_id_reference_cb)(struct ID *, struct ID *);
75
76 void BKE_library_callback_free_window_manager_set(BKE_library_free_window_manager_cb func);
77 void BKE_library_callback_free_notifier_reference_set(BKE_library_free_notifier_reference_cb func);
78 void BKE_library_callback_remap_editor_id_reference_set(BKE_library_remap_editor_id_reference_cb func);
79
80 #ifdef __cplusplus
81 }
82 #endif
83
84 #endif  /* __BKE_LIBRARY_REMAP_H__ */