#include <readfile.hh>

Public Attributes
ListBase	bhead_list
enum eFileDataFlag	flags
bool	is_eof
FileReader *	file
int	undo_direction
char	relabase [FILE_MAX]
SDNA *	filesdna
const SDNA *	memsdna
const char *	compflags
DNA_ReconstructInfo *	reconstruct_info
int	fileversion
int	id_name_offset
int	id_asset_data_offset
int	globalf
int	fileflags
eBLOReadSkip	skip_flags
int	id_tag_extra
OldNewMap *	datamap
OldNewMap *	globmap
OldNewMap *	libmap
BLOCacheStorage *	cache_storage
BHeadSort *	bheadmap
int	tot_bheadmap
GHash *	bhead_idname_hash
ListBase *	mainlist
ListBase *	old_mainlist
IDNameLib_Map *	old_idmap_uid
IDNameLib_Map *	new_idmap_uid
BlendFileReadReport *	reports
void *	storage_handle

Detailed Description

General data used during a blend-file reading.

Note that this data (and its accesses) are absolutely not thread-safe currently. It should never be accessed concurrently.

Definition at line 65 of file readfile.hh.

Member Data Documentation

◆ bhead_idname_hash

GHash* FileData::bhead_idname_hash

See: USE_GHASH_BHEAD.

Definition at line 129 of file readfile.hh.

Referenced by blo_filedata_free(), find_bhead_from_code_name(), find_bhead_from_idname(), and read_file_bhead_idname_map_create().

◆ bhead_list

ListBase FileData::bhead_list

Linked list of BHeadN's.

Definition at line 67 of file readfile.hh.

Referenced by blo_bhead_first(), blo_filedata_free(), and get_bhead().

◆ bheadmap

BHeadSort* FileData::bheadmap

Definition at line 125 of file readfile.hh.

Referenced by blo_filedata_free(), find_bhead(), and sort_bhead_old_map().

◆ cache_storage

BLOCacheStorage* FileData::cache_storage

Definition at line 123 of file readfile.hh.

Referenced by blo_cache_storage_end(), blo_cache_storage_init(), blo_cache_storage_old_bmain_clear(), and direct_link_id().

◆ compflags

const char* FileData::compflags

Array of eSDNA_StructCompare.

Definition at line 90 of file readfile.hh.

Referenced by blo_filedata_free(), read_file_dna(), and read_struct().

◆ datamap

OldNewMap* FileData::datamap

Definition at line 113 of file readfile.hh.

Referenced by blo_filedata_free(), blo_read_asset_data_block(), filedata_new(), newdataadr(), newdataadr_no_us(), read_data_into_datamap(), read_libblock(), and read_userdef().

◆ file

FileReader* FileData::file

Definition at line 71 of file readfile.hh.

Referenced by blo_bhead_read_data(), blo_filedata_free(), blo_filedata_from_file_descriptor(), blo_filedata_from_memfile(), blo_filedata_from_memory(), blo_read_shared_impl(), decode_blender_header(), and get_bhead().

◆ fileflags

int FileData::fileflags

Definition at line 100 of file readfile.hh.

Referenced by read_global().

◆ filesdna

SDNA* FileData::filesdna

General reading variables.

Definition at line 87 of file readfile.hh.

Referenced by BLO_blendhandle_get_datablock_info(), BLO_blendhandle_get_preview_for_id(), blo_do_versions_260(), blo_do_versions_270(), blo_do_versions_280(), blo_do_versions_290(), blo_do_versions_300(), blo_do_versions_400(), blo_filedata_free(), BLO_read_pointer_array(), do_versions_after_linking_400(), get_alloc_name(), is_minversion_older_than_blender(), read_file_dna(), and read_struct().

◆ fileversion

int FileData::fileversion

Definition at line 93 of file readfile.hh.

Referenced by blo_read_file_internal(), BLO_read_fileversion_get(), BLO_version_from_file(), decode_blender_header(), is_minversion_older_than_blender(), library_link_begin(), read_file_dna(), and read_library_file_data().

◆ flags

enum eFileDataFlag FileData::flags

◆ globalf

int FileData::globalf

For do_versions patching.

Definition at line 100 of file readfile.hh.

Referenced by read_global().

◆ globmap

OldNewMap* FileData::globmap

Definition at line 114 of file readfile.hh.

Referenced by blo_filedata_free(), BLO_read_data_globmap_add(), blo_read_get_new_globaldata_address(), filedata_new(), and link_glob_list().

◆ id_asset_data_offset

int FileData::id_asset_data_offset

Used to retrieve asset data from (bhead+1). NOTE: This may not be available in old files, will be -1 then!

Definition at line 98 of file readfile.hh.

Referenced by blo_bhead_id_asset_data_address(), and read_file_dna().

◆ id_name_offset

int FileData::id_name_offset

Used to retrieve ID names from (bhead+1).

Definition at line 95 of file readfile.hh.

Referenced by blo_bhead_id_name(), and read_file_dna().

◆ id_tag_extra

int FileData::id_tag_extra

Tag to apply to all loaded ID data-blocks.

Note: This is initialized from LibraryLink_Params.id_tag_extra since passing it as an argument would need an additional argument to be passed around when expanding library data.

Definition at line 111 of file readfile.hh.

Referenced by expand_doit_library(), library_link_begin(), and link_named_part().

◆ is_eof

