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