readfile.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include <cstdio> /* IWYU pragma: keep. Include header using off_t before poisoning it below. */
#include <optional>
 
#ifdef WIN32
#  include "BLI_winstuff.h"
#endif
 
#include "BLI_fileops.h"
#include "BLI_filereader.h"
#include "BLI_map.hh"
 
#include "DNA_sdna_types.h"
#include "DNA_space_types.h"
 
#include "BLO_core_bhead.hh"
#include "BLO_core_blend_header.hh"
#include "BLO_readfile.hh"
 
struct BlendFileData;
struct BlendfileLinkAppendContext;
struct BlendFileReadParams;
struct BlendFileReadReport;
struct BLOCacheStorage;
struct BHeadSort;
struct DNA_ReconstructInfo;
struct IDNameLib_Map;
struct Key;
struct Main;
struct MemFile;
struct Object;
struct OldNewMap;
struct UserDef;

enum eFileDataFlag {
  FD_FLAGS_SWITCH_ENDIAN = 1 << 0,
  FD_FLAGS_FILE_POINTSIZE_IS_4 = 1 << 1,
  FD_FLAGS_POINTSIZE_DIFFERS = 1 << 2,
  FD_FLAGS_FILE_OK = 1 << 3,
  FD_FLAGS_IS_MEMFILE = 1 << 4,
  FD_FLAGS_FILE_FUTURE = 1 << 5,
  FD_FLAGS_HAS_INVALID_ID_NAMES = 1 << 6,
};
ENUM_OPERATORS(eFileDataFlag, FD_FLAGS_IS_MEMFILE)
 
/* Disallow since it's 32bit on ms-windows. */
#ifdef __GNUC__
#  pragma GCC poison off_t
#endif

struct FileData {
  ListBase bhead_list = {};
  enum eFileDataFlag flags = eFileDataFlag(0);
  bool is_eof = false;
  BlenderHeader blender_header = {};
 
  FileReader *file = nullptr;
  std::optional<BLI_stat_t> file_stat;

  int undo_direction = 0;

  char relabase[FILE_MAX] = {};

  SDNA *filesdna = nullptr;
  const SDNA *memsdna = nullptr;
  const char *compflags = nullptr;
  DNA_ReconstructInfo *reconstruct_info = nullptr;
 
  int fileversion = 0;
  int filesubversion = 0;

  int id_name_offset = 0;
  int id_asset_data_offset = 0;
  int id_flag_offset = 0;
  int id_deep_hash_offset = 0;
  int globalf = 0;
  int fileflags = 0;

  eBLOReadSkip skip_flags = BLO_READ_SKIP_NONE;

  int id_tag_extra = 0;
 
  OldNewMap *datamap = nullptr;
  OldNewMap *globmap = nullptr;
  std::shared_ptr<blender::Map<IDHash, ID *>> id_by_deep_hash;

  OldNewMap *libmap = nullptr;
 
  BLOCacheStorage *cache_storage = nullptr;
 
  BHeadSort *bheadmap = nullptr;
  int tot_bheadmap = 0;
 
  std::optional<blender::Map<blender::StringRefNull, BHead *>> bhead_idname_map;

  Main *bmain = nullptr;
  Main *old_bmain = nullptr;
  Main *fd_bmain = nullptr;

  IDNameLib_Map *old_idmap_uid = nullptr;
  IDNameLib_Map *new_idmap_uid = nullptr;
 
  BlendFileReadReport *reports = nullptr;

  void *storage_handle = nullptr;
};

void blo_split_main(Main *bmain, bool do_split_packed_ids = true);
void blo_join_main(Main *bmain);
 
BlendFileData *blo_read_file_internal(FileData *fd, const char *filepath) ATTR_NONNULL(1, 2);

FileData *blo_filedata_from_file(const char *filepath, BlendFileReadReport *reports);
FileData *blo_filedata_from_memory(const void *mem, int memsize, BlendFileReadReport *reports);
FileData *blo_filedata_from_memfile(MemFile *memfile,
                                    const BlendFileReadParams *params,
                                    BlendFileReadReport *reports);

void blo_make_old_idmap_from_main(FileData *fd, Main *bmain) ATTR_NONNULL(1, 2);
 
