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