891dc47b4aedfc3cbd1a43a96242f68247e2730a
[blender-staging.git] / source / blender / blenloader / BLO_readfile.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29 #ifndef BLO_READFILE_H
30 #define BLO_READFILE_H
31
32 /** \file BLO_readfile.h
33  *  \ingroup blenloader
34  *  \brief external readfile function prototypes.
35  */
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 struct bScreen;
42 struct direntry;
43 struct LinkNode;
44 struct Main;
45 struct MemFile;
46 struct ReportList;
47 struct Scene;
48 struct SpaceFile;
49 struct SpaceImaSel;
50 struct UserDef;
51 struct bContext;
52
53 typedef struct BlendHandle      BlendHandle;
54
55 typedef enum BlenFileType {
56         BLENFILETYPE_BLEND= 1, 
57         BLENFILETYPE_PUB= 2, 
58         BLENFILETYPE_RUNTIME= 3
59 } BlenFileType;
60
61 typedef struct BlendFileData {
62         struct Main*    main;
63         struct UserDef* user;
64
65         int winpos;
66         int fileflags;
67         int displaymode;
68         int globalf;
69         char filename[240];     /* 240 = FILE_MAX */
70         
71         struct bScreen* curscreen;
72         struct Scene*   curscene;
73         
74         BlenFileType    type;
75 } BlendFileData;
76
77         /**
78          * Open a blender file from a pathname. The function
79          * returns NULL and sets a report in the list if
80          * it cannot open the file.
81          * 
82          * @param file The path of the file to open.
83          * @param reports If the return value is NULL, errors
84          * indicating the cause of the failure.
85          * @return The data of the file.
86          */
87 BlendFileData*  BLO_read_from_file(const char *file, struct ReportList *reports);
88
89         /**
90          * Open a blender file from memory. The function
91          * returns NULL and sets a report in the list if
92          * it cannot open the file.
93          * 
94          * @param mem The file data.
95          * @param memsize The length of @a mem.
96          * @param reports If the return value is NULL, errors
97          * indicating the cause of the failure.
98          * @return The data of the file.
99          */
100 BlendFileData*  BLO_read_from_memory(void *mem, int memsize, 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(struct Main *oldmain, const char *filename, struct MemFile *memfile, struct ReportList *reports);
107
108 /**
109  * Free's a BlendFileData structure and _all_ the
110  * data associated with it (the userdef data, and
111  * the main libblock data).
112  * 
113  * @param bfd The structure to free.
114  */
115         void
116 BLO_blendfiledata_free(
117         BlendFileData *bfd);
118         
119 /**
120  * Open a blendhandle from a file path.
121  * 
122  * @param file The file path to open.
123  * @param reports Report errors in opening the file (can be NULL).
124  * @return A handle on success, or NULL on failure.
125  */
126         BlendHandle*
127 BLO_blendhandle_from_file(
128         char *file,
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*
140 BLO_blendhandle_from_memory(
141         void *mem,
142         int memsize);
143
144 /**
145  * Gets the names of all the datablocks in a file
146  * of a certain type (ie. All the scene names in
147  * a file).
148  * 
149  * @param bh The blendhandle to access.
150  * @param ofblocktype The type of names to get.
151  * @param totnames The length of the returned list.
152  * @return A BLI_linklist of strings. The string links
153  * should be freed with malloc.
154  */
155         struct LinkNode*
156 BLO_blendhandle_get_datablock_names(
157         BlendHandle *bh, 
158         int ofblocktype,
159         int *totnames);
160
161 /**
162  * Gets the previews of all the datablocks in a file
163  * of a certain type (ie. All the scene names in
164  * a file).
165  * 
166  * @param bh The blendhandle to access.
167  * @param ofblocktype The type of names to get.
168  * @return A BLI_linklist of PreviewImage. The PreviewImage links
169  * should be freed with malloc.
170  */
171         struct LinkNode*
172 BLO_blendhandle_get_previews(
173         BlendHandle *bh, 
174         int ofblocktype);
175
176 /**
177  * Gets the names of all the datablock groups in a
178  * file. (ie. file contains Scene, Mesh, and Lamp
179  * datablocks).
180  * 
181  * @param bh The blendhandle to access.
182  * @return A BLI_linklist of strings. The string links
183  * should be freed with malloc.
184  */
185         struct LinkNode*
186 BLO_blendhandle_get_linkable_groups(
187         BlendHandle *bh);
188
189 /**
190  * Close and free a blendhandle. The handle
191  * becomes invalid after this call.
192  *
193  * @param bh The handle to close.
194  */
195         void
196 BLO_blendhandle_close(
197         BlendHandle *bh);
198         
199         /***/
200
201 #define GROUP_MAX 32
202
203 int BLO_has_bfile_extension(char *str);
204
205 /* return ok when a blenderfile, in dir is the filename,
206  * in group the type of libdata
207  */
208 int BLO_is_a_library(const char *path, char *dir, char *group);
209
210 struct Main* BLO_library_append_begin(const struct bContext *C, BlendHandle** bh, char *dir);
211
212 /**
213  * Link/Append a named datablock from an external blend file.
214  *
215  * @param C The context, when NULL instancing object in the scene isnt done.
216  * @param mainl The main database to link from (not the active one).
217  * @param bh The blender file handle.
218  * @param name The name of the datablock (without the 2 char ID prefix)
219  * @param idcode The kind of datablock to link.
220  * @param flag Options for linking, used for instancing.
221  * @return Boolean, 0 when the datablock could not be found.
222  */
223 int BLO_library_append_named_part(const struct bContext *C, struct Main *mainl, BlendHandle** bh, const char *name, int idcode, short flag);
224 void BLO_library_append_end(const struct bContext *C, struct Main *mainl, BlendHandle** bh, int idcode, short flag);
225
226 /* deprecated */
227 #if 1
228 void BLO_script_library_append(BlendHandle **bh, char *dir, char *name, int idcode, short flag, struct Main *mainvar, struct Scene *scene, struct ReportList *reports);
229 #endif
230
231 BlendFileData* blo_read_blendafterruntime(int file, char *name, int actualsize, struct ReportList *reports);
232
233 #ifdef __cplusplus
234
235 #endif
236
237 #endif
238