BKE_idtype.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 <optional>
 
#include "BLI_sys_types.h"
 
struct AssetTypeInfo;
struct BPathForeachPathData;
struct BlendDataReader;
struct BlendLibReader;
struct BlendWriter;
struct ID;
struct Library;
struct LibraryForeachIDData;
struct Main;
 
enum {
  IDTYPE_FLAGS_NO_COPY = 1 << 0,
  IDTYPE_FLAGS_NO_LIBLINKING = 1 << 1,
  IDTYPE_FLAGS_ONLY_APPEND = 1 << 2,
  IDTYPE_FLAGS_APPEND_IS_REUSABLE = 1 << 3,
  IDTYPE_FLAGS_NO_ANIMDATA = 1 << 4,
  IDTYPE_FLAGS_NO_MEMFILE_UNDO = 1 << 5,
  IDTYPE_FLAGS_NEVER_UNUSED = 1 << 6,
};
 
struct IDCacheKey {
  /* The session UID of the ID owning the cached data. */
  unsigned int id_session_uid;
  /* Value uniquely identifying the cache within its ID.
   * Typically the offset of its member in the data-block struct, but can be anything. */
  size_t identifier;
};
 
uint BKE_idtype_cache_key_hash(const void *key_v);
bool BKE_idtype_cache_key_cmp(const void *key_a_v, const void *key_b_v);
 
/* ********** Prototypes for #IDTypeInfo callbacks. ********** */
 
using IDTypeInitDataFunction = void (*)(ID *id);
 
using IDTypeCopyDataFunction = void (*)(
    Main *bmain, std::optional<Library *> owner_library, ID *id_dst, const ID *id_src, int flag);
 
using IDTypeFreeDataFunction = void (*)(ID *id);
 
using IDTypeMakeLocalFunction = void (*)(Main *bmain, ID *id, int flags);
 
using IDTypeForeachIDFunction = void (*)(ID *id, LibraryForeachIDData *data);
 
enum eIDTypeInfoCacheCallbackFlags {
  IDTYPE_CACHE_CB_FLAGS_PERSISTENT = 1 << 0,
};
using IDTypeForeachCacheFunctionCallback =
    void (*)(ID *id, const IDCacheKey *cache_key, void **cache_p, uint flags, void *user_data);
using IDTypeForeachCacheFunction = void (*)(ID *id,
                                            IDTypeForeachCacheFunctionCallback function_callback,
                                            void *user_data);
 
using IDTypeForeachPathFunction = void (*)(ID *id, BPathForeachPathData *bpath_data);
 
using IDTypeEmbeddedOwnerPointerGetFunction = ID **(*)(ID *id, bool debug_relationship_assert);
 
using IDTypeBlendWriteFunction = void (*)(BlendWriter *writer, ID *id, const void *id_address);
using IDTypeBlendReadDataFunction = void (*)(BlendDataReader *reader, ID *id);
using IDTypeBlendReadAfterLiblinkFunction = void (*)(BlendLibReader *reader, ID *id);
 
using IDTypeBlendReadUndoPreserve = void (*)(BlendLibReader *reader, ID *id_new, ID *id_old);
 
using IDTypeLibOverrideApplyPost = void (*)(ID *id_dst, ID *id_src);
 
struct IDTypeInfo {
  /* ********** General IDType data. ********** */
 
  short id_code;
  uint64_t id_filter;
 
  uint64_t dependencies_id_types;
 
  int main_listbase_index;
 
  size_t struct_size;
 
  const char *name;
  const char *name_plural;
  const char *translation_context;
 
  uint32_t flags;
 
  AssetTypeInfo *asset_type_info;
 
  /* ********** ID management callbacks ********** */
 
  IDTypeInitDataFunction init_data;
 
  IDTypeCopyDataFunction copy_data;
 
  IDTypeFreeDataFunction free_data;
 
  IDTypeMakeLocalFunction make_local;
 
  IDTypeForeachIDFunction foreach_id;
 
  IDTypeForeachCacheFunction foreach_cache;
 
  IDTypeForeachPathFunction foreach_path;
 
  IDTypeEmbeddedOwnerPointerGetFunction owner_pointer_get;
 
  /* ********** Callbacks for reading and writing .blend files. ********** */
 
  IDTypeBlendWriteFunction blend_write;
 
  IDTypeBlendReadDataFunction blend_read_data;
 
  IDTypeBlendReadAfterLiblinkFunction blend_read_after_liblink;
 
  IDTypeBlendReadUndoPreserve blend_read_undo_preserve;
 
