16a4d8d46ec8e9d5fd57fe28622c219c343b41bc
[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 bScreen;
40 struct direntry;
41 struct LinkNode;
42 struct Main;
43 struct MemFile;
44 struct ReportList;
45 struct Scene;
46 struct SpaceFile;
47 struct UserDef;
48 struct bContext;
49 struct BHead;
50 struct FileData;
51
52 typedef struct BlendHandle BlendHandle;
53
54 typedef enum BlenFileType {
55         BLENFILETYPE_BLEND = 1,
56         BLENFILETYPE_PUB = 2,
57         BLENFILETYPE_RUNTIME = 3
58 } BlenFileType;
59
60 typedef struct BlendFileData {
61         struct Main *main;
62         struct UserDef *user;
63
64         int winpos;
65         int fileflags;
66         int displaymode;
67         int globalf;
68         char filename[1024];    /* 1024 = FILE_MAX */
69         
70         struct bScreen *curscreen;
71         struct Scene *curscene;
72         
73         BlenFileType type;
74 } BlendFileData;
75
76 /**
77  * Open a blender file from a pathname. The function
78  * returns NULL and sets a report in the list if
79  * it cannot open the file.
80  *
81  * \param filepath The path of the file to open.
82  * \param reports If the return value is NULL, errors
83  * indicating the cause of the failure.
84  * \return The data of the file.
85  */
86 BlendFileData *BLO_read_from_file(const char *filepath, struct ReportList *reports);
87
88 /**
89  * Open a blender file from memory. The function
90  * returns NULL and sets a report in the list if
91  * it cannot open the file.
92  *
93  * \param mem The file data.
94  * \param memsize The length of \a mem.
95  * \param reports If the return value is NULL, errors
96  * indicating the cause of the failure.
97  * \return The data of the file.
98  */
99 BlendFileData *BLO_read_from_memory(void *mem, int memsize, struct ReportList *reports);
100
101 /**
102  * oldmain is old main, from which we will keep libraries, images, ..
103  * file name is current file, only for retrieving library data */
104
105 BlendFileData *BLO_read_from_memfile(struct Main *oldmain, const char *filename, struct MemFile *memfile, struct ReportList *reports);
106
107 /**
108  * Free's a BlendFileData structure and _all_ the
109  * data associated with it (the userdef data, and
110  * the main libblock data).
111  * 
112  * \param bfd The structure to free.
113  */
114 void
115 BLO_blendfiledata_free(BlendFileData *bfd);
116         
117 /**
118  * Open a blendhandle from a file path.
119  * 
120  * \param file The file path to open.
121  * \param reports Report errors in opening the file (can be NULL).
122  * \return A handle on success, or NULL on failure.
123  */
124 BlendHandle *
125 BLO_blendhandle_from_file(char *file,
126                           struct ReportList *reports);
127
128 /**
129  * Open a blendhandle from memory.
130  *
131  * \param mem The data to load from.
132  * \param memsize The size of the data.
133  * \return A handle on success, or NULL on failure.
134  */
135
136 BlendHandle *
137 BLO_blendhandle_from_memory(void *mem,
138                             int memsize);
139
140 /**
141  * Gets the names of all the datablocks in a file
142  * of a certain type (ie. All the scene names in
143  * a file).
144  * 
145  * \param bh The blendhandle to access.
146  * \param ofblocktype The type of names to get.
147  * \param tot_names The length of the returned list.
148  * \return A BLI_linklist of strings. The string links
149  * should be freed with malloc.
150  */
151 struct LinkNode *
152 BLO_blendhandle_get_datablock_names(BlendHandle *bh,
153                                     int ofblocktype,
154                                     int *tot_names);
155
156 /**
157  * Gets the previews of all the datablocks in a file
158  * of a certain type (ie. All the scene names in
159  * a file).
160  * 
161  * \param bh The blendhandle to access.
162  * \param ofblocktype The type of names to get.
163  * \param tot_prev The length of the returned list.
164  * \return A BLI_linklist of PreviewImage. The PreviewImage links
165  * should be freed with malloc.
166  */
167 struct LinkNode *
168 BLO_blendhandle_get_previews(BlendHandle *bh,
169                              int ofblocktype,
170                              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 *
182 BLO_blendhandle_get_linkable_groups(BlendHandle *bh);
183
184 /**
185  * Close and free a blendhandle. The handle
186  * becomes invalid after this call.
187  *
188  * \param bh The handle to close.
189  */
190 void
191 BLO_blendhandle_close(BlendHandle *bh);
192         
193 /***/
194
195 #define GROUP_MAX 32
196
197 int BLO_has_bfile_extension(const char *str);
198
199 /* return ok when a blenderfile, in dir is the filename,
200  * in group the type of libdata
201  */
202 int BLO_is_a_library(const char *path, char *dir, char *group);
203
204
205 /**
206  * Initialize the BlendHandle for appending or linking library data.
207  *
208  * \param mainvar The current main database eg G.main or CTX_data_main(C).
209  * \param bh A blender file handle as returned by BLO_blendhandle_from_file or BLO_blendhandle_from_memory.
210  * \param filepath Used for relative linking, copied to the lib->name
211  * \return the library Main, to be passed to BLO_library_append_named_part as mainl.
212  */
213 struct Main *BLO_library_append_begin(struct Main *mainvar, BlendHandle **bh, const char *filepath);
214
215
216 /**
217  * Link/Append a named datablock from an external blend file.
218  *
219  * \param mainl The main database to link from (not the active one).
220  * \param bh The blender file handle.
221  * \param idname The name of the datablock (without the 2 char ID prefix)
222  * \param idcode The kind of datablock to link.
223  * \return the appended ID when found.
224  */
225 struct ID *BLO_library_append_named_part(struct Main *mainl, BlendHandle **bh, const char *idname, const int idcode);
226
227 /**
228  * Link/Append a named datablock from an external blend file.
229  * optionally instance the object in the scene when the flags are set.
230  *
231  * \param C The context, when NULL instancing object in the scene isn't done.
232  * \param mainl The main database to link from (not the active one).
233  * \param bh The blender file handle.
234  * \param idname The name of the datablock (without the 2 char ID prefix)
235  * \param idcode The kind of datablock to link.
236  * \param flag Options for linking, used for instancing.
237  * \return the appended ID when found.
238  */
239 struct ID *BLO_library_append_named_part_ex(const struct bContext *C, struct Main *mainl, BlendHandle **bh, const char *idname, const int idcode, const short flag);
240
241 void BLO_library_append_end(const struct bContext *C, struct Main *mainl, BlendHandle **bh, int idcode, short flag);
242
243 void *BLO_library_read_struct(struct FileData *fd, struct BHead *bh, const char *blockname);
244
245 BlendFileData *blo_read_blendafterruntime(int file, const char *name, int actualsize, struct ReportList *reports);
246
247 /* internal function but we need to expose it */
248 void blo_lib_link_screen_restore(struct Main *newmain, struct bScreen *curscreen, struct Scene *curscene);
249
250 #ifdef __cplusplus
251
252 #endif
253
254 #endif
255