77bdb99b54b4703362453d5f3e48d2e4a64ff4bc
[blender.git] / source / blender / blenloader / BLO_readfile.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 __BLO_READFILE_H__
28 #define __BLO_READFILE_H__
29
30 /** \file BLO_readfile.h
31  *  \ingroup blenloader
32  *  \brief external readfile function prototypes.
33  */
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 struct BlendThumbnail;
40 struct bScreen;
41 struct LinkNode;
42 struct Main;
43 struct MemFile;
44 struct ReportList;
45 struct Scene;
46 struct UserDef;
47 struct bContext;
48 struct BHead;
49 struct FileData;
50
51 typedef struct BlendHandle BlendHandle;
52
53 typedef enum BlenFileType {
54         BLENFILETYPE_BLEND = 1,
55         BLENFILETYPE_PUB = 2,
56         BLENFILETYPE_RUNTIME = 3
57 } BlenFileType;
58
59 typedef struct BlendFileData {
60         struct Main *main;
61         struct UserDef *user;
62
63         int fileflags;
64         int globalf;
65         char filename[1024];    /* 1024 = FILE_MAX */
66         
67         struct bScreen *curscreen;
68         struct Scene *curscene;
69         
70         BlenFileType type;
71 } BlendFileData;
72
73 /**
74  * Open a blender file from a pathname. The function
75  * returns NULL and sets a report in the list if
76  * it cannot open the file.
77  *
78  * \param filepath The path of the file to open.
79  * \param reports If the return value is NULL, errors
80  * indicating the cause of the failure.
81  * \return The data of the file.
82  */
83 BlendFileData *BLO_read_from_file(
84         const char *filepath,
85         struct ReportList *reports);
86
87 /**
88  * Open a blender file from memory. The function
89  * returns NULL and sets a report in the list if
90  * it cannot open the file.
91  *
92  * \param mem The file data.
93  * \param memsize The length of \a mem.
94  * \param reports If the return value is NULL, errors
95  * indicating the cause of the failure.
96  * \return The data of the file.
97  */
98 BlendFileData *BLO_read_from_memory(
99         const void *mem, int memsize,
100         struct ReportList *reports);
101
102 /**
103  * oldmain is old main, from which we will keep libraries, images, ..
104  * file name is current file, only for retrieving library data */
105
106 BlendFileData *BLO_read_from_memfile(
107         struct Main *oldmain, const char *filename, struct MemFile *memfile,
108         struct ReportList *reports);
109
110 /**
111  * Free's a BlendFileData structure and _all_ the
112  * data associated with it (the userdef data, and
113  * the main libblock data).
114  *
115  * \param bfd The structure to free.
116  */
117 void
118 BLO_blendfiledata_free(BlendFileData *bfd);
119
120 /**
121  * Open a blendhandle from a file path.
122  *
123  * \param filepath: The file path to open.
124  * \param reports: Report errors in opening the file (can be NULL).
125  * \return A handle on success, or NULL on failure.
126  */
127 BlendHandle *BLO_blendhandle_from_file(
128         const char *filepath,
129         struct ReportList *reports);
130
131 /**
132  * Open a blendhandle from memory.
133  *
134  * \param mem The data to load from.
135  * \param memsize The size of the data.
136  * \return A handle on success, or NULL on failure.
137  */
138
139 BlendHandle *BLO_blendhandle_from_memory(
140         const void *mem, int memsize);
141
142 /**
143  * Gets the names of all the datablocks in a file
144  * of a certain type (ie. All the scene names in
145  * a file).
146  *
147  * \param bh The blendhandle to access.
148  * \param ofblocktype The type of names to get.
149  * \param tot_names The length of the returned list.
150  * \return A BLI_linklist of strings. The string links
151  * should be freed with malloc.
152  */
153 struct LinkNode *BLO_blendhandle_get_datablock_names(
154         BlendHandle *bh,
155         int ofblocktype, int *tot_names);
156
157 /**
158  * Gets the previews of all the datablocks in a file
159  * of a certain type (ie. All the scene names in
160  * a file).
161  *
162  * \param bh The blendhandle to access.
163  * \param ofblocktype The type of names to get.
164  * \param tot_prev The length of the returned list.
165  * \return A BLI_linklist of PreviewImage. The PreviewImage links
166  * should be freed with malloc.
167  */
168 struct LinkNode *BLO_blendhandle_get_previews(
169         BlendHandle *bh,
170         int ofblocktype, int *tot_prev);
171
172 /**
173  * Gets the names of all the datablock groups in a
174  * file. (ie. file contains Scene, Mesh, and Lamp
175  * datablocks).
176  *
177  * \param bh The blendhandle to access.
178  * \return A BLI_linklist of strings. The string links
179  * should be freed with malloc.
180  */
181 struct LinkNode *BLO_blendhandle_get_linkable_groups(BlendHandle *bh);
182
183 /**
184  * Close and free a blendhandle. The handle
185  * becomes invalid after this call.
186  *
187  * \param bh The handle to close.
188  */
189 void
190 BLO_blendhandle_close(BlendHandle *bh);
191
192 /***/
193
194 #define BLO_GROUP_MAX 32
195
196 bool BLO_has_bfile_extension(const char *str);
197
198 /**
199  * \param path the full path to explode.
200  * \param r_dir the string that'll contain path up to blend file itself ('library' path).
201  * \param r_group the string that'll contain 'group' part of the path, if any. May be NULL.
202  * \param r_name the string that'll contain data's name part of the path, if any. May be NULL.
203  * \return true if path contains a blend file.
204  */
205 bool BLO_library_path_explode(const char *path, char *r_dir, char **r_group, char **r_name);
206
207
208 /**
209  * Initialize the BlendHandle for appending or linking library data.
210  *
211  * \param mainvar The current main database eg G.main or CTX_data_main(C).
212  * \param bh A blender file handle as returned by BLO_blendhandle_from_file or BLO_blendhandle_from_memory.
213  * \param filepath Used for relative linking, copied to the lib->name
214  * \return the library Main, to be passed to BLO_library_append_named_part as mainl.
215  */
216 struct Main *BLO_library_append_begin(
217         struct Main *mainvar, BlendHandle **bh,
218         const char *filepath);
219
220
221 /**
222  * Link/Append a named datablock from an external blend file.
223  *
224  * \param mainl The main database to link from (not the active one).
225  * \param bh The blender file handle.
226  * \param idname The name of the datablock (without the 2 char ID prefix)
227  * \param idcode The kind of datablock to link.
228  * \return the appended ID when found.
229  */
230 struct ID *BLO_library_append_named_part(
231         struct Main *mainl, BlendHandle **bh,
232         const char *idname, const int idcode);
233
234 /**
235  * Link/Append a named datablock from an external blend file.
236  * optionally instance the object in the scene when the flags are set.
237  *
238  * \param C The context, when NULL instancing object in the scene isn't done.
239  * \param mainl The main database to link from (not the active one).
240  * \param bh The blender file handle.
241  * \param idname The name of the datablock (without the 2 char ID prefix)
242  * \param idcode The kind of datablock to link.
243  * \param flag Options for linking, used for instancing.
244  * \return the appended ID when found.
245  */
246 struct ID *BLO_library_append_named_part_ex(
247         const struct bContext *C, struct Main *mainl, BlendHandle **bh,
248         const char *idname, const int idcode, const short flag);
249
250 void BLO_library_append_end(const struct bContext *C, struct Main *mainl, BlendHandle **bh, int idcode, short flag);
251
252 void BLO_library_append_all(struct Main *mainl, BlendHandle *bh);
253
254 void *BLO_library_read_struct(struct FileData *fd, struct BHead *bh, const char *blockname);
255
256 BlendFileData *blo_read_blendafterruntime(int file, const char *name, int actualsize, struct ReportList *reports);
257
258 /* internal function but we need to expose it */
259 void blo_lib_link_screen_restore(struct Main *newmain, struct bScreen *curscreen, struct Scene *curscene);
260
261 /**
262  * BLO_expand_main() loops over all ID data in Main to mark relations.
263  * Set (id->flag & LIB_NEED_EXPAND) to mark expanding. Flags get cleared after expanding.
264  *
265  * \param expand_doit_func() gets called for each ID block it finds
266  */
267 void BLO_main_expander(void (*expand_doit_func)(void *, struct Main *, void *));
268
269 /**
270  * BLO_expand_main() loops over all ID data in Main to mark relations.
271  * Set (id->flag & LIB_NEED_EXPAND) to mark expanding. Flags get cleared after expanding.
272  *
273  * \param fdhandle usually filedata, or own handle
274  * \param mainvar the Main database to expand
275  */
276 void BLO_expand_main(void *fdhandle, struct Main *mainvar);
277
278 /* Update defaults in startup.blend & userprefs.blend, without having to save and embed it */
279 void BLO_update_defaults_userpref_blend(void);
280 void BLO_update_defaults_startup_blend(struct Main *mainvar);
281
282 /**
283  * Does a very light reading of given .blend file to extract its stored thumbnail.
284  *
285  * \param filepath The path of the file to extract thumbnail from.
286  * \return The raw thumbnail
287  *         (MEM-allocated, as stored in file, use BKE_main_thumbnail_to_imbuf() to convert it to ImBuf image).
288  */
289 struct BlendThumbnail *BLO_thumbnail_from_file(const char *filepath);
290
291 #ifdef __cplusplus
292
293 #endif
294
295 #endif  /* __BLO_READFILE_H__ */