bool FileData::is_eof

Definition at line 69 of file readfile.hh.

Referenced by get_bhead().

◆ libmap

OldNewMap* FileData::libmap

Store mapping from old ID pointers (the values they have in the .blend file) to new ones, typically from value in bhead->old to address in memory where the ID was read. Used during library-linking process (see lib_link_all).

Definition at line 121 of file readfile.hh.

Referenced by blo_do_versions_pre250(), blo_filedata_free(), change_link_placeholder_to_real_ID_pointer_fd(), filedata_new(), newlibadr(), oldnewmap_lib_insert(), and read_library_file_data().

◆ mainlist

ListBase* FileData::mainlist

Definition at line 131 of file readfile.hh.

Referenced by blo_find_main(), blo_read_file_internal(), direct_link_library(), library_link_begin(), library_link_end(), read_library_file_data(), read_undo_move_libmain_data(), read_undo_remap_noundo_data(), and read_undo_reuse_noundo_local_ids().

◆ memsdna

const SDNA* FileData::memsdna

Definition at line 88 of file readfile.hh.

Referenced by BLO_read_pointer_array(), BLO_read_struct_by_name_array(), filedata_new(), and read_file_dna().

◆ new_idmap_uid

IDNameLib_Map* FileData::new_idmap_uid

IDMap using uids as keys of the IDs read (or moved) in the new main(s).

Used during undo to ensure that the ID pointers from the 'no undo' IDs remain valid (these IDs are re-used from old main even if their content is not the same as in the memfile undo step, so they could point e.g. to an ID that does not exist in the newly read undo step).

Also used to find current valid pointers (or none) of these 'no undo' IDs existing in read memfile.

Definition at line 147 of file readfile.hh.

Referenced by blo_filedata_free(), blo_read_file_internal(), BLO_read_get_new_id_address_from_session_uid(), read_libblock(), read_libblock_undo_restore(), read_libblock_undo_restore_identical(), read_libblock_undo_restore_linked(), read_undo_move_libmain_data(), read_undo_remap_noundo_data(), and read_undo_reuse_noundo_local_ids().

◆ old_idmap_uid

IDNameLib_Map* FileData::old_idmap_uid

IDMap using UID's as keys of all the old IDs in the old bmain. Used during undo to find a matching old data when reading a new ID.

Definition at line 137 of file readfile.hh.

Referenced by blo_filedata_free(), blo_make_old_idmap_from_main(), and read_libblock_undo_restore().

◆ old_mainlist

ListBase* FileData::old_mainlist

Used for undo.

Definition at line 133 of file readfile.hh.

Referenced by blo_read_file_internal(), BLO_read_from_memfile(), read_libblock_undo_restore_at_old_address(), read_libblock_undo_restore_identical(), read_libblock_undo_restore_library(), read_undo_move_libmain_data(), and read_undo_reuse_noundo_local_ids().

◆ reconstruct_info

DNA_ReconstructInfo* FileData::reconstruct_info

Definition at line 91 of file readfile.hh.

Referenced by blo_filedata_free(), read_file_dna(), and read_struct().

◆ relabase

char FileData::relabase[FILE_MAX]

Used for relative paths handling.

Typically the actual filepath of the read blend-file, except when recovering save-on-exit/autosave files. In the latter case, it will be the path of the file that generated the auto-saved one being recovered.

NOTE: Currently expected to be the same path as BlendFileData.filepath.

Definition at line 84 of file readfile.hh.

Referenced by blo_decode_and_check(), blo_filedata_from_file(), blo_read_file_internal(), BLO_read_from_memfile(), direct_link_library(), do_versions(), expand_doit_library(), is_minversion_older_than_blender(), read_global(), and read_library_file_data().

◆ reports

BlendFileReadReport* FileData::reports

Definition at line 149 of file readfile.hh.

Referenced by blo_do_versions_280(), blo_do_versions_400(), BLO_read_data_reports(), blo_read_file_internal(), BLO_read_lib_reports(), blo_readfile_invalidate(), direct_link_library(), do_versions_after_linking_400(), expand_doit_library(), filedata_new(), read_library_file_data(), and read_library_linked_id().

◆ skip_flags

eBLOReadSkip FileData::skip_flags

Optionally skip some data-blocks when they're not needed.

Definition at line 103 of file readfile.hh.

Referenced by blo_read_file_internal(), BLO_read_from_file(), BLO_read_from_memfile(), BLO_read_from_memory(), direct_link_id_common(), read_libblock(), read_libblock_undo_restore(), read_libblock_undo_restore_at_old_address(), and read_libblock_undo_restore_identical().

◆ storage_handle

void* FileData::storage_handle

Opaque handle to the storage system used for non-static allocation strings.

Definition at line 152 of file readfile.hh.

Referenced by get_alloc_name().

◆ tot_bheadmap

int FileData::tot_bheadmap

Definition at line 126 of file readfile.hh.

Referenced by find_bhead(), and sort_bhead_old_map().

◆ undo_direction

int FileData::undo_direction

Whether we are undoing (< 0) or redoing (> 0), used to choose which 'unchanged' flag to use to detect unchanged data from memfile.

Definition at line 75 of file readfile.hh.

Referenced by blo_filedata_from_memfile(), and direct_link_id_restore_recalc().

The documentation for this struct was generated from the following file:

readfile.hh

Public Attributes