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