commit before doing some hefty shapekey change, will break compilation
[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         char filename[240];     /* 240 = 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 file 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              (char *file, struct ReportList *reports);
84
85         /**
86          * Open a blender file from memory. The function
87          * returns NULL and sets a report in the list if
88          * it cannot open the file.
89          * 
90          * @param mem The file data.
91          * @param memsize The length of @a mem.
92          * @param reports If the return value is NULL, errors
93          * indicating the cause of the failure.
94          * @return The data of the file.
95          */
96 BlendFileData*  BLO_read_from_memory(void *mem, int memsize, struct ReportList *reports);
97
98 /**
99  * oldmain is old main, from which we will keep libraries, images, ..
100  * file name is current file, only for retrieving library data */
101
102 BlendFileData *BLO_read_from_memfile(struct Main *oldmain, const char *filename, struct MemFile *memfile, struct ReportList *reports);
103
104 /**
105  * Free's a BlendFileData structure and _all_ the
106  * data associated with it (the userdef data, and
107  * the main libblock data).
108  * 
109  * @param bfd The structure to free.
110  */
111         void
112 BLO_blendfiledata_free(
113         BlendFileData *bfd);
114
115 /**
116  * Convert an idcode into a name.
117  * 
118  * @param code The code to convert.
119  * @return A static string representing the name of
120  * the code.
121  */
122         char*
123 BLO_idcode_to_name(
124         int code);
125
126 /**
127  * Convert a name into an idcode (ie. ID_SCE)
128  * 
129  * @param name The name to convert.
130  * @return The code for the name, or 0 if invalid.
131  */
132         int
133 BLO_idcode_from_name(
134         char *name);
135         
136 /**
137  * Open a blendhandle from a file path.
138  * 
139  * @param file The file path to open.
140  * @return A handle on success, or NULL on failure.
141  */
142         BlendHandle*
143 BLO_blendhandle_from_file(
144         char *file);
145
146 /**
147  * Gets the names of all the datablocks in a file
148  * of a certain type (ie. All the scene names in
149  * a file).
150  * 
151  * @param bh The blendhandle to access.
152  * @param ofblocktype The type of names to get.
153  * @return A BLI_linklist of strings. The string links
154  * should be freed with malloc.
155  */
156         struct LinkNode*
157 BLO_blendhandle_get_datablock_names(
158         BlendHandle *bh, 
159         int ofblocktype);
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(char *path, char *dir, char *group);
209
210 struct Main* BLO_library_append_begin(const struct bContext *C, BlendHandle** bh, char *dir);
211 void BLO_library_append_named_part(const struct bContext *C, struct Main *mainl, BlendHandle** bh, char *name, int idcode, short flag);
212 void BLO_library_append_end(const struct bContext *C, struct Main *mainl, BlendHandle** bh, int idcode, short flag);
213
214 /* deprecated */
215 #if 1
216 void BLO_script_library_append(BlendHandle **bh, char *dir, char *name, int idcode, short flag, struct Main *mainvar, struct Scene *scene, struct ReportList *reports);
217 #endif
218
219 BlendFileData* blo_read_blendafterruntime(int file, char *name, int actualsize, struct ReportList *reports);
220
221 #ifdef __cplusplus
222
223 #endif
224
225 #endif
226