BKE_blendfile.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
#pragma once
 
#include "BKE_main.hh"
 
#include "BLI_function_ref.hh"
#include "BLI_map.hh"
#include "BLI_utility_mixins.hh"
 
#include <string>
 
struct bContext;
struct BlendFileData;
struct BlendFileReadParams;
struct BlendFileReadReport;
struct BlendFileReadWMSetupData;
struct ID;
struct IDNameLib_Map;
struct Library;
struct LibraryIDLinkCallbackData;
struct MemFile;
struct ReportList;
struct UserDef;
struct WorkspaceConfigFileData;
 
#define BLENDER_ASSET_FILE_SUFFIX ".asset.blend"
 
bool BKE_blendfile_extension_check(const char *str);
bool BKE_blendfile_library_path_explode(const char *path,
                                        char *r_dir,
                                        char **r_group,
                                        char **r_name);
 
bool BKE_blendfile_is_readable(const char *path, ReportList *reports);
 
void BKE_blendfile_read_setup_readfile(bContext *C,
                                       BlendFileData *bfd,
                                       const BlendFileReadParams *params,
                                       BlendFileReadWMSetupData *wm_setup_data,
                                       BlendFileReadReport *reports,
                                       bool startup_update_defaults,
                                       const char *startup_app_template);
 
void BKE_blendfile_read_setup_undo(bContext *C,
                                   BlendFileData *bfd,
                                   const BlendFileReadParams *params,
                                   BlendFileReadReport *reports);
 
BlendFileData *BKE_blendfile_read(const char *filepath,
                                  const BlendFileReadParams *params,
                                  BlendFileReadReport *reports);
 
BlendFileData *BKE_blendfile_read_from_memory(const void *file_buf,
                                              int file_buf_size,
                                              const BlendFileReadParams *params,
                                              ReportList *reports);
 
BlendFileData *BKE_blendfile_read_from_memfile(Main *bmain,
                                               MemFile *memfile,
                                               const BlendFileReadParams *params,
                                               ReportList *reports);
void BKE_blendfile_read_make_empty(bContext *C);
 
UserDef *BKE_blendfile_userdef_read(const char *filepath, ReportList *reports);
UserDef *BKE_blendfile_userdef_read_from_memory(const void *file_buf,
                                                int file_buf_size,
                                                ReportList *reports);
UserDef *BKE_blendfile_userdef_from_defaults();
 
bool BKE_blendfile_userdef_write(const char *filepath, ReportList *reports);
bool BKE_blendfile_userdef_write_app_template(const char *filepath, ReportList *reports);
 
bool BKE_blendfile_userdef_write_all(ReportList *reports);
 
WorkspaceConfigFileData *BKE_blendfile_workspace_config_read(const char *filepath,
                                                             const void *file_buf,
                                                             int file_buf_size,
                                                             ReportList *reports);
void BKE_blendfile_workspace_config_data_free(WorkspaceConfigFileData *workspace_config);
 
namespace blender::bke::blendfile {
 
class PartialWriteContext : NonCopyable, NonMovable {
 public:
  Main bmain = {};
 
 private:
  std::string reference_root_filepath_;
  IDNameLib_Map *matching_uid_map_;
 
  blender::Map<std::string, Library *> libraries_map_;
 
 public:
  /* Passing a reference root filepath is mandatory, for remapping of relative paths to work as
   * expected. */
  PartialWriteContext() = delete;
  PartialWriteContext(StringRefNull reference_root_filepath);
  ~PartialWriteContext();
 
  enum IDAddOperations {
    NOP = 0,
    MAKE_LOCAL = 1 << 0,
    SET_FAKE_USER = 1 << 1,
    SET_CLIPBOARD_MARK = 1 << 4,
 
    CLEAR_DEPENDENCIES = 1 << 8,
    ADD_DEPENDENCIES = 1 << 9,
    DUPLICATE_DEPENDENCIES = 1 << 10,
 
    MASK_INHERITED = (MAKE_LOCAL | CLEAR_DEPENDENCIES | ADD_DEPENDENCIES | DUPLICATE_DEPENDENCIES),
    MASK_PER_ID_USAGE = (MAKE_LOCAL | SET_FAKE_USER | SET_CLIPBOARD_MARK | CLEAR_DEPENDENCIES |
                         ADD_DEPENDENCIES),
  };
  struct IDAddOptions {
    IDAddOperations operations;
  };
  ID *id_add(const ID *id,
             IDAddOptions options,
             blender::FunctionRef<IDAddOperations(LibraryIDLinkCallbackData *cb_data,
                                                  IDAddOptions options)> dependencies_filter_cb =
                 nullptr);
 
  ID *id_create(short id_type, StringRefNull id_name, Library *library, IDAddOptions options);
 
  void id_delete(const ID *id);
 
  void remove_unused(bool clear_extra_user = false);
 
  void clear();
 
  bool is_valid();
 
  bool write(const char *write_filepath, int write_flags, int remap_mode, ReportList &reports);
  bool write(const char *write_filepath, ReportList &reports);
 
  /* TODO: To allow editing an existing external blendfile:
   *   - API to load a context from a blendfile.
   *   - API to 'match' a context's content with another Main database's content (based on ID
   *     names and libraries).
   *   - API to replace the matching context IDs by a 'new version' (similar to 'add_id', but
   *     ensuring that the context ID, if it already exists, is a pristine copy of the given source
   *     one).
   *   - Rework the remapping of relative filepaths, since data already existing in the
   *     loaded-from-disk temp context will have different root-path than the data from current
   *     G_MAIN.
   */
 
 private:
  void preempt_session_uid(ID *ctx_id, unsigned int session_uid);
  void process_added_id(ID *ctx_id, const IDAddOperations operations);
  ID *id_add_copy(const ID *id, bool regenerate_session_uid);
  void make_local(ID *ctx_id, int make_local_flags);
  Library *ensure_library(ID *ctx_id);
  Library *ensure_library(StringRefNull library_absolute_path);
};
 
}  // namespace blender::bke::blendfile