readfile: report SDNA decoding errors on file read
[blender.git] / source / blender / blenloader / intern / readfile.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  * blenloader readfile private function prototypes
27  */
28
29 /** \file blender/blenloader/intern/readfile.h
30  *  \ingroup blenloader
31  */
32
33 #ifndef __READFILE_H__
34 #define __READFILE_H__
35
36 #include "zlib.h"
37 #include "DNA_windowmanager_types.h"  /* for ReportType */
38
39 struct OldNewMap;
40 struct MemFile;
41 struct ReportList;
42 struct Object;
43 struct PartEff;
44 struct View3D;
45 struct Key;
46
47 typedef struct FileData {
48         // linked list of BHeadN's
49         ListBase listbase;
50         int flags;
51         int eof;
52         int buffersize;
53         int seek;
54         int (*read)(struct FileData *filedata, void *buffer, unsigned int size);
55
56         // variables needed for reading from memory / stream
57         const char *buffer;
58         // variables needed for reading from memfile (undo)
59         struct MemFile *memfile;
60
61         // variables needed for reading from file
62         int filedes;
63         gzFile gzfiledes;
64
65         // now only in use for library appending
66         char relabase[FILE_MAX];
67         
68         // variables needed for reading from stream
69         char headerdone;
70         int inbuffer;
71         
72         // gzip stream for memory decompression
73         z_stream strm;
74         
75         // general reading variables
76         struct SDNA *filesdna;
77         struct SDNA *memsdna;
78         char *compflags;        /* array of eSDNA_StructCompare */
79         
80         int fileversion;
81         int id_name_offs;       /* used to retrieve ID names from (bhead+1) */
82         int globalf, fileflags; /* for do_versions patching */
83         
84         struct OldNewMap *datamap;
85         struct OldNewMap *globmap;
86         struct OldNewMap *libmap;
87         struct OldNewMap *imamap;
88         struct OldNewMap *movieclipmap;
89         struct OldNewMap *soundmap;
90         struct OldNewMap *packedmap;
91         
92         struct BHeadSort *bheadmap;
93         int tot_bheadmap;
94
95         /* see: USE_GHASH_BHEAD */
96         struct GHash *bhead_idname_hash;
97         
98         ListBase *mainlist;
99         ListBase *old_mainlist;  /* Used for undo. */
100
101         /* ick ick, used to return
102          * data through streamglue.
103          */
104         BlendFileData **bfd_r;
105         struct ReportList *reports;
106 } FileData;
107
108 typedef struct BHeadN {
109         struct BHeadN *next, *prev;
110         struct BHead bhead;
111 } BHeadN;
112
113 /* FileData->flags */
114 enum {
115         FD_FLAGS_SWITCH_ENDIAN         = 1 << 0,
116         FD_FLAGS_FILE_POINTSIZE_IS_4   = 1 << 1,
117         FD_FLAGS_POINTSIZE_DIFFERS     = 1 << 2,
118         FD_FLAGS_FILE_OK               = 1 << 3,
119         FD_FLAGS_NOT_MY_BUFFER         = 1 << 4,
120         FD_FLAGS_NOT_MY_LIBMAP         = 1 << 5,  /* XXX Unused in practice (checked once but never set). */
121 };
122
123 #define SIZEOFBLENDERHEADER 12
124
125 /***/
126 struct Main;
127 void blo_join_main(ListBase *mainlist);
128 void blo_split_main(ListBase *mainlist, struct Main *main);
129
130 BlendFileData *blo_read_file_internal(FileData *fd, const char *filepath);
131
132 FileData *blo_openblenderfile(const char *filepath, struct ReportList *reports);
133 FileData *blo_openblendermemory(const void *buffer, int buffersize, struct ReportList *reports);
134 FileData *blo_openblendermemfile(struct MemFile *memfile, struct ReportList *reports);
135
136 void blo_clear_proxy_pointers_from_lib(Main *oldmain);
137 void blo_make_image_pointer_map(FileData *fd, Main *oldmain);
138 void blo_end_image_pointer_map(FileData *fd, Main *oldmain);
139 void blo_make_movieclip_pointer_map(FileData *fd, Main *oldmain);
140 void blo_end_movieclip_pointer_map(FileData *fd, Main *oldmain);
141 void blo_make_sound_pointer_map(FileData *fd, Main *oldmain);
142 void blo_end_sound_pointer_map(FileData *fd, Main *oldmain);
143 void blo_make_packed_pointer_map(FileData *fd, Main *oldmain);
144 void blo_end_packed_pointer_map(FileData *fd, Main *oldmain);
145 void blo_add_library_pointer_map(ListBase *old_mainlist, FileData *fd);
146
147 void blo_freefiledata(FileData *fd);
148
149 BHead *blo_firstbhead(FileData *fd);
150 BHead *blo_nextbhead(FileData *fd, BHead *thisblock);
151 BHead *blo_prevbhead(FileData *fd, BHead *thisblock);
152
153 const char *bhead_id_name(const FileData *fd, const BHead *bhead);
154
155 /* do versions stuff */
156
157 void blo_reportf_wrap(struct ReportList *reports, ReportType type, const char *format, ...) ATTR_PRINTF_FORMAT(3, 4);
158
159 void blo_do_versions_oldnewmap_insert(struct OldNewMap *onm, const void *oldaddr, void *newaddr, int nr);
160 void *blo_do_versions_newlibadr(struct FileData *fd, const void *lib, const void *adr);
161 void *blo_do_versions_newlibadr_us(struct FileData *fd, const void *lib, const void *adr);
162
163 struct PartEff *blo_do_version_give_parteff_245(struct Object *ob);
164 void blo_do_version_old_trackto_to_constraints(struct Object *ob);
165 void blo_do_versions_view3d_split_250(struct View3D *v3d, struct ListBase *regions);
166 void blo_do_versions_key_uidgen(struct Key *key);
167
168 void blo_do_versions_pre250(struct FileData *fd, struct Library *lib, struct Main *main);
169 void blo_do_versions_250(struct FileData *fd, struct Library *lib, struct Main *main);
170 void blo_do_versions_260(struct FileData *fd, struct Library *lib, struct Main *main);
171 void blo_do_versions_270(struct FileData *fd, struct Library *lib, struct Main *main);
172
173 #endif
174