BKE_blendfile_link_append.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
#pragma once
 
#include <list>
#include <string>
 
#include "BLI_bit_vector.hh"
#include "BLI_function_ref.hh"
#include "BLI_map.hh"
 
#include "BLO_readfile.hh"
 
struct BlendHandle;
struct ID;
struct Library;
struct LibraryLink_Params;
struct MainLibraryWeakReferenceMap;
struct ReportList;
 
/* TODO: Rename file to `BKE_blendfile_import.hh`. */
/* TODO: Replace `BlendfileLinkAppend` prefix by `blender::bke::blendfile::import` namespace. */
/* TODO: Move these enums to scoped enum classes. */
 
enum {
  LINK_APPEND_ACT_UNSET = 0,
  LINK_APPEND_ACT_KEEP_LINKED,
  LINK_APPEND_ACT_REUSE_LOCAL,
  LINK_APPEND_ACT_MAKE_LOCAL,
  LINK_APPEND_ACT_COPY_LOCAL,
};
 
enum {
  LINK_APPEND_TAG_INDIRECT = 1 << 0,
  LINK_APPEND_TAG_LIBOVERRIDE_DEPENDENCY = 1 << 1,
  LINK_APPEND_TAG_LIBOVERRIDE_DEPENDENCY_ONLY = 1 << 2,
};
 
/* NOTE: These three structs are currently exposed in header to allow for their usage in RNA.
 * Regular C++ code should not access their content directly.
 *
 * TODO: Refactor these three structs into classes, and integrated the whole API into them. */
struct BlendfileLinkAppendContext;
 
struct BlendfileLinkAppendContextItem {
  BlendfileLinkAppendContext *lapp_context;
 
  std::string name;
  blender::BitVector<> libraries;
  short idcode;
 
  char action;
  char tag;
 
  ID *new_id;
  Library *source_library;
  ID *liboverride_id;
  ID *reusable_local_id;
 
  void *userdata;
};
 
struct BlendfileLinkAppendContextLibrary {
  std::string path;         /* Absolute .blend file path. */
  BlendHandle *blo_handle;  /* Blend file handle, if any. */
  bool blo_handle_is_owned; /* Whether the blend file handle is owned, or borrowed. */
  /* The blendfile report associated with the `blo_handle`, if owned. */
  BlendFileReadReport bf_reports;
};
 
struct BlendfileLinkAppendContext {
  blender::Vector<BlendfileLinkAppendContextLibrary> libraries;
  std::list<BlendfileLinkAppendContextItem> items;
  using items_iterator_t = std::list<BlendfileLinkAppendContextItem>::iterator;
  LibraryLink_Params *params = nullptr;
 
  enum class ProcessStage {
    Init = 0,
    Linking,
    Appending,
    Instantiating,
    Done,
 
    /* NOTE: For the time being, liboverride step is not considered here (#BKE_blendfile_override).
     * Mainly because it is only available through the BPY API currently. */
  };
  ProcessStage process_stage;
 
  blender::Map<ID *, BlendfileLinkAppendContextItem *> new_id_to_item;
 
  MainLibraryWeakReferenceMap *library_weak_reference_mapping = nullptr;
 
  const void *blendfile_mem = nullptr;
  size_t blendfile_memsize = 0;
};
 
BlendfileLinkAppendContext *BKE_blendfile_link_append_context_new(LibraryLink_Params *params);
void BKE_blendfile_link_append_context_free(BlendfileLinkAppendContext *lapp_context);
void BKE_blendfile_link_append_context_flag_set(BlendfileLinkAppendContext *lapp_context,
                                                int flag,
                                                bool do_set);
 
void BKE_blendfile_link_append_context_embedded_blendfile_set(
    BlendfileLinkAppendContext *lapp_context, const void *blendfile_mem, int blendfile_memsize);
void BKE_blendfile_link_append_context_embedded_blendfile_clear(
    BlendfileLinkAppendContext *lapp_context);
 
void BKE_blendfile_link_append_context_library_add(BlendfileLinkAppendContext *lapp_context,
                                                   const char *libname,
                                                   BlendHandle *blo_handle);
BlendfileLinkAppendContextItem *BKE_blendfile_link_append_context_item_add(
    BlendfileLinkAppendContext *lapp_context, const char *idname, short idcode, void *userdata);
 
#define BLENDFILE_LINK_APPEND_INVALID -1
int BKE_blendfile_link_append_context_item_idtypes_from_library_add(
    BlendfileLinkAppendContext *lapp_context,
    ReportList *reports,
    uint64_t id_types_filter,
    int library_index);
 
void BKE_blendfile_link_append_context_item_library_index_enable(
    BlendfileLinkAppendContext *lapp_context,
    BlendfileLinkAppendContextItem *item,
    int library_index);
bool BKE_blendfile_link_append_context_is_empty(BlendfileLinkAppendContext *lapp_context);
 
void *BKE_blendfile_link_append_context_item_userdata_get(BlendfileLinkAppendContext *lapp_context,
                                                          BlendfileLinkAppendContextItem *item);
ID *BKE_blendfile_link_append_context_item_newid_get(BlendfileLinkAppendContext *lapp_context,
                                                     BlendfileLinkAppendContextItem *item);
void BKE_blendfile_link_append_context_item_newid_set(BlendfileLinkAppendContext *lapp_context,
                                                      BlendfileLinkAppendContextItem *item,
                                                      ID *new_id);
ID *BKE_blendfile_link_append_context_item_liboverrideid_get(
    BlendfileLinkAppendContext *lapp_context, BlendfileLinkAppendContextItem *item);
short BKE_blendfile_link_append_context_item_idcode_get(BlendfileLinkAppendContext *lapp_context,
                                                        BlendfileLinkAppendContextItem *item);
 
enum eBlendfileLinkAppendForeachItemFlag {
  BKE_BLENDFILE_LINK_APPEND_FOREACH_ITEM_FLAG_DO_DIRECT = 1 << 0,
  BKE_BLENDFILE_LINK_APPEND_FOREACH_ITEM_FLAG_DO_INDIRECT = 1 << 1,
};
 
void BKE_blendfile_link_append_context_item_foreach(
    BlendfileLinkAppendContext *lapp_context,
    blender::FunctionRef<bool(BlendfileLinkAppendContext *lapp_context,
                              BlendfileLinkAppendContextItem *item)> callback_function,
    eBlendfileLinkAppendForeachItemFlag flag);
 
void BKE_blendfile_link_append_context_init_done(BlendfileLinkAppendContext *lapp_context);
 
void BKE_blendfile_link(BlendfileLinkAppendContext *lapp_context, ReportList *reports);
 
void BKE_blendfile_append(BlendfileLinkAppendContext *lapp_context, ReportList *reports);
 
void BKE_blendfile_link_append_instantiate_loose(BlendfileLinkAppendContext *lapp_context,
                                                 ReportList *reports);
 
void BKE_blendfile_link_append_context_finalize(BlendfileLinkAppendContext *lapp_context);
 
enum eBKELibLinkOverride {
  BKE_LIBLINK_OVERRIDE_INIT = 0,
 
  BKE_LIBLINK_OVERRIDE_USE_EXISTING_LIBOVERRIDES = 1 << 0,
  BKE_LIBLINK_OVERRIDE_CREATE_RUNTIME = 1 << 1,
};
 
void BKE_blendfile_override(BlendfileLinkAppendContext *lapp_context,
                            const eBKELibLinkOverride flags,
                            ReportList *reports);
 
void BKE_blendfile_library_relocate(BlendfileLinkAppendContext *lapp_context,
                                    ReportList *reports,
                                    Library *library,
                                    bool do_reload);