BLO_undofile.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2004 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once

 
#include "BLI_filereader.h"
#include "BLI_implicit_sharing.hh"
#include "BLI_listbase.h"
#include "BLI_map.hh"
 
struct Main;
struct Scene;
 
struct MemFileSharedStorage {
  blender::Map<uint64_t, blender::ImplicitSharingInfoAndData> sharing_info_by_address_id;
 
  ~MemFileSharedStorage();
};
 
struct MemFileChunk {
  void *next, *prev;
  const char *buf;
  size_t size;
  bool is_identical;
  bool is_identical_future;
  uint id_session_uid;
};
 
struct MemFile {
  ListBase chunks;
  size_t size;
  MemFileSharedStorage *shared_storage;
};
 
struct MemFileWriteData {
  MemFile *written_memfile;
  MemFile *reference_memfile;
 
  uint current_id_session_uid;
  MemFileChunk *reference_current_chunk;

  blender::Map<uint, MemFileChunk *> id_session_uid_mapping;
};
 
struct MemFileUndoData {
  char filepath[/*FILE_MAX*/ 1024];
  MemFile memfile;
  size_t undo_size;
};
 
/* FileReader-compatible wrapper for reading MemFiles */
struct UndoReader {
  FileReader reader;
 
  MemFile *memfile;
  int undo_direction;
 
  bool memchunk_identical;
};
 
/* Actually only used `writefile.cc`. */
 
void BLO_memfile_write_init(MemFileWriteData *mem_data,
                            MemFile *written_memfile,
                            MemFile *reference_memfile);
void BLO_memfile_write_finalize(MemFileWriteData *mem_data);
 
void BLO_memfile_chunk_add(MemFileWriteData *mem_data, const char *buf, size_t size);
 
/* exports */

/* **************** support for memory-write, for undo buffers *************** */
 
void BLO_memfile_free(MemFile *memfile);
void BLO_memfile_merge(MemFile *first, MemFile *second);
void BLO_memfile_clear_future(MemFile *memfile);
 
/* Utilities. */
 
Main *BLO_memfile_main_get(MemFile *memfile, Main *bmain, Scene **r_scene);
 
FileReader *BLO_memfile_new_filereader(MemFile *memfile, int undo_direction);