GPencil: Minor changes in parameter order
[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 #pragma once
26
27 #ifdef WIN32
28 #  include "BLI_winstuff.h"
29 #endif
30
31 #include "DNA_sdna_types.h"
32 #include "DNA_space_types.h"
33 #include "DNA_windowmanager_types.h" /* for ReportType */
34 #include "zlib.h"
35
36 struct BLOCacheStorage;
37 struct GSet;
38 struct IDNameLib_Map;
39 struct Key;
40 struct MemFile;
41 struct Object;
42 struct OldNewMap;
43 struct PartEff;
44 struct ReportList;
45 struct UserDef;
46 struct View3D;
47
48 typedef struct IDNameLib_Map IDNameLib_Map;
49
50 enum eFileDataFlag {
51   FD_FLAGS_SWITCH_ENDIAN = 1 << 0,
52   FD_FLAGS_FILE_POINTSIZE_IS_4 = 1 << 1,
53   FD_FLAGS_POINTSIZE_DIFFERS = 1 << 2,
54   FD_FLAGS_FILE_OK = 1 << 3,
55   FD_FLAGS_NOT_MY_BUFFER = 1 << 4,
56   /* XXX Unused in practice (checked once but never set). */
57   FD_FLAGS_NOT_MY_LIBMAP = 1 << 5,
58 };
59
60 /* Disallow since it's 32bit on ms-windows. */
61 #ifdef __GNUC__
62 #  pragma GCC poison off_t
63 #endif
64
65 #if defined(_MSC_VER) || defined(__APPLE__) || defined(__HAIKU__) || defined(__NetBSD__)
66 typedef int64_t off64_t;
67 #endif
68
69 typedef ssize_t(FileDataReadFn)(struct FileData *filedata,
70                                 void *buffer,
71                                 size_t size,
72                                 bool *r_is_memchunk_identical);
73 typedef off64_t(FileDataSeekFn)(struct FileData *filedata, off64_t offset, int whence);
74
75 typedef struct FileData {
76   /** Linked list of BHeadN's. */
77   ListBase bhead_list;
78   enum eFileDataFlag flags;
79   bool is_eof;
80   size_t buffersize;
81   off64_t file_offset;
82
83   FileDataReadFn *read;
84   FileDataSeekFn *seek;
85
86   /** Regular file reading. */
87   int filedes;
88
89   /** Variables needed for reading from memory / stream. */
90   const char *buffer;
91   /** Variables needed for reading from memfile (undo). */
92   struct MemFile *memfile;
93   /** Whether we are undoing (< 0) or redoing (> 0), used to choose which 'unchanged' flag to use
94    * to detect unchanged data from memfile. */
95   short undo_direction;
96
97   /** Variables needed for reading from file. */
98   gzFile gzfiledes;
99   /** Gzip stream for memory decompression. */
100   z_stream strm;
101
102   /** Now only in use for library appending. */
103   char relabase[FILE_MAX];
104
105   /** General reading variables. */
106   struct SDNA *filesdna;
107   const struct SDNA *memsdna;
108   /** Array of #eSDNA_StructCompare. */
109   const char *compflags;
110   struct DNA_ReconstructInfo *reconstruct_info;
111
112   int fileversion;
113   /** Used to retrieve ID names from (bhead+1). */
114   int id_name_offs;
115   /** For do_versions patching. */
116   int globalf, fileflags;
117
118   /** Optionally skip some data-blocks when they're not needed. */
119   eBLOReadSkip skip_flags;
120
121   struct OldNewMap *datamap;
122   struct OldNewMap *globmap;
123   struct OldNewMap *libmap;
124   struct OldNewMap *packedmap;
125   struct BLOCacheStorage *cache_storage;
126
127   struct BHeadSort *bheadmap;
128   int tot_bheadmap;
129
130   /** See: #USE_GHASH_BHEAD. */
131   struct GHash *bhead_idname_hash;
132
133   ListBase *mainlist;
134   /** Used for undo. */
135   ListBase *old_mainlist;
136   struct IDNameLib_Map *old_idmap;
137
138   struct ReportList *reports;
139 } FileData;
140
141 #define SIZEOFBLENDERHEADER 12
142
143 /***/
144 struct Main;
145 void blo_join_main(ListBase *mainlist);
146 void blo_split_main(ListBase *mainlist, struct Main *main);
147
148 BlendFileData *blo_read_file_internal(FileData *fd, const char *filepath);
149
150 FileData *blo_filedata_from_file(const char *filepath, struct ReportList *reports);
151 FileData *blo_filedata_from_memory(const void *mem, int memsize, struct ReportList *reports);
152 FileData *blo_filedata_from_memfile(struct MemFile *memfile,
153                                     const struct BlendFileReadParams *params,
154                                     struct ReportList *reports);
155
156 void blo_clear_proxy_pointers_from_lib(struct Main *oldmain);
157 void blo_make_packed_pointer_map(FileData *fd, struct Main *oldmain);
158 void blo_end_packed_pointer_map(FileData *fd, struct Main *oldmain);
159 void blo_add_library_pointer_map(ListBase *old_mainlist, FileData *fd);
160 void blo_make_old_idmap_from_main(FileData *fd, struct Main *bmain);
161
162 void blo_cache_storage_init(FileData *fd, struct Main *bmain);
163 void blo_cache_storage_old_bmain_clear(FileData *fd, struct Main *bmain_old);
164 void blo_cache_storage_end(FileData *fd);
165
166 void blo_filedata_free(FileData *fd);
167
168 BHead *blo_bhead_first(FileData *fd);
169 BHead *blo_bhead_next(FileData *fd, BHead *thisblock);
170 BHead *blo_bhead_prev(FileData *fd, BHead *thisblock);
171
172 const char *blo_bhead_id_name(const FileData *fd, const BHead *bhead);
173
174 /* do versions stuff */
175
176 void blo_reportf_wrap(struct ReportList *reports, ReportType type, const char *format, ...)
177     ATTR_PRINTF_FORMAT(3, 4);
178
179 void blo_do_versions_dna(struct SDNA *sdna, const int versionfile, const int subversionfile);
180
181 void blo_do_versions_oldnewmap_insert(struct OldNewMap *onm,
182                                       const void *oldaddr,
183                                       void *newaddr,
184                                       int nr);
185 void *blo_do_versions_newlibadr(struct FileData *fd, const void *lib, const void *adr);
186 void *blo_do_versions_newlibadr_us(struct FileData *fd, const void *lib, const void *adr);
187
188 struct PartEff *blo_do_version_give_parteff_245(struct Object *ob);
189 void blo_do_version_old_trackto_to_constraints(struct Object *ob);
190 void blo_do_versions_view3d_split_250(struct View3D *v3d, struct ListBase *regions);
191 void blo_do_versions_key_uidgen(struct Key *key);
192
193 void blo_do_versions_userdef(struct UserDef *userdef);
194
195 void blo_do_versions_pre250(struct FileData *fd, struct Library *lib, struct Main *bmain);
196 void blo_do_versions_250(struct FileData *fd, struct Library *lib, struct Main *bmain);
197 void blo_do_versions_260(struct FileData *fd, struct Library *lib, struct Main *bmain);
198 void blo_do_versions_270(struct FileData *fd, struct Library *lib, struct Main *bmain);
199 void blo_do_versions_280(struct FileData *fd, struct Library *lib, struct Main *bmain);
200 void blo_do_versions_290(struct FileData *fd, struct Library *lib, struct Main *bmain);
201 void blo_do_versions_cycles(struct FileData *fd, struct Library *lib, struct Main *bmain);
202
203 void do_versions_after_linking_250(struct Main *bmain);
204 void do_versions_after_linking_260(struct Main *bmain);
205 void do_versions_after_linking_270(struct Main *bmain);
206 void do_versions_after_linking_280(struct Main *bmain, struct ReportList *reports);
207 void do_versions_after_linking_290(struct Main *bmain, struct ReportList *reports);
208 void do_versions_after_linking_cycles(struct Main *bmain);
209
210 /* This is rather unfortunate to have to expose this here, but better use that nasty hack in
211  * do_version than readfile itself. */
212 void *blo_read_get_new_globaldata_address(struct FileData *fd, const void *adr);