Haiku: build fix
[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
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 enum eFileDataFlag {
42   FD_FLAGS_SWITCH_ENDIAN = 1 << 0,
43   FD_FLAGS_FILE_POINTSIZE_IS_4 = 1 << 1,
44   FD_FLAGS_POINTSIZE_DIFFERS = 1 << 2,
45   FD_FLAGS_FILE_OK = 1 << 3,
46   FD_FLAGS_NOT_MY_BUFFER = 1 << 4,
47   /* XXX Unused in practice (checked once but never set). */
48   FD_FLAGS_NOT_MY_LIBMAP = 1 << 5,
49 };
50
51 /* Disallow since it's 32bit on ms-windows. */
52 #ifdef __GNUC__
53 #  pragma GCC poison off_t
54 #endif
55
56 #if defined(_MSC_VER) || defined(__APPLE__) || defined(__HAIKU__)
57 typedef int64_t off64_t;
58 #endif
59
60 typedef int(FileDataReadFn)(struct FileData *filedata, void *buffer, unsigned int size);
61 typedef off64_t(FileDataSeekFn)(struct FileData *filedata, off64_t offset, int whence);
62
63 typedef struct FileData {
64   /** Linked list of BHeadN's. */
65   ListBase bhead_list;
66   enum eFileDataFlag flags;
67   bool is_eof;
68   int buffersize;
69   int64_t file_offset;
70
71   FileDataReadFn *read;
72   FileDataSeekFn *seek;
73
74   /** Regular file reading. */
75   int filedes;
76
77   /** Variables needed for reading from memory / stream. */
78   const char *buffer;
79   /** Variables needed for reading from memfile (undo). */
80   struct MemFile *memfile;
81
82   /** Variables needed for reading from file. */
83   gzFile gzfiledes;
84   /** Gzip stream for memory decompression. */
85   z_stream strm;
86
87   /** Now only in use for library appending. */
88   char relabase[FILE_MAX];
89
90   /** General reading variables. */
91   struct SDNA *filesdna;
92   const struct SDNA *memsdna;
93   /** Array of #eSDNA_StructCompare. */
94   const char *compflags;
95
96   int fileversion;
97   /** Used to retrieve ID names from (bhead+1). */
98   int id_name_offs;
99   /** For do_versions patching. */
100   int globalf, fileflags;
101
102   /** Optionally skip some data-blocks when they're not needed. */
103   eBLOReadSkip skip_flags;
104
105   struct OldNewMap *datamap;
106   struct OldNewMap *globmap;
107   struct OldNewMap *libmap;
108   struct OldNewMap *imamap;
109   struct OldNewMap *movieclipmap;
110   struct OldNewMap *scenemap;
111   struct OldNewMap *soundmap;
112   struct OldNewMap *packedmap;
113
114   struct BHeadSort *bheadmap;
115   int tot_bheadmap;
116
117   /** See: #USE_GHASH_BHEAD. */
118   struct GHash *bhead_idname_hash;
119
120   ListBase *mainlist;
121   /** Used for undo. */
122   ListBase *old_mainlist;
123
124   struct ReportList *reports;
125 } FileData;
126
127 #define SIZEOFBLENDERHEADER 12
128
129 /***/
130 struct Main;
131 void blo_join_main(ListBase *mainlist);
132 void blo_split_main(ListBase *mainlist, struct Main *main);
133
134 BlendFileData *blo_read_file_internal(FileData *fd, const char *filepath);
135
136 FileData *blo_filedata_from_file(const char *filepath, struct ReportList *reports);
137 FileData *blo_filedata_from_memory(const void *buffer, int buffersize, struct ReportList *reports);
138 FileData *blo_filedata_from_memfile(struct MemFile *memfile, struct ReportList *reports);
139
140 void blo_clear_proxy_pointers_from_lib(struct Main *oldmain);
141 void blo_make_image_pointer_map(FileData *fd, struct Main *oldmain);
142 void blo_end_image_pointer_map(FileData *fd, struct Main *oldmain);
143 void blo_make_scene_pointer_map(FileData *fd, struct Main *oldmain);
144 void blo_end_scene_pointer_map(FileData *fd, struct Main *oldmain);
145 void blo_make_movieclip_pointer_map(FileData *fd, struct Main *oldmain);
146 void blo_end_movieclip_pointer_map(FileData *fd, struct Main *oldmain);
147 void blo_make_sound_pointer_map(FileData *fd, struct Main *oldmain);
148 void blo_end_sound_pointer_map(FileData *fd, struct Main *oldmain);
149 void blo_make_packed_pointer_map(FileData *fd, struct Main *oldmain);
150 void blo_end_packed_pointer_map(FileData *fd, struct Main *oldmain);
151 void blo_add_library_pointer_map(ListBase *old_mainlist, FileData *fd);
152
153 void blo_filedata_free(FileData *fd);
154
155 BHead *blo_bhead_first(FileData *fd);
156 BHead *blo_bhead_next(FileData *fd, BHead *thisblock);
157 BHead *blo_bhead_prev(FileData *fd, BHead *thisblock);
158
159 const char *blo_bhead_id_name(const FileData *fd, const BHead *bhead);
160
161 /* do versions stuff */
162
163 void blo_reportf_wrap(struct ReportList *reports, ReportType type, const char *format, ...)
164     ATTR_PRINTF_FORMAT(3, 4);
165
166 void blo_do_versions_dna(struct SDNA *sdna, const int versionfile, const int subversionfile);
167
168 void blo_do_versions_oldnewmap_insert(struct OldNewMap *onm,
169                                       const void *oldaddr,
170                                       void *newaddr,
171                                       int nr);
172 void *blo_do_versions_newlibadr(struct FileData *fd, const void *lib, const void *adr);
173 void *blo_do_versions_newlibadr_us(struct FileData *fd, const void *lib, const void *adr);
174
175 struct PartEff *blo_do_version_give_parteff_245(struct Object *ob);
176 void blo_do_version_old_trackto_to_constraints(struct Object *ob);
177 void blo_do_versions_view3d_split_250(struct View3D *v3d, struct ListBase *regions);
178 void blo_do_versions_key_uidgen(struct Key *key);
179
180 void blo_do_versions_pre250(struct FileData *fd, struct Library *lib, struct Main *bmain);
181 void blo_do_versions_250(struct FileData *fd, struct Library *lib, struct Main *bmain);
182 void blo_do_versions_260(struct FileData *fd, struct Library *lib, struct Main *bmain);
183 void blo_do_versions_270(struct FileData *fd, struct Library *lib, struct Main *bmain);
184 void blo_do_versions_280(struct FileData *fd, struct Library *lib, struct Main *bmain);
185
186 void do_versions_after_linking_270(struct Main *bmain);
187 void do_versions_after_linking_280(struct Main *bmain);
188
189 #endif