minor edits, no functional changes.
[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  * 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(const 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  * Open a blendhandle from a file path.
117  * 
118  * @param file The file path to open.
119  * @return A handle on success, or NULL on failure.
120  */
121         BlendHandle*
122 BLO_blendhandle_from_file(
123         char *file);
124
125 /**
126  * Open a blendhandle from memory.
127  *
128  * @param mem The data to load from.
129  * @param memsize The size of the data.
130  * @return A handle on success, or NULL on failure.
131  */
132
133         BlendHandle*
134 BLO_blendhandle_from_memory(
135         void *mem,
136         int memsize);
137
138 /**
139  * Gets the names of all the datablocks in a file
140  * of a certain type (ie. All the scene names in
141  * a file).
142  * 
143  * @param bh The blendhandle to access.
144  * @param ofblocktype The type of names to get.
145  * @return A BLI_linklist of strings. The string links
146  * should be freed with malloc.
147  */
148         struct LinkNode*
149 BLO_blendhandle_get_datablock_names(
150         BlendHandle *bh, 
151         int ofblocktype);
152
153 /**
154  * Gets the previews of all the datablocks in a file
155  * of a certain type (ie. All the scene names in
156  * a file).
157  * 
158  * @param bh The blendhandle to access.
159  * @param ofblocktype The type of names to get.
160  * @return A BLI_linklist of PreviewImage. The PreviewImage links
161  * should be freed with malloc.
162  */
163         struct LinkNode*
164 BLO_blendhandle_get_previews(
165         BlendHandle *bh, 
166         int ofblocktype);
167
168 /**
169  * Gets the names of all the datablock groups in a
170  * file. (ie. file contains Scene, Mesh, and Lamp
171  * datablocks).
172  * 
173  * @param bh The blendhandle to access.
174  * @return A BLI_linklist of strings. The string links
175  * should be freed with malloc.
176  */
177         struct LinkNode*
178 BLO_blendhandle_get_linkable_groups(
179         BlendHandle *bh);
180
181 /**
182  * Close and free a blendhandle. The handle
183  * becomes invalid after this call.
184  *
185  * @param bh The handle to close.
186  */
187         void
188 BLO_blendhandle_close(
189         BlendHandle *bh);
190         
191         /***/
192
193 #define GROUP_MAX 32
194
195 int BLO_has_bfile_extension(char *str);
196
197 /* return ok when a blenderfile, in dir is the filename,
198  * in group the type of libdata
199  */
200 int BLO_is_a_library(const char *path, char *dir, char *group);
201
202 struct Main* BLO_library_append_begin(const struct bContext *C, BlendHandle** bh, char *dir);
203 void BLO_library_append_named_part(const struct bContext *C, struct Main *mainl, BlendHandle** bh, const char *name, int idcode, short flag);
204 void BLO_library_append_end(const struct bContext *C, struct Main *mainl, BlendHandle** bh, int idcode, short flag);
205
206 /* deprecated */
207 #if 1
208 void BLO_script_library_append(BlendHandle **bh, char *dir, char *name, int idcode, short flag, struct Main *mainvar, struct Scene *scene, struct ReportList *reports);
209 #endif
210
211 BlendFileData* blo_read_blendafterruntime(int file, char *name, int actualsize, struct ReportList *reports);
212
213 #ifdef __cplusplus
214
215 #endif
216
217 #endif
218