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