Merge branch 'master' into blender2.8
[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 #include "DNA_sdna_types.h"
38 #include "DNA_space_types.h"
39 #include "DNA_windowmanager_types.h"  /* for ReportType */
40
41 struct OldNewMap;
42 struct MemFile;
43 struct ReportList;
44 struct Object;
45 struct PartEff;
46 struct View3D;
47 struct Key;
48
49 typedef struct FileData {
50         // linked list of BHeadN's
51         ListBase listbase;
52         int flags;
53         int eof;
54         int buffersize;
55         int seek;
56         int (*read)(struct FileData *filedata, void *buffer, unsigned int size);
57
58         // variables needed for reading from memory / stream
59         const char *buffer;
60         // variables needed for reading from memfile (undo)
61         struct MemFile *memfile;
62
63         // variables needed for reading from file
64         int filedes;
65         gzFile gzfiledes;
66
67         // now only in use for library appending
68         char relabase[FILE_MAX];
69
70         // variables needed for reading from stream
71         char headerdone;
72         int inbuffer;
73
74         // gzip stream for memory decompression
75         z_stream strm;
76
77         // general reading variables
78         struct SDNA *filesdna;
79         const struct SDNA *memsdna;
80         const char *compflags;  /* array of eSDNA_StructCompare */
81
82         int fileversion;
83         int id_name_offs;       /* used to retrieve ID names from (bhead+1) */
84         int globalf, fileflags; /* for do_versions patching */
85
86         eBLOReadSkip skip_flags;  /* skip some data-blocks */
87
88         struct OldNewMap *datamap;
89         struct OldNewMap *globmap;
90         struct OldNewMap *libmap;
91         struct OldNewMap *imamap;
92         struct OldNewMap *movieclipmap;
93         struct OldNewMap *scenemap;
94         struct OldNewMap *soundmap;
95         struct OldNewMap *packedmap;
96
97         struct BHeadSort *bheadmap;
98         int tot_bheadmap;
99
100         /* see: USE_GHASH_BHEAD */
101         struct GHash *bhead_idname_hash;
102
103         ListBase *mainlist;
104         ListBase *old_mainlist;  /* Used for undo. */
105
106         /* ick ick, used to return
107          * data through streamglue.
108          */
109         BlendFileData **bfd_r;
110         struct ReportList *reports;
111 } FileData;
112
113 typedef struct BHeadN {
114         struct BHeadN *next, *prev;
115         struct BHead bhead;
116 } BHeadN;
117
118 /* FileData->flags */
119 enum {
120         FD_FLAGS_SWITCH_ENDIAN         = 1 << 0,
121         FD_FLAGS_FILE_POINTSIZE_IS_4   = 1 << 1,
122         FD_FLAGS_POINTSIZE_DIFFERS     = 1 << 2,
123         FD_FLAGS_FILE_OK               = 1 << 3,
124         FD_FLAGS_NOT_MY_BUFFER         = 1 << 4,
125         FD_FLAGS_NOT_MY_LIBMAP         = 1 << 5,  /* XXX Unused in practice (checked once but never set). */
126 };
127
128 #define SIZEOFBLENDERHEADER 12
129
130 /***/
131 struct Main;
132 void blo_join_main(ListBase *mainlist);
133 void blo_split_main(ListBase *mainlist, struct Main *main);
134
135 BlendFileData *blo_read_file_internal(FileData *fd, const char *filepath);
136
137 FileData *blo_openblenderfile(const char *filepath, struct ReportList *reports);
138 FileData *blo_openblendermemory(const void *buffer, int buffersize, struct ReportList *reports);
139 FileData *blo_openblendermemfile(struct MemFile *memfile, struct ReportList *reports);
140
141 void blo_clear_proxy_pointers_from_lib(Main *oldmain);
142 void blo_make_image_pointer_map(FileData *fd, Main *oldmain);
143 void blo_end_image_pointer_map(FileData *fd, Main *oldmain);
144 void blo_make_scene_pointer_map(FileData *fd, Main *oldmain);
145 void blo_end_scene_pointer_map(FileData *fd, Main *oldmain);
146 void blo_make_movieclip_pointer_map(FileData *fd, Main *oldmain);
147 void blo_end_movieclip_pointer_map(FileData *fd, Main *oldmain);
148 void blo_make_sound_pointer_map(FileData *fd, Main *oldmain);
149 void blo_end_sound_pointer_map(FileData *fd, Main *oldmain);
150 void blo_make_packed_pointer_map(FileData *fd, Main *oldmain);
151 void blo_end_packed_pointer_map(FileData *fd, Main *oldmain);
152 void blo_add_library_pointer_map(ListBase *old_mainlist, FileData *fd);
153
154 void blo_freefiledata(FileData *fd);
155
156 BHead *blo_firstbhead(FileData *fd);
157 BHead *blo_nextbhead(FileData *fd, BHead *thisblock);
158 BHead *blo_prevbhead(FileData *fd, BHead *thisblock);
159
160 const char *bhead_id_name(const FileData *fd, const BHead *bhead);
161
162 /* do versions stuff */
163
164 void blo_reportf_wrap(struct ReportList *reports, ReportType type, const char *format, ...) ATTR_PRINTF_FORMAT(3, 4);
165
166 void blo_do_versions_oldnewmap_insert(struct OldNewMap *onm, const void *oldaddr, void *newaddr, int nr);
167 void *blo_do_versions_newlibadr(struct FileData *fd, const void *lib, const void *adr);
168 void *blo_do_versions_newlibadr_us(struct FileData *fd, const void *lib, const void *adr);
169
170 struct PartEff *blo_do_version_give_parteff_245(struct Object *ob);
171 void blo_do_version_old_trackto_to_constraints(struct Object *ob);
172 void blo_do_versions_view3d_split_250(struct View3D *v3d, struct ListBase *regions);
173 void blo_do_versions_key_uidgen(struct Key *key);
174
175 void blo_do_versions_pre250(struct FileData *fd, struct Library *lib, struct Main *bmain);
176 void blo_do_versions_250(struct FileData *fd, struct Library *lib, struct Main *bmain);
177 void blo_do_versions_260(struct FileData *fd, struct Library *lib, struct Main *bmain);
178 void blo_do_versions_270(struct FileData *fd, struct Library *lib, struct Main *bmain);
179 void blo_do_versions_280(struct FileData *fd, struct Library *lib, struct Main *bmain);
180
181 void do_versions_after_linking_270(struct Main *bmain);
182 void do_versions_after_linking_280(struct Main *bmain);
183
184 #endif