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