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);
55 void *BKE_libblock_alloc(struct Main *bmain, short type, const char *name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
56 void  BKE_libblock_init_empty(struct ID *id);
57 void *BKE_libblock_copy(struct Main *bmain, struct ID *id) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
58 void *BKE_libblock_copy_nolib(struct ID *id, const bool do_action) ATTR_NONNULL();
59 void  BKE_libblock_copy_data(struct ID *id, const struct ID *id_from, const bool do_action);
60 void  BKE_libblock_rename(struct Main *bmain, struct ID *id, const char *name) ATTR_NONNULL();
61 void  BLI_libblock_ensure_unique_name(struct Main *bmain, const char *name) ATTR_NONNULL();
62
63 struct ID *BKE_libblock_find_name_ex(struct Main *bmain, const short type, const char *name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
64 struct ID *BKE_libblock_find_name(const short type, const char *name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
65
66 /* library_remap.c (keep here since they're general functions) */
67 void  BKE_libblock_free(struct Main *bmain, void *idv) ATTR_NONNULL();
68 void BKE_libblock_free_datablock(struct ID *id) ATTR_NONNULL();
69 void  BKE_libblock_free_ex(struct Main *bmain, void *idv, const bool do_id_user, const bool do_ui_user) ATTR_NONNULL();
70 void  BKE_libblock_free_us(struct Main *bmain, void *idv) ATTR_NONNULL();
71 void  BKE_libblock_free_data(struct Main *bmain, struct ID *id, const bool do_id_user) ATTR_NONNULL();
72 void  BKE_libblock_delete(struct Main *bmain, void *idv) ATTR_NONNULL();
73
74 void BKE_id_lib_local_paths(struct Main *bmain, struct Library *lib, struct ID *id);
75 void id_lib_extern(struct ID *id);
76 void BKE_library_filepath_set(struct Library *lib, const char *filepath);
77 void id_us_ensure_real(struct ID *id);
78 void id_us_clear_real(struct ID *id);
79 void id_us_plus_no_lib(struct ID *id);
80 void id_us_plus(struct ID *id);
81 void id_us_min(struct ID *id);
82 void id_fake_user_set(struct ID *id);
83 void id_fake_user_clear(struct ID *id);
84 void BKE_id_clear_newpoin(struct ID *id);
85
86 void BKE_id_make_local_generic(struct Main *bmain, struct ID *id, const bool id_in_mainlist, const bool lib_local);
87 bool id_make_local(struct Main *bmain, struct ID *id, const bool test, const bool force_local);
88 bool id_single_user(struct bContext *C, struct ID *id, struct PointerRNA *ptr, struct PropertyRNA *prop);
89 bool id_copy(struct Main *bmain, struct ID *id, struct ID **newid, bool test);
90 void id_sort_by_name(struct ListBase *lb, struct ID *id);
91 void BKE_id_expand_local(struct Main *bmain, struct ID *id);
92 void BKE_id_copy_ensure_local(struct Main *bmain, struct ID *old_id, struct ID *new_id);
93
94 bool new_id(struct ListBase *lb, struct ID *id, const char *name);
95 void id_clear_lib_data(struct Main *bmain, struct ID *id);
96 void id_clear_lib_data_ex(struct Main *bmain, struct ID *id, const bool id_in_mainlist);
97
98 struct ListBase *which_libbase(struct Main *mainlib, short type);
99
100 #define MAX_LIBARRAY    37
101 int set_listbasepointers(struct Main *main, struct ListBase *lb[MAX_LIBARRAY]);
102
103 /* Main API */
104 struct Main *BKE_main_new(void);
105 void BKE_main_free(struct Main *mainvar);
106
107 void BKE_main_lock(struct Main *bmain);
108 void BKE_main_unlock(struct Main *bmain);
109
110 void BKE_main_relations_create(struct Main *bmain);
111 void BKE_main_relations_free(struct Main *bmain);
112
113 struct BlendThumbnail *BKE_main_thumbnail_from_imbuf(struct Main *bmain, struct ImBuf *img);
114 struct ImBuf *BKE_main_thumbnail_to_imbuf(struct Main *bmain, struct BlendThumbnail *data);
115 void BKE_main_thumbnail_create(struct Main *bmain);
116
117 void BKE_main_id_tag_idcode(struct Main *mainvar, const short type, const int tag, const bool value);
118 void BKE_main_id_tag_listbase(struct ListBase *lb, const int tag, const bool value);
119 void BKE_main_id_tag_all(struct Main *mainvar, const int tag, const bool value);
120
121 void BKE_main_id_flag_listbase(struct ListBase *lb, const int flag, const bool value);
122 void BKE_main_id_flag_all(struct Main *bmain, const int flag, const bool value);
123
124 void BKE_main_id_clear_newpoins(struct Main *bmain);
125
126 void BKE_main_lib_objects_recalc_all(struct Main *bmain);
127
128 /* (MAX_ID_NAME - 2) + 3 */
129 void BKE_id_ui_prefix(char name[66 + 1], const struct ID *id);
130
131 void BKE_library_free(struct Library *lib);
132
133 void BKE_library_make_local(
134         struct Main *bmain, const struct Library *lib, struct GHash *old_to_new_ids,
135         const bool untagged_only, const bool set_fake);
136
137 void BKE_id_tag_set_atomic(struct ID *id, int tag);
138 void BKE_id_tag_clear_atomic(struct ID *id, int tag);
139
140 /* use when "" is given to new_id() */
141 #define ID_FALLBACK_NAME N_("Untitled")
142
143 #define IS_TAGGED(_id) ((_id) && (((ID *)_id)->tag & LIB_TAG_DOIT))
144
145 #ifdef __cplusplus
146 }
147 #endif
148
149 #endif  /* __BKE_LIBRARY_H__ */