2.5: Error reporting
[blender.git] / source / blender / blenloader / intern / 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  * blenloader readfile private function prototypes
29  */
30 #ifndef READFILE_H
31 #define READFILE_H
32
33 #include "zlib.h"
34
35 struct OldNewMap;
36 struct MemFile;
37 struct bheadsort;
38 struct ReportList;
39
40 typedef struct FileData {
41         // linked list of BHeadN's
42         ListBase listbase;
43         int flags;
44         int eof;
45         int buffersize;
46         int seek;
47         int (*read)(struct FileData *filedata, void *buffer, int size);
48
49         // variables needed for reading from memory / stream
50         char *buffer;
51         // variables needed for reading from memfile (undo)
52         struct MemFile *memfile;
53
54         // variables needed for reading from file
55         int filedes;
56         gzFile gzfiledes;
57
58         // now only in use for library appending
59         char filename[FILE_MAXDIR+FILE_MAXFILE];
60         
61         // variables needed for reading from stream
62         char headerdone;
63         int inbuffer;
64         
65         // general reading variables
66         struct SDNA *filesdna;
67         struct SDNA *memsdna;
68         char *compflags;
69         
70         int fileversion;
71         int id_name_offs;               /* used to retrieve ID names from (bhead+1) */
72         
73         struct OldNewMap *datamap;
74         struct OldNewMap *globmap;
75         struct OldNewMap *libmap;
76         struct OldNewMap *imamap;
77         
78         struct bheadsort *bheadmap;
79         int tot_bheadmap;
80         
81         ListBase mainlist;
82         
83                 /* ick ick, used to return
84                  * data through streamglue.
85                  */
86         BlendFileData **bfd_r;
87         struct ReportList *reports;
88 } FileData;
89
90 typedef struct BHeadN {
91         struct BHeadN *next, *prev;
92         struct BHead bhead;
93 } BHeadN;
94
95
96 #define FD_FLAGS_SWITCH_ENDIAN             (1<<0)
97 #define FD_FLAGS_FILE_POINTSIZE_IS_4       (1<<1)
98 #define FD_FLAGS_POINTSIZE_DIFFERS         (1<<2)
99 #define FD_FLAGS_FILE_OK                   (1<<3)
100 #define FD_FLAGS_NOT_MY_BUFFER                     (1<<4)
101 #define FD_FLAGS_NOT_MY_LIBMAP                     (1<<5)
102
103 #define SIZEOFBLENDERHEADER 12
104
105         /***/
106 struct Main;
107 void blo_join_main(ListBase *mainlist);
108 void blo_split_main(ListBase *mainlist, struct Main *main);
109
110 BlendFileData *blo_read_file_internal(FileData *fd);
111
112 FileData *blo_openblenderfile(char *name, struct ReportList *reports);
113 FileData *blo_openblendermemory(void *buffer, int buffersize, struct ReportList *reports);
114 FileData *blo_openblendermemfile(struct MemFile *memfile, struct ReportList *reports);
115
116 void blo_clear_proxy_pointers_from_lib(FileData *fd, Main *oldmain);
117 void blo_make_image_pointer_map(FileData *fd, Main *oldmain);
118 void blo_end_image_pointer_map(FileData *fd, Main *oldmain);
119 void blo_add_library_pointer_map(ListBase *mainlist, FileData *fd);
120
121 void blo_freefiledata( FileData *fd);
122
123 BHead *blo_firstbhead(FileData *fd);
124 BHead *blo_nextbhead(FileData *fd, BHead *thisblock);
125 BHead *blo_prevbhead(FileData *fd, BHead *thisblock);
126
127 char *bhead_id_name(FileData *fd, BHead *bhead);
128
129 #endif
130