BHead *blo_read_asset_data_block(FileData *fd, BHead *bhead, AssetMetaData **r_asset_data)
    ATTR_NONNULL(1, 2);
 
void blo_cache_storage_init(FileData *fd, Main *bmain) ATTR_NONNULL(1, 2);
void blo_cache_storage_old_bmain_clear(FileData *fd, Main *bmain_old) ATTR_NONNULL(1, 2);
void blo_cache_storage_end(FileData *fd) ATTR_NONNULL(1);
 
void blo_filedata_free(FileData *fd) ATTR_NONNULL(1);
 
BHead *blo_bhead_first(FileData *fd) ATTR_NONNULL(1);
BHead *blo_bhead_next(FileData *fd, BHead *thisblock) ATTR_NONNULL(1);
BHead *blo_bhead_prev(FileData *fd, BHead *thisblock) ATTR_NONNULL(1, 2);

const char *blo_bhead_id_name(FileData *fd, const BHead *bhead);
short blo_bhead_id_flag(const FileData *fd, const BHead *bhead);
AssetMetaData *blo_bhead_id_asset_data_address(const FileData *fd, const BHead *bhead);
 
/* do versions stuff */

void blo_do_versions_dna(SDNA *sdna, int versionfile, int subversionfile);
 
void blo_do_versions_oldnewmap_insert(OldNewMap *onm, const void *oldaddr, void *newaddr, int nr);
void *blo_do_versions_newlibadr(FileData *fd,
                                ID *self_id,
                                const bool is_linked_only,
                                const void *adr);

void blo_do_version_old_trackto_to_constraints(Object *ob);
void blo_do_versions_key_uidgen(Key *key);

void blo_do_versions_userdef(UserDef *userdef);
 
void blo_do_versions_pre250(FileData *fd, Library *lib, Main *bmain);
void blo_do_versions_250(FileData *fd, Library *lib, Main *bmain);
void blo_do_versions_260(FileData *fd, Library *lib, Main *bmain);
void blo_do_versions_270(FileData *fd, Library *lib, Main *bmain);
void blo_do_versions_280(FileData *fd, Library *lib, Main *bmain);
void blo_do_versions_290(FileData *fd, Library *lib, Main *bmain);
void blo_do_versions_300(FileData *fd, Library *lib, Main *bmain);
void blo_do_versions_400(FileData *fd, Library *lib, Main *bmain);
void blo_do_versions_410(FileData *fd, Library *lib, Main *bmain);
void blo_do_versions_420(FileData *fd, Library *lib, Main *bmain);
void blo_do_versions_430(FileData *fd, Library *lib, Main *bmain);
void blo_do_versions_440(FileData *fd, Library *lib, Main *bmain);
void blo_do_versions_450(FileData *fd, Library *lib, Main *bmain);
void blo_do_versions_500(FileData *fd, Library *lib, Main *bmain);
 
void do_versions_after_linking_250(Main *bmain);
void do_versions_after_linking_260(Main *bmain);
void do_versions_after_linking_270(Main *bmain);
void do_versions_after_linking_280(FileData *fd, Main *bmain);
void do_versions_after_linking_290(FileData *fd, Main *bmain);
void do_versions_after_linking_300(FileData *fd, Main *bmain);
void do_versions_after_linking_400(FileData *fd, Main *bmain);
void do_versions_after_linking_410(FileData *fd, Main *bmain);
void do_versions_after_linking_420(FileData *fd, Main *bmain);
void do_versions_after_linking_430(FileData *fd, Main *bmain);
void do_versions_after_linking_440(FileData *fd, Main *bmain);
void do_versions_after_linking_450(FileData *fd, Main *bmain);
void do_versions_after_linking_500(FileData *fd, Main *bmain);
 
void do_versions_after_setup(Main *new_bmain,
                             BlendfileLinkAppendContext *lapp_context,
                             BlendFileReadReport *reports);

void *blo_read_get_new_globaldata_address(FileData *fd, const void *adr) ATTR_NONNULL(1);
 
/* Mark the Main data as invalid (.blend file reading should be aborted ASAP, and the already read
 * data should be discarded). Also add an error report to `fd` including given `message`. */
void blo_readfile_invalidate(FileData *fd, Main *bmain, const char *message) ATTR_NONNULL(1, 2, 3);