52295dc3092368f146b514bf0f1da6de6fa72dae
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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  * external readfile function prototypes
29  */
30 #ifndef BLO_READFILE_H
31 #define BLO_READFILE_H
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 struct bScreen;
38 struct direntry;
39 struct LinkNode;
40 struct Main;
41 struct MemFile;
42 struct ReportList;
43 struct Scene;
44 struct SpaceFile;
45 struct SpaceImaSel;
46 struct UserDef;
47 struct bContext;
48
49 typedef struct BlendHandle      BlendHandle;
50
51 typedef enum BlenFileType {
52         BLENFILETYPE_BLEND= 1, 
53         BLENFILETYPE_PUB= 2, 
54         BLENFILETYPE_RUNTIME= 3
55 } BlenFileType;
56
57 typedef struct BlendFileData {
58         struct Main*    main;
59         struct UserDef* user;
60
61         int winpos;
62         int fileflags;
63         int displaymode;
64         int globalf;
65         
66         struct bScreen* curscreen;
67         struct Scene*   curscene;
68         
69         BlenFileType    type;
70 } BlendFileData;
71
72         /**
73          * Open a blender file from a pathname. The function
74          * returns NULL and sets a report in the list if
75          * it cannot open the file.
76          * 
77          * @param file The path of the file to open.
78          * @param reports If the return value is NULL, errors
79          * indicating the cause of the failure.
80          * @return The data of the file.
81          */
82 BlendFileData*  BLO_read_from_file              (char *file, struct ReportList *reports);
83
84         /**
85          * Open a blender file from memory. The function
86          * returns NULL and sets a report in the list if
87          * it cannot open the file.
88          * 
89          * @param mem The file data.
90          * @param memsize The length of @a mem.
91          * @param reports If the return value is NULL, errors
92          * indicating the cause of the failure.
93          * @return The data of the file.
94          */
95 BlendFileData*  BLO_read_from_memory(void *mem, int memsize, struct ReportList *reports);
96
97 /**
98  * oldmain is old main, from which we will keep libraries, images, ..
99  * file name is current file, only for retrieving library data */
100
101 BlendFileData *BLO_read_from_memfile(struct Main *oldmain, const char *filename, struct MemFile *memfile, struct ReportList *reports);
102
103 /**
104  * Free's a BlendFileData structure and _all_ the
105  * data associated with it (the userdef data, and
106  * the main libblock data).
107  * 
108  * @param bfd The structure to free.
109  */
110         void
111 BLO_blendfiledata_free(
112         BlendFileData *bfd);
113
114 /**
115  * Convert an idcode into a name.
116  * 
117  * @param code The code to convert.
118  * @return A static string representing the name of
119  * the code.
120  */
121         char*
122 BLO_idcode_to_name(
123         int code);
124
125 /**
126  * Convert a name into an idcode (ie. ID_SCE)
127  * 
128  * @param name The name to convert.
129  * @return The code for the name, or 0 if invalid.
130  */
131         int
132 BLO_idcode_from_name(
133         char *name);
134         
135 /**
136  * Open a blendhandle from a file path.
137  * 
138  * @param file The file path to open.
139  * @return A handle on success, or NULL on failure.
140  */
141         BlendHandle*
142 BLO_blendhandle_from_file(
143         char *file);
144
145 /**
146  * Gets the names of all the datablocks in a file
147  * of a certain type (ie. All the scene names in
148  * a file).
149  * 
150  * @param bh The blendhandle to access.
151  * @param ofblocktype The type of names to get.
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
160 /**
161  * Gets the previews of all the datablocks in a file
162  * of a certain type (ie. All the scene names in
163  * a file).
164  * 
165  * @param bh The blendhandle to access.
166  * @param ofblocktype The type of names to get.
167  * @return A BLI_linklist of PreviewImage. The PreviewImage links
168  * should be freed with malloc.
169  */
170         struct LinkNode*
171 BLO_blendhandle_get_previews(
172         BlendHandle *bh, 
173         int ofblocktype);
174
175 /**
176  * Gets the names of all the datablock groups in a
177  * file. (ie. file contains Scene, Mesh, and Lamp
178  * datablocks).
179  * 
180  * @param bh The blendhandle to access.
181  * @return A BLI_linklist of strings. The string links
182  * should be freed with malloc.
183  */
184         struct LinkNode*
185 BLO_blendhandle_get_linkable_groups(
186         BlendHandle *bh);
187
188 /**
189  * Close and free a blendhandle. The handle
190  * becomes invalid after this call.
191  *
192  * @param bh The handle to close.
193  */
194         void
195 BLO_blendhandle_close(
196         BlendHandle *bh);
197         
198         /***/
199
200 #define GROUP_MAX 32
201
202 int BLO_has_bfile_extension(char *str);
203
204 /* return ok when a blenderfile, in dir is the filename,
205  * in group the type of libdata
206  */
207 int BLO_is_a_library(char *path, char *dir, char *group);
208
209 struct Main* BLO_library_append_begin(const struct bContext *C, BlendHandle** bh, char *dir);
210 void BLO_library_append_named_part(const struct bContext *C, struct Main *mainl, BlendHandle** bh, char *name, int idcode, short flag);
211 void BLO_library_append_end(const struct bContext *C, struct Main *mainl, BlendHandle** bh, int idcode, short flag);
212
213 /* deprecated */
214 #if 1
215 void BLO_script_library_append(BlendHandle **bh, char *dir, char *name, int idcode, short flag, struct Main *mainvar, struct Scene *scene, struct ReportList *reports);
216 #endif
217
218 BlendFileData* blo_read_blendafterruntime(int file, char *name, int actualsize, struct ReportList *reports);
219
220 #ifdef __cplusplus
221
222 #endif
223
224 #endif
225