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