a3aa8e783a0955c5d5adea57acc9a494c7f2214f
[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 struct Object;
43 struct PartEff;
44 struct View3D;
45 struct bNodeTree;
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         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         // general reading variables
73         struct SDNA *filesdna;
74         struct SDNA *memsdna;
75         char *compflags;
76         
77         int fileversion;
78         int id_name_offs;       /* used to retrieve ID names from (bhead+1) */
79         int globalf, fileflags; /* for do_versions patching */
80         
81         struct OldNewMap *datamap;
82         struct OldNewMap *globmap;
83         struct OldNewMap *libmap;
84         struct OldNewMap *imamap;
85         struct OldNewMap *movieclipmap;
86         
87         struct bheadsort *bheadmap;
88         int tot_bheadmap;
89         
90         ListBase *mainlist;
91         
92         /* ick ick, used to return
93          * data through streamglue.
94          */
95         BlendFileData **bfd_r;
96         struct ReportList *reports;
97 } FileData;
98
99 typedef struct BHeadN {
100         struct BHeadN *next, *prev;
101         struct BHead bhead;
102 } BHeadN;
103
104
105 #define FD_FLAGS_SWITCH_ENDIAN             (1 << 0)
106 #define FD_FLAGS_FILE_POINTSIZE_IS_4       (1 << 1)
107 #define FD_FLAGS_POINTSIZE_DIFFERS         (1 << 2)
108 #define FD_FLAGS_FILE_OK                   (1 << 3)
109 #define FD_FLAGS_NOT_MY_BUFFER             (1 << 4)
110 #define FD_FLAGS_NOT_MY_LIBMAP             (1 << 5)
111
112 #define SIZEOFBLENDERHEADER 12
113
114 /***/
115 struct Main;
116 void blo_join_main(ListBase *mainlist);
117 void blo_split_main(ListBase *mainlist, struct Main *main);
118
119 BlendFileData *blo_read_file_internal(FileData *fd, const char *filepath);
120
121 FileData *blo_openblenderfile(const char *filepath, struct ReportList *reports);
122 FileData *blo_openblendermemory(void *buffer, int buffersize, struct ReportList *reports);
123 FileData *blo_openblendermemfile(struct MemFile *memfile, struct ReportList *reports);
124
125 void blo_clear_proxy_pointers_from_lib(Main *oldmain);
126 void blo_make_image_pointer_map(FileData *fd, Main *oldmain);
127 void blo_end_image_pointer_map(FileData *fd, Main *oldmain);
128 void blo_make_movieclip_pointer_map(FileData *fd, Main *oldmain);
129 void blo_end_movieclip_pointer_map(FileData *fd, Main *oldmain);
130 void blo_add_library_pointer_map(ListBase *mainlist, FileData *fd);
131
132 void blo_freefiledata(FileData *fd);
133
134 BHead *blo_firstbhead(FileData *fd);
135 BHead *blo_nextbhead(FileData *fd, BHead *thisblock);
136 BHead *blo_prevbhead(FileData *fd, BHead *thisblock);
137
138 char *bhead_id_name(FileData *fd, BHead *bhead);
139
140 /* do versions stuff */
141
142 void blo_do_versions_oldnewmap_insert(struct OldNewMap *onm, void *oldaddr, void *newaddr, int nr);
143 void *blo_do_versions_newlibadr(struct FileData *fd, void *lib, void *adr);
144 void *blo_do_versions_newlibadr_us(struct FileData *fd, void *lib, void *adr);
145
146 struct PartEff *blo_do_version_give_parteff_245(struct Object *ob);
147 void blo_do_version_old_trackto_to_constraints(struct Object *ob);
148 void blo_do_versions_view3d_split_250(struct View3D *v3d, struct ListBase *regions);
149 void blo_do_versions_nodetree_default_value(struct bNodeTree *ntree);
150
151 void blo_do_versions_pre250(struct FileData *fd, struct Library *lib, struct Main *main);
152 void blo_do_versions_250(struct FileData *fd, struct Library *lib, struct Main *main);
153
154 #endif
155