Threaded object update and EvaluationContext
[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 ListBase;
42 struct ID;
43 struct Main;
44 struct Library;
45 struct wmWindowManager;
46 struct bContext;
47 struct PointerRNA;
48 struct PropertyRNA;
49
50 void *BKE_libblock_alloc(struct ListBase *lb, short type, const char *name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
51 void *BKE_libblock_copy_ex(struct Main *bmain, struct ID *id) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
52 void *BKE_libblock_copy(struct ID *id) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
53 void  BKE_libblock_copy_data(struct ID *id, const struct ID *id_from, const bool do_action);
54
55 void BKE_id_lib_local_paths(struct Main *bmain, struct Library *lib, struct ID *id);
56 void id_lib_extern(struct ID *id);
57 void BKE_library_filepath_set(struct Library *lib, const char *filepath);
58 void id_us_ensure_real(struct ID *id);
59 void id_us_plus(struct ID *id);
60 void id_us_min(struct ID *id);
61
62 bool id_make_local(struct ID *id, bool test);
63 bool id_single_user(struct bContext *C, struct ID *id, struct PointerRNA *ptr, struct PropertyRNA *prop);
64 bool id_copy(struct ID *id, struct ID **newid, bool test);
65 bool id_unlink(struct ID *id, int test);
66 void id_sort_by_name(struct ListBase *lb, struct ID *id);
67
68 bool new_id(struct ListBase *lb, struct ID *id, const char *name);
69 void id_clear_lib_data(struct Main *bmain, struct ID *id);
70
71 struct ListBase *which_libbase(struct Main *mainlib, short type);
72
73 #define MAX_LIBARRAY    41
74 int set_listbasepointers(struct Main *main, struct ListBase **lb);
75
76 void BKE_libblock_free(struct ListBase *lb, void *idv);
77 void BKE_libblock_free_ex(struct ListBase *lb, void *idv, bool do_id_user);
78 void BKE_libblock_free_us(struct ListBase *lb, void *idv);
79 void BKE_libblock_free_data(struct ID *id);
80
81 struct Main *BKE_main_new(void);
82 void free_main(struct Main *mainvar);
83
84 void tag_main_idcode(struct Main *mainvar, const short type, const short tag);
85 void tag_main_lb(struct ListBase *lb, const short tag);
86 void tag_main(struct Main *mainvar, const short tag);
87
88 void rename_id(struct ID *id, const char *name);
89 void name_uiprefix_id(char *name, const struct ID *id);
90 void test_idbutton(char *name);
91 void BKE_library_make_local(struct Main *bmain, struct Library *lib, bool untagged_only);
92 struct ID *BKE_libblock_find_name(const short type, const char *name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
93 void clear_id_newpoins(void);
94
95 #if 0
96 void IDnames_to_pupstring(const char **str, const char *title, const char *extraops,
97                           struct ListBase *lb, struct ID *link, short *nr);
98 void IMAnames_to_pupstring(const char **str, const char *title, const char *extraops,
99                            struct ListBase *lb, struct ID *link, short *nr);
100 #endif
101
102 void flag_listbase_ids(ListBase *lb, short flag, short value);
103 void flag_all_listbases_ids(short flag, short value);
104 void recalc_all_library_objects(struct Main *main);
105
106 void set_free_windowmanager_cb(void (*func)(struct bContext *, struct wmWindowManager *) );
107 void set_free_notifier_reference_cb(void (*func)(const void *) );
108
109 /* use when "" is given to new_id() */
110 #define ID_FALLBACK_NAME N_("Untitled")
111
112 #define IS_TAGGED(_id) ((_id) && (((ID *)_id)->flag & LIB_DOIT))
113
114 #ifdef __cplusplus
115 }
116 #endif
117
118 #endif  /* __BKE_LIBRARY_H__ */