  IDTypeLibOverrideApplyPost lib_override_apply_post;
};
 
/* ********** Declaration of each IDTypeInfo. ********** */
 
/* Those are defined in the respective BKE files. */
extern IDTypeInfo IDType_ID_SCE;
extern IDTypeInfo IDType_ID_LI;
extern IDTypeInfo IDType_ID_OB;
extern IDTypeInfo IDType_ID_ME;
extern IDTypeInfo IDType_ID_CU_LEGACY;
extern IDTypeInfo IDType_ID_MB;
extern IDTypeInfo IDType_ID_MA;
extern IDTypeInfo IDType_ID_TE;
extern IDTypeInfo IDType_ID_IM;
extern IDTypeInfo IDType_ID_LT;
extern IDTypeInfo IDType_ID_LA;
extern IDTypeInfo IDType_ID_CA;
extern IDTypeInfo IDType_ID_IP;
extern IDTypeInfo IDType_ID_KE;
extern IDTypeInfo IDType_ID_WO;
extern IDTypeInfo IDType_ID_SCR;
extern IDTypeInfo IDType_ID_VF;
extern IDTypeInfo IDType_ID_TXT;
extern IDTypeInfo IDType_ID_SPK;
extern IDTypeInfo IDType_ID_SO;
extern IDTypeInfo IDType_ID_GR;
extern IDTypeInfo IDType_ID_AR;
extern IDTypeInfo IDType_ID_AC;
extern IDTypeInfo IDType_ID_NT;
extern IDTypeInfo IDType_ID_BR;
extern IDTypeInfo IDType_ID_PA;
extern IDTypeInfo IDType_ID_GD_LEGACY;
extern IDTypeInfo IDType_ID_WM;
extern IDTypeInfo IDType_ID_MC;
extern IDTypeInfo IDType_ID_MSK;
extern IDTypeInfo IDType_ID_LS;
extern IDTypeInfo IDType_ID_PAL;
extern IDTypeInfo IDType_ID_PC;
extern IDTypeInfo IDType_ID_CF;
extern IDTypeInfo IDType_ID_WS;
extern IDTypeInfo IDType_ID_LP;
extern IDTypeInfo IDType_ID_CV;
extern IDTypeInfo IDType_ID_PT;
extern IDTypeInfo IDType_ID_VO;
extern IDTypeInfo IDType_ID_GP;
 
extern IDTypeInfo IDType_ID_LINK_PLACEHOLDER;
 
/* ********** Helpers/Utils API. ********** */
 
/* Module initialization. */
void BKE_idtype_init();
 
/* General helpers. */
const IDTypeInfo *BKE_idtype_get_info_from_idtype_index(const int idtype_index);
const IDTypeInfo *BKE_idtype_get_info_from_idcode(short id_code);
const IDTypeInfo *BKE_idtype_get_info_from_id(const ID *id);
 
const char *BKE_idtype_idcode_to_name(short idcode);
const char *BKE_idtype_idcode_to_name_plural(short idcode);
const char *BKE_idtype_idcode_to_translation_context(short idcode);
 
bool BKE_idtype_idcode_is_valid(short idcode);
 
bool BKE_idtype_idcode_is_linkable(short idcode);
bool BKE_idtype_idcode_is_only_appendable(short idcode);
bool BKE_idtype_idcode_append_is_reusable(short idcode);
/* Macro currently, since any linkable IDtype should be localizable. */
#define BKE_idtype_idcode_is_localizable BKE_idtype_idcode_is_linkable
 
short BKE_idtype_idcode_from_name(const char *idtype_name);
 
int BKE_idtype_idcode_to_index(short idcode);
int BKE_idtype_idfilter_to_index(uint64_t id_filter);
 
short BKE_idtype_index_to_idcode(int idtype_index);
uint64_t BKE_idtype_index_to_idfilter(int idtype_index);
 
uint64_t BKE_idtype_idcode_to_idfilter(short idcode);
short BKE_idtype_idfilter_to_idcode(uint64_t idfilter);
 
short BKE_idtype_idcode_iter_step(int *idtype_index);
 
/* Some helpers/wrappers around callbacks defined in #IDTypeInfo, dealing e.g. with embedded IDs.
 * XXX Ideally those would rather belong to #BKE_lib_id, but using callback function pointers makes
 * this hard to do properly if we want to avoid headers includes in headers. */
 
void BKE_idtype_id_foreach_cache(ID *id,
                                 IDTypeForeachCacheFunctionCallback function_callback,
                                 void *user_data);