Fix T46386: Duplicate fails updating driver links
[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 ListBase;
43 struct ID;
44 struct ImBuf;
45 struct Main;
46 struct Library;
47 struct wmWindowManager;
48 struct bContext;
49 struct PointerRNA;
50 struct PropertyRNA;
51
52 void *BKE_libblock_alloc(struct Main *bmain, short type, const char *name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
53 void *BKE_libblock_copy_ex(struct Main *bmain, struct ID *id) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
54 void *BKE_libblock_copy_nolib(struct ID *id, const bool do_action) ATTR_NONNULL();
55 void *BKE_libblock_copy(struct ID *id) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
56 void  BKE_libblock_copy_data(struct ID *id, const struct ID *id_from, const bool do_action);
57 void  BKE_libblock_relink(struct ID *id);
58
59 void BKE_id_lib_local_paths(struct Main *bmain, struct Library *lib, struct ID *id);
60 void id_lib_extern(struct ID *id);
61 void BKE_library_filepath_set(struct Library *lib, const char *filepath);
62 void id_us_ensure_real(struct ID *id);
63 void id_us_plus(struct ID *id);
64 void id_us_min(struct ID *id);
65
66 bool id_make_local(struct ID *id, bool test);
67 bool id_single_user(struct bContext *C, struct ID *id, struct PointerRNA *ptr, struct PropertyRNA *prop);
68 bool id_copy(struct ID *id, struct ID **newid, bool test);
69 bool id_unlink(struct ID *id, int test);
70 void id_sort_by_name(struct ListBase *lb, struct ID *id);
71
72 bool new_id(struct ListBase *lb, struct ID *id, const char *name);
73 void id_clear_lib_data(struct Main *bmain, struct ID *id);
74
75 struct ListBase *which_libbase(struct Main *mainlib, short type);
76
77 #define MAX_LIBARRAY    35
78 int set_listbasepointers(struct Main *main, struct ListBase *lb[MAX_LIBARRAY]);
79
80 void BKE_libblock_free(struct Main *bmain, void *idv);
81 void BKE_libblock_free_ex(struct Main *bmain, void *idv, bool do_id_user);
82 void BKE_libblock_free_us(struct Main *bmain, void *idv);
83 void BKE_libblock_free_data(struct Main *bmain, struct ID *id);
84
85
86 /* Main API */
87 struct Main *BKE_main_new(void);
88 void BKE_main_free(struct Main *mainvar);
89
90 void BKE_main_lock(struct Main *bmain);
91 void BKE_main_unlock(struct Main *bmain);
92
93 struct BlendThumbnail *BKE_main_thumbnail_from_imbuf(struct Main *bmain, struct ImBuf *img);
94 struct ImBuf *BKE_main_thumbnail_to_imbuf(struct Main *bmain, struct BlendThumbnail *data);
95 void BKE_main_thumbnail_create(struct Main *bmain);
96
97 void BKE_main_id_tag_idcode(struct Main *mainvar, const short type, const bool tag);
98 void BKE_main_id_tag_listbase(struct ListBase *lb, const bool tag);
99 void BKE_main_id_tag_all(struct Main *mainvar, const bool tag);
100
101 void BKE_main_id_flag_listbase(ListBase *lb, const short flag, const bool value);
102 void BKE_main_id_flag_all(struct Main *bmain, const short flag, const bool value);
103
104 void BKE_main_id_clear_newpoins(struct Main *bmain);
105
106 void BKE_main_lib_objects_recalc_all(struct Main *bmain);
107
108 void rename_id(struct ID *id, const char *name);
109 void name_uiprefix_id(char *name, const struct ID *id);
110 void test_idbutton(char *name);
111
112 void BKE_library_make_local(struct Main *bmain, struct Library *lib, bool untagged_only);
113
114 struct ID *BKE_libblock_find_name_ex(struct Main *bmain, const short type, const char *name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
115 struct ID *BKE_libblock_find_name(const short type, const char *name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
116
117 void BKE_library_callback_free_window_manager_set(void (*func)(struct bContext *, struct wmWindowManager *));
118 void BKE_library_callback_free_notifier_reference_set(void (*func)(const void *));
119 void BKE_library_callback_free_editor_id_reference_set(void (*func)(const struct ID *));
120
121 /* use when "" is given to new_id() */
122 #define ID_FALLBACK_NAME N_("Untitled")
123
124 #define IS_TAGGED(_id) ((_id) && (((ID *)_id)->flag & LIB_DOIT))
125
126 #ifdef __cplusplus
127 }
128 #endif
129
130 #endif  /* __BKE_LIBRARY_H__ */