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