Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / BKE_library.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  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27 #ifndef __BKE_LIBRARY_H__
28 #define __BKE_LIBRARY_H__
29
30 /** \file BKE_library.h
31  *  \ingroup bke
32  *  \since March 2001
33  *  \author nzc
34  */
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 #include "BLI_compiler_attrs.h"
40
41 struct BlendThumbnail;
42 struct GHash;
43 struct ListBase;
44 struct ID;
45 struct ImBuf;
46 struct Main;
47 struct Library;
48 struct wmWindowManager;
49 struct bContext;
50 struct PointerRNA;
51 struct PropertyRNA;
52
53 size_t BKE_libblock_get_alloc_info(short type, const char **name);
54 void *BKE_libblock_alloc_notest(short type) ATTR_WARN_UNUSED_RESULT;
55 void *BKE_libblock_alloc(struct Main *bmain, short type, const char *name, const int flag) ATTR_WARN_UNUSED_RESULT;
56 void  BKE_libblock_init_empty(struct ID *id) ATTR_NONNULL(1);
57
58 void *BKE_id_new(struct Main *bmain, const short type, const char *name);
59 void *BKE_id_new_nomain(const short type, const char *name);
60
61
62 /**
63  * New ID creation/copying options.
64  */
65 enum {
66         /* *** Generic options (should be handled by all ID types copying, ID creation, etc.). *** */
67         /* Create datablock outside of any main database - similar to 'localize' functions of materials etc. */
68         LIB_ID_CREATE_NO_MAIN            = 1 << 0,
69         /* Do not affect user refcount of datablocks used by new one (which also gets zero usercount then).
70          * Implies LIB_ID_CREATE_NO_MAIN. */
71         LIB_ID_CREATE_NO_USER_REFCOUNT   = 1 << 1,
72         /* Assume given 'newid' already points to allocated memory for whole datablock (ID + data) - USE WITH CAUTION!
73          * Implies LIB_ID_CREATE_NO_MAIN. */
74         LIB_ID_CREATE_NO_ALLOCATE        = 1 << 2,
75
76         LIB_ID_CREATE_NO_DEG_TAG         = 1 << 8,  /* Do not tag new ID for update in depsgraph. */
77
78         /* Specific options to some ID types or usages, may be ignored by unrelated ID copying functions. */
79         LIB_ID_COPY_NO_PROXY_CLEAR     = 1 << 16,  /* Object only, needed by make_local code. */
80         LIB_ID_COPY_NO_PREVIEW         = 1 << 17,  /* Do not copy preview data, when supported. */
81         LIB_ID_COPY_CACHES             = 1 << 18,  /* Copy runtime data caches. */
82         LIB_ID_COPY_NO_ANIMDATA        = 1 << 19,  /* Don't copy id->adt, used by ID datablock localization routines. */
83         LIB_ID_COPY_CD_REFERENCE       = 1 << 20,  /* Mesh: Reference CD data layers instead of doing real copy. */
84
85         /* XXX Hackish/not-so-nice specific behaviors needed for some corner cases.
86          *     Ideally we should not have those, but we need them for now... */
87         LIB_ID_COPY_ACTIONS            = 1 << 24,  /* EXCEPTION! Deep-copy actions used by animdata of copied ID. */
88         LIB_ID_COPY_KEEP_LIB           = 1 << 25,  /* Keep the library pointer when copying datablock outside of bmain. */
89         LIB_ID_COPY_SHAPEKEY           = 1 << 26,  /* EXCEPTION! Deep-copy shapekeys used by copied obdata ID. */
90 };
91
92 void BKE_libblock_copy_ex(struct Main *bmain, const struct ID *id, struct ID **r_newid, const int flag);
93 void *BKE_libblock_copy(struct Main *bmain, const struct ID *id) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
94 /* "Deprecated" old API. */
95 void *BKE_libblock_copy_nolib(const struct ID *id, const bool do_action) ATTR_NONNULL();
96
97 void  BKE_libblock_rename(struct Main *bmain, struct ID *id, const char *name) ATTR_NONNULL();
98 void  BLI_libblock_ensure_unique_name(struct Main *bmain, const char *name) ATTR_NONNULL();
99
100 struct ID *BKE_libblock_find_name(struct Main *bmain, const short type, const char *name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
101
102 /* library_remap.c (keep here since they're general functions) */
103 /**
104  * New freeing logic options.
105  */
106 enum {
107         /* *** Generic options (should be handled by all ID types freeing). *** */
108         /* Do not try to remove freed ID from given Main (passed Main may be NULL). */
109         LIB_ID_FREE_NO_MAIN            = 1 << 0,
110         /* Do not affect user refcount of datablocks used by freed one.
111          * Implies LIB_ID_FREE_NO_MAIN. */
112         LIB_ID_FREE_NO_USER_REFCOUNT   = 1 << 1,
113         /* Assume freed ID datablock memory is managed elsewhere, do not free it
114          * (still calls relevant ID type's freeing function though) - USE WITH CAUTION!
115          * Implies LIB_ID_FREE_NO_MAIN. */
116         LIB_ID_FREE_NOT_ALLOCATED      = 1 << 2,
117
118         LIB_ID_FREE_NO_DEG_TAG         = 1 << 8,  /* Do not tag freed ID for update in depsgraph. */
119         LIB_ID_FREE_NO_UI_USER         = 1 << 9,  /* Do not attempt to remove freed ID from UI data/notifiers/... */
120 };
121
122 void BKE_id_free_ex(struct Main *bmain, void *idv, int flag, const bool use_flag_from_idtag);
123 void BKE_id_free(struct Main *bmain, void *idv);
124 /* Those three naming are bad actually, should be BKE_id_free... (since it goes beyond mere datablock). */
125 /* "Deprecated" old API */
126 void  BKE_libblock_free_ex(struct Main *bmain, void *idv, const bool do_id_user, const bool do_ui_user) ATTR_NONNULL();
127 void  BKE_libblock_free(struct Main *bmain, void *idv) ATTR_NONNULL();
128 void  BKE_libblock_free_us(struct Main *bmain, void *idv) ATTR_NONNULL();
129
130 void BKE_libblock_management_main_add(struct Main *bmain, void *idv);
131 void BKE_libblock_management_main_remove(struct Main *bmain, void *idv);
132
133 void BKE_libblock_management_usercounts_set(struct Main *bmain, void *idv);
134 void BKE_libblock_management_usercounts_clear(struct Main *bmain, void *idv);
135
136 /* TODO should be named "BKE_id_delete()". */
137 void  BKE_libblock_delete(struct Main *bmain, void *idv) ATTR_NONNULL();
138
139 void  BKE_libblock_free_datablock(struct ID *id, const int flag) ATTR_NONNULL();
140 void  BKE_libblock_free_data(struct ID *id, const bool do_id_user) ATTR_NONNULL();
141
142 void BKE_id_lib_local_paths(struct Main *bmain, struct Library *lib, struct ID *id);
143 void id_lib_extern(struct ID *id);
144 void BKE_library_filepath_set(struct Main *bmain, struct Library *lib, const char *filepath);
145 void id_us_ensure_real(struct ID *id);
146 void id_us_clear_real(struct ID *id);
147 void id_us_plus_no_lib(struct ID *id);
148 void id_us_plus(struct ID *id);
149 void id_us_min(struct ID *id);
150 void id_fake_user_set(struct ID *id);
151 void id_fake_user_clear(struct ID *id);
152 void BKE_id_clear_newpoin(struct ID *id);
153
154 void BKE_id_make_local_generic(struct Main *bmain, struct ID *id, const bool id_in_mainlist, const bool lib_local);
155 bool id_make_local(struct Main *bmain, struct ID *id, const bool test, const bool force_local);
156 bool id_single_user(struct bContext *C, struct ID *id, struct PointerRNA *ptr, struct PropertyRNA *prop);
157 bool id_copy(struct Main *bmain, const struct ID *id, struct ID **newid, bool test);
158 bool BKE_id_copy_ex(struct Main *bmain, const struct ID *id, struct ID **r_newid, const int flag, const bool test);
159 void BKE_id_swap(struct Main *bmain, struct ID *id_a, struct ID *id_b);
160 void id_sort_by_name(struct ListBase *lb, struct ID *id);
161 void BKE_id_expand_local(struct Main *bmain, struct ID *id);
162 void BKE_id_copy_ensure_local(struct Main *bmain, const struct ID *old_id, struct ID *new_id);
163
164 bool new_id(struct ListBase *lb, struct ID *id, const char *name) ATTR_NONNULL(1, 2);
165 void id_clear_lib_data(struct Main *bmain, struct ID *id);
166 void id_clear_lib_data_ex(struct Main *bmain, struct ID *id, const bool id_in_mainlist);
167
168 /* Affect whole Main database. */
169 void BKE_main_id_tag_idcode(struct Main *mainvar, const short type, const int tag, const bool value);
170 void BKE_main_id_tag_listbase(struct ListBase *lb, const int tag, const bool value);
171 void BKE_main_id_tag_all(struct Main *mainvar, const int tag, const bool value);
172
173 void BKE_main_id_flag_listbase(struct ListBase *lb, const int flag, const bool value);
174 void BKE_main_id_flag_all(struct Main *bmain, const int flag, const bool value);
175
176 void BKE_main_id_clear_newpoins(struct Main *bmain);
177
178 void BKE_main_lib_objects_recalc_all(struct Main *bmain);
179
180 #define MAX_ID_FULL_NAME (64 + 64 + 3 + 1)  /* 64 is MAX_ID_NAME - 2 */
181 #define MAX_ID_FULL_NAME_UI (MAX_ID_FULL_NAME + 3)  /* Adds 'keycode' two letters at begining. */
182 void BKE_id_full_name_get(char name[MAX_ID_FULL_NAME], const struct ID *id);
183 void BKE_id_full_name_ui_prefix_get(char name[MAX_ID_FULL_NAME_UI], const struct ID *id);
184
185 char *BKE_id_to_unique_string_key(const struct ID *id);
186
187 void BKE_library_free(struct Library *lib);
188
189 void BKE_library_make_local(
190         struct Main *bmain, const struct Library *lib, struct GHash *old_to_new_ids,
191         const bool untagged_only, const bool set_fake);
192
193 void BKE_id_tag_set_atomic(struct ID *id, int tag);
194 void BKE_id_tag_clear_atomic(struct ID *id, int tag);
195
196 bool BKE_id_is_in_global_main(struct ID *id);
197
198 void BKE_id_ordered_list(struct ListBase *ordered_lb, const struct ListBase *lb);
199 void BKE_id_reorder(const struct ListBase *lb, struct ID *id, struct ID *relative, bool after);
200
201 /* use when "" is given to new_id() */
202 #define ID_FALLBACK_NAME N_("Untitled")
203
204 #define IS_TAGGED(_id) ((_id) && (((ID *)_id)->tag & LIB_TAG_DOIT))
205
206 #ifdef __cplusplus
207 }
208 #endif
209
210 #endif  /* __BKE_LIBRARY_H__ */