Filling in branch from trunk
[blender.git] / source / blender / blenloader / intern / readfile.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL 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. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  * blenloader readfile private function prototypes
32  */
33 #ifndef READFILE_H
34 #define READFILE_H
35
36 #include "zlib.h"
37
38 struct OldNewMap;
39 struct MemFile;
40
41 typedef struct FileData {
42         // linked list of BHeadN's
43         ListBase listbase;
44         int flags;
45         int eof;
46         int buffersize;
47         int seek;
48         int (*read)(struct FileData *filedata, void *buffer, int size);
49
50         // variables needed for reading from memory / stream
51         char *buffer;
52         // variables needed for reading from memfile (undo)
53         struct MemFile *memfile;
54
55         // variables needed for reading from file
56         int filedes;
57         gzFile gzfiledes;
58
59         // now only in use for library appending
60         char filename[FILE_MAXDIR+FILE_MAXFILE];
61         
62         // variables needed for reading from stream
63         char headerdone;
64         int inbuffer;
65         
66         // general reading variables
67         struct SDNA *filesdna;
68         struct SDNA *memsdna;
69         char *compflags;
70         
71         int fileversion;
72         int id_name_offs;               /* used to retrieve ID names from (bhead+1) */
73         
74         struct OldNewMap *datamap;
75         struct OldNewMap *globmap;
76         struct OldNewMap *libmap;
77         struct OldNewMap *imamap;
78         
79         ListBase mainlist;
80         
81                 /* ick ick, used to return
82                  * data through streamglue.
83                  */
84         BlendFileData **bfd_r;
85         BlendReadError *error_r;
86 } FileData;
87
88 typedef struct BHeadN {
89         struct BHeadN *next, *prev;
90         struct BHead bhead;
91 } BHeadN;
92
93
94 #define FD_FLAGS_SWITCH_ENDIAN             (1<<0)
95 #define FD_FLAGS_FILE_POINTSIZE_IS_4       (1<<1)
96 #define FD_FLAGS_POINTSIZE_DIFFERS         (1<<2)
97 #define FD_FLAGS_FILE_OK                   (1<<3)
98 #define FD_FLAGS_NOT_MY_BUFFER                     (1<<4)
99 #define FD_FLAGS_NOT_MY_LIBMAP                     (1<<5)
100
101 #define SIZEOFBLENDERHEADER 12
102
103         /***/
104 struct Main;
105 void blo_join_main(ListBase *mainlist);
106 void blo_split_main(ListBase *mainlist, struct Main *main);
107
108 BlendFileData *blo_read_file_internal( FileData *fd,  BlendReadError *error_r);
109
110 FileData *blo_openblenderfile( char *name, BlendReadError *error_r);
111 FileData *blo_openblendermemory( void *buffer, int buffersize, BlendReadError *error_r);
112 FileData *blo_openblendermemfile(struct MemFile *memfile, BlendReadError *error_r);
113
114 void blo_make_image_pointer_map(FileData *fd);
115 void blo_end_image_pointer_map(FileData *fd);
116 void blo_add_library_pointer_map(ListBase *mainlist, FileData *fd);
117
118 void blo_freefiledata( FileData *fd);
119
120 BHead *blo_firstbhead(FileData *fd);
121 BHead *blo_nextbhead(FileData *fd, BHead *thisblock);
122 BHead *blo_prevbhead(FileData *fd, BHead *thisblock);
123
124 char *bhead_id_name(FileData *fd, BHead *bhead);
125
126 #endif
127