Blender V5.3
readfile.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
9
10#pragma once
11
12#include <cstdio> /* IWYU pragma: keep. Include header using off_t before poisoning it below. */
13#include <optional>
14
15#ifdef WIN32
16# include "BLI_winstuff.hh"
17#endif
18
19#include "BLI_enum_flags.hh"
20#include "BLI_fileops.hh"
21#include "BLI_filereader.hh"
22#include "BLI_map.hh"
23
24#include "DNA_sdna_types.h"
25#include "DNA_space_types.h"
26
27#include "BLO_core_bhead.hh"
29#include "BLO_readfile.hh"
30
31namespace blender {
32
33struct BlendFileData;
37struct BLOCacheStorage;
38struct BHeadN;
39struct BHeadSort;
41struct IDNameLib_Map;
42struct Key;
43struct Main;
44struct MemFile;
45struct Object;
46struct OldNewMap;
47struct UserDef;
48
70
71/* Disallow since it's 32bit on ms-windows. */
72#ifdef __GNUC__
73# pragma GCC poison off_t
74#endif
75
82struct FileData {
84 ListBaseT<BHeadN> bhead_list = {};
86 bool is_eof = false;
88
89 FileReader *file = nullptr;
90 std::optional<BLI_stat_t> file_stat;
91
98
108 char relabase[FILE_MAX] = {};
109
111 std::unique_ptr<SDNA> filesdna;
112 const SDNA *memsdna = nullptr;
114 const char *compflags = nullptr;
116
117 int fileversion = 0;
123
140 int globalf = 0;
141 int fileflags = 0;
142
145
153
154 OldNewMap *datamap = nullptr;
155 OldNewMap *globmap = nullptr;
157 std::shared_ptr<Map<IDHash, ID *>> id_by_deep_hash;
158
164 OldNewMap *libmap = nullptr;
165
167
168 BHeadSort *bheadmap = nullptr;
170
171 std::optional<Map<StringRefNull, BHead *>> bhead_idname_map;
172
180 Main *bmain = nullptr;
182 Main *old_bmain = nullptr;
189 Main *fd_bmain = nullptr;
190
207
209
211 void *storage_handle = nullptr;
212
217};
218
229void blo_split_main(Main *bmain, bool do_split_packed_ids = true);
234void blo_join_main(Main *bmain);
235
236BlendFileData *blo_read_file_internal(FileData *fd, const char *filepath) ATTR_NONNULL(1, 2);
237
243FileData *blo_filedata_from_file(const char *filepath, BlendFileReadReport *reports);
244FileData *blo_filedata_from_memory(const void *mem, int memsize, BlendFileReadReport *reports);
246 const BlendFileReadParams *params,
247 BlendFileReadReport *reports);
248
254
255BHead *blo_read_asset_data_block(FileData *fd, BHead *bhead, AssetMetaData **r_asset_data)
256 ATTR_NONNULL(1, 2);
257
258void blo_cache_storage_init(FileData *fd, Main *bmain) ATTR_NONNULL(1, 2);
261
263
265BHead *blo_bhead_next(FileData *fd, BHead *thisblock) ATTR_NONNULL(1);
266BHead *blo_bhead_prev(FileData *fd, BHead *thisblock) ATTR_NONNULL(1, 2);
267
275const char *blo_bhead_id_name(FileData *fd, const BHead *bhead);
282short blo_bhead_id_flag(const FileData *fd, const BHead *bhead);
287
294const char *blo_bhead_library_filepath(const FileData *fd, const BHead *bhead);
300LibraryFlag blo_bhead_library_flag(const FileData *fd, const BHead *bhead);
301
302/* do versions stuff */
303
313void blo_do_versions_dna(SDNA *sdna, int versionfile, int subversionfile);
314
315void blo_do_versions_oldnewmap_insert(OldNewMap *onm, const void *oldaddr, void *newaddr, int nr);
320 ID *self_id,
321 const bool is_linked_only,
322 const void *adr);
323
330
334void blo_do_versions_userdef(UserDef *userdef);
335
336void blo_do_versions_pre250(FileData *fd, Library *lib, Main *bmain);
337void blo_do_versions_250(FileData *fd, Library *lib, Main *bmain);
338void blo_do_versions_260(FileData *fd, Library *lib, Main *bmain);
339void blo_do_versions_270(FileData *fd, Library *lib, Main *bmain);
340void blo_do_versions_280(FileData *fd, Library *lib, Main *bmain);
341void blo_do_versions_290(FileData *fd, Library *lib, Main *bmain);
342void blo_do_versions_300(FileData *fd, Library *lib, Main *bmain);
343void blo_do_versions_400(FileData *fd, Library *lib, Main *bmain);
344void blo_do_versions_401(FileData *fd, Library *lib, Main *bmain);
345void blo_do_versions_402(FileData *fd, Library *lib, Main *bmain);
346void blo_do_versions_403(FileData *fd, Library *lib, Main *bmain);
347void blo_do_versions_404(FileData *fd, Library *lib, Main *bmain);
348void blo_do_versions_405(FileData *fd, Library *lib, Main *bmain);
349void blo_do_versions_500(FileData *fd, Library *lib, Main *bmain);
350void blo_do_versions_501(FileData *fd, Library *lib, Main *bmain);
351void blo_do_versions_502(FileData *fd, Library *lib, Main *bmain);
352void blo_do_versions_503(FileData *fd, Library *lib, Main *bmain);
353
370
371void do_versions_after_setup(Main *new_bmain,
372 BlendfileLinkAppendContext *lapp_context,
373 BlendFileReadReport *reports);
374
381void *blo_read_get_new_globaldata_address(FileData *fd, const void *adr) ATTR_NONNULL(1);
382
387void blo_readfile_invalidate(FileData *fd, Main *bmain, const char *message) ATTR_NONNULL(1, 2, 3);
388
389} // namespace blender
#define ENUM_OPERATORS(_enum_type)
File and directory operations.
Wrapper for reading from various sources (e.g. raw files, compressed files, memory....
#define FILE_MAX
Compatibility-like things for windows.
external readfile function prototypes.
BMesh Iterators.
void blo_readfile_invalidate(FileData *fd, Main *bmain, const char *message)
Definition readfile.cc:589
void do_versions_after_linking_401(FileData *fd, Main *bmain)
FileData * blo_filedata_from_memfile(MemFile *memfile, const BlendFileReadParams *params, BlendFileReadReport *reports)
Definition readfile.cc:1387
void do_versions_after_linking_270(Main *bmain)
void * blo_do_versions_newlibadr(FileData *fd, ID *self_id, const bool is_linked_only, const void *adr)
Definition readfile.cc:1534
void blo_do_versions_key_uidgen(Key *key)
Definition readfile.cc:2493
void do_versions_after_linking_500(FileData *fd, Main *bmain)
void * blo_read_get_new_globaldata_address(FileData *fd, const void *adr)
Definition readfile.cc:1523
void blo_do_versions_dna(SDNA *sdna, int versionfile, int subversionfile)
void blo_do_versions_500(FileData *fd, Library *lib, Main *bmain)
void blo_cache_storage_init(FileData *fd, Main *bmain)
Definition readfile.cc:1706
void blo_do_versions_userdef(UserDef *userdef)
AssetMetaData * blo_bhead_id_asset_data_address(const FileData *fd, const BHead *bhead)
Definition readfile.cc:850
void blo_do_versions_501(FileData *fd, Library *lib, Main *bmain)
FileData * blo_filedata_from_file(const char *filepath, BlendFileReadReport *reports)
Definition readfile.cc:1336
void do_versions_after_linking_260(Main *bmain)
void do_versions_after_linking_502(FileData *fd, Main *bmain)
void blo_do_versions_300(FileData *fd, Library *lib, Main *bmain)
void blo_do_versions_502(FileData *fd, Library *lib, Main *bmain)
void do_versions_after_linking_503(FileData *fd, Main *bmain)
void do_versions_after_linking_402(FileData *fd, Main *bmain)
void do_versions_after_linking_280(FileData *fd, Main *bmain)
void blo_do_versions_401(FileData *fd, Library *lib, Main *bmain)
void blo_cache_storage_old_bmain_clear(FileData *fd, Main *bmain_old)
Definition readfile.cc:1742
void do_versions_after_linking_404(FileData *fd, Main *bmain)
void blo_do_versions_250(FileData *fd, Library *lib, Main *bmain)
const char * blo_bhead_library_filepath(const FileData *fd, const BHead *bhead)
Definition readfile.cc:868
void blo_split_main(Main *bmain, const bool do_split_packed_ids)
Definition readfile.cc:449
const char * blo_bhead_id_name(FileData *fd, const BHead *bhead)
Definition readfile.cc:828
void do_versions_after_linking_400(FileData *fd, Main *bmain)
void blo_do_versions_oldnewmap_insert(OldNewMap *onm, const void *oldaddr, void *newaddr, const int nr)
Definition readfile.cc:314
LibraryFlag blo_bhead_library_flag(const FileData *fd, const BHead *bhead)
Definition readfile.cc:874
void blo_do_versions_403(FileData *fd, Library *lib, Main *bmain)
void do_versions_after_setup(Main *new_bmain, BlendfileLinkAppendContext *lapp_context, BlendFileReadReport *reports)
void blo_do_versions_270(FileData *fd, Library *lib, Main *bmain)
void blo_do_versions_290(FileData *fd, Library *lib, Main *bmain)
void blo_do_version_old_trackto_to_constraints(Object *ob)
BHead * blo_read_asset_data_block(FileData *fd, BHead *bhead, AssetMetaData **r_asset_data)
Definition readfile.cc:3773
BHead * blo_bhead_prev(FileData *, BHead *thisblock)
Definition readfile.cc:724
void do_versions_after_linking_403(FileData *fd, Main *bmain)
BlendFileData * blo_read_file_internal(FileData *fd, const char *filepath)
Definition readfile.cc:4412
@ BLO_READ_SKIP_NONE
void do_versions_after_linking_501(FileData *fd, Main *bmain)
void blo_do_versions_402(FileData *fd, Library *lib, Main *bmain)
short blo_bhead_id_flag(const FileData *fd, const BHead *bhead)
Definition readfile.cc:843
void blo_do_versions_260(FileData *fd, Library *lib, Main *bmain)
FileData * blo_filedata_from_memory(const void *mem, const int memsize, BlendFileReadReport *reports)
Definition readfile.cc:1366
void blo_do_versions_404(FileData *fd, Library *lib, Main *bmain)
void do_versions_after_linking_250(Main *bmain)
void do_versions_after_linking_405(FileData *fd, Main *bmain)
void ATTR_NONNULL(1, 2)
void blo_make_old_idmap_from_main(FileData *fd, Main *bmain)
Definition readfile.cc:1604
BHead * blo_bhead_next(FileData *fd, BHead *thisblock)
Definition readfile.cc:732
void do_versions_after_linking_290(FileData *fd, Main *bmain)
void blo_do_versions_280(FileData *fd, Library *lib, Main *bmain)
void blo_cache_storage_end(FileData *fd)
Definition readfile.cc:1769
void blo_do_versions_pre250(FileData *fd, Library *lib, Main *bmain)
BHead * blo_bhead_first(FileData *fd)
Definition readfile.cc:704
void blo_do_versions_400(FileData *fd, Library *lib, Main *bmain)
eFileDataFlag
Definition readfile.hh:52
@ FD_FLAGS_FILE_FUTURE
Definition readfile.hh:62
@ FD_FLAGS_IS_MEMFILE
Definition readfile.hh:57
@ FD_FLAGS_FILE_POINTSIZE_IS_4
Definition readfile.hh:54
@ FD_FLAGS_POINTSIZE_DIFFERS
Definition readfile.hh:55
@ FD_FLAGS_FILE_OK
Definition readfile.hh:56
@ FD_FLAGS_SWITCH_ENDIAN
Definition readfile.hh:53
@ FD_FLAGS_HAS_INVALID_ID_NAMES
Definition readfile.hh:67
void blo_join_main(Main *bmain)
Definition readfile.cc:393
void blo_filedata_free(FileData *fd)
Definition readfile.cc:1404
void blo_do_versions_503(FileData *fd, Library *lib, Main *bmain)
void blo_do_versions_405(FileData *fd, Library *lib, Main *bmain)
void do_versions_after_linking_300(FileData *fd, Main *bmain)
The meta-data of an asset. By creating and giving this for a data-block (ID.asset_data),...
BlenderHeader blender_header
Definition readfile.hh:87
std::shared_ptr< Map< IDHash, ID * > > id_by_deep_hash
Definition readfile.hh:157
const char * compflags
Definition readfile.hh:114
BLOCacheStorage * cache_storage
Definition readfile.hh:166
char relabase[FILE_MAX]
Definition readfile.hh:108
std::optional< Map< StringRefNull, BHead * > > bhead_idname_map
Definition readfile.hh:171
ListBaseT< BHeadN > bhead_list
Definition readfile.hh:84
std::optional< BLI_stat_t > file_stat
Definition readfile.hh:90
eBLOReadSkip skip_flags
Definition readfile.hh:144
bool need_preview_render_restart
Definition readfile.hh:216
IDNameLib_Map * new_idmap_uid
Definition readfile.hh:206
const SDNA * memsdna
Definition readfile.hh:112
DNA_ReconstructInfo * reconstruct_info
Definition readfile.hh:115
OldNewMap * datamap
Definition readfile.hh:154
OldNewMap * libmap
Definition readfile.hh:164
int library_filepath_offset
Definition readfile.hh:137
eID_Tag id_tag_extra
Definition readfile.hh:152
BlendFileReadReport * reports
Definition readfile.hh:208
std::unique_ptr< SDNA > filesdna
Definition readfile.hh:111
IDNameLib_Map * old_idmap_uid
Definition readfile.hh:195
BHeadSort * bheadmap
Definition readfile.hh:168
enum eFileDataFlag flags
Definition readfile.hh:85
OldNewMap * globmap
Definition readfile.hh:155
FileReader * file
Definition readfile.hh:89
void * storage_handle
Definition readfile.hh:211