Blender V5.3
BKE_idtype.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#pragma once
6
12
13#include <optional>
14
15#include "BLI_color_types.hh"
16#include "BLI_function_ref.hh"
18#include "BLI_sys_types.hh"
19
20#include "DNA_ID.h"
21
22namespace blender {
23
24struct AssetTypeInfo;
27struct BlendDataReader;
28struct BlendLibReader;
29struct BlendWriter;
31struct Main;
32
34enum {
74};
75
76struct IDCacheKey {
78 unsigned int id_session_uid;
83 size_t identifier;
84};
85
86uint BKE_idtype_cache_key_hash(const void *key_v);
87bool BKE_idtype_cache_key_cmp(const void *key_a_v, const void *key_b_v);
88
89/* ********** Prototypes for #IDTypeInfo callbacks. ********** */
90
91using IDTypeInitDataFunction = void (*)(ID *id);
92
94using IDTypeCopyDataFunction = void (*)(
95 Main *bmain, std::optional<Library *> owner_library, ID *id_dst, const ID *id_src, int flag);
96
97using IDTypeFreeDataFunction = void (*)(ID *id);
98
100using IDTypeMakeLocalFunction = void (*)(Main *bmain, ID *id, int flags);
101
103
112 void (*)(ID *id, const IDCacheKey *cache_key, void **cache_p, uint flags, void *user_data);
114 IDTypeForeachCacheFunctionCallback function_callback,
115 void *user_data);
116
117using IDTypeForeachPathFunction = void (*)(ID *id, BPathForeachPathData *bpath_data);
118
119/* Foreach scene linear color can do either a single color, or an implicitly shared array
120 * for geometry attributes. */
122 const FunctionRef<void(float rgb[3])> single;
123 const FunctionRef<void(ImplicitSharingPtr<> &sharing_info, ColorGeometry4f *&data, size_t size)>
125};
127
129 void (*)(ID *id, FunctionRef<void(AssetWeakReference &weak_ref)> fn);
130
139using IDTypeEmbeddedOwnerPointerGetFunction = ID **(*)(ID * id, bool debug_relationship_assert);
140
141using IDTypeBlendWriteFunction = void (*)(BlendWriter *writer, ID *id, const void *id_address);
144
145using IDTypeBlendReadUndoPreserve = void (*)(BlendLibReader *reader, ID *id_new, ID *id_old);
146
147using IDTypeLibOverrideApplyPost = void (*)(ID *id_dst, ID *id_src);
148
150 /* ********** General IDType data. ********** */
151
162
170
177
179 size_t struct_size = 0;
180
188 const char *name = nullptr;
190 const char *name_plural = nullptr;
192 const char *translation_context = nullptr;
193
196
198 template<class T> static constexpr T InvalidPointer()
199 {
200 return reinterpret_cast<T>(UINTPTR_MAX);
201 }
202
207
208 /* ********** ID management callbacks ********** */
209
214
220
225
231
237
242
247
254
260
266
267 /* ********** Callbacks for reading and writing .blend files. ********** */
268
273
278
287
299
307};
308
309/* ********** Declaration of each IDTypeInfo. ********** */
310
311/* Those are defined in the respective BKE files. */
351
354
355/* ********** Helpers/Utils API. ********** */
356
357/* Module initialization. */
358void BKE_idtype_init();
359
360/* General helpers. */
361const IDTypeInfo *BKE_idtype_get_info_from_idtype_index(const int idtype_index);
362const IDTypeInfo *BKE_idtype_get_info_from_idcode(short id_code);
364
371const char *BKE_idtype_idcode_to_name(short idcode);
378const char *BKE_idtype_idcode_to_name_plural(short idcode);
385const char *BKE_idtype_idcode_to_translation_context(short idcode);
386
393bool BKE_idtype_idcode_is_valid(short idcode);
394
401bool BKE_idtype_idcode_is_linkable(short idcode);
408bool BKE_idtype_idcode_is_only_appendable(short idcode);
415bool BKE_idtype_idcode_append_is_reusable(short idcode);
416/* Macro currently, since any linkable IDtype should be localizable. */
417#define BKE_idtype_idcode_is_localizable BKE_idtype_idcode_is_linkable
418
427short BKE_idtype_idcode_from_name(const char *idtype_name);
437short BKE_idtype_idcode_from_name_case_insensitive(const char *idtype_name);
438
448const char *BKE_idtype_name_normalize(const char *idtype_name);
449
453int BKE_idtype_idcode_to_index(short idcode);
458
462short BKE_idtype_index_to_idcode(int idtype_index);
466uint64_t BKE_idtype_index_to_idfilter(int idtype_index);
467
476
483short BKE_idtype_idcode_iter_step(int *idtype_index);
484
485/* Some helpers/wrappers around callbacks defined in #IDTypeInfo, dealing e.g. with embedded IDs.
486 * XXX Ideally those would rather belong to #BKE_lib_id, but using callback function pointers makes
487 * this hard to do properly if we want to avoid headers includes in headers. */
488
493 IDTypeForeachCacheFunctionCallback function_callback,
494 void *user_data);
495
496} // namespace blender
#define UINTPTR_MAX
ID and Library types, which are fundamental for SDNA.
#define INDEX_ID_MAX
Definition DNA_ID.h:1362
#define ID_LINK_PLACEHOLDER
unsigned long long int uint64_t
#define T
BMesh Iterators.
const char * BKE_idtype_idcode_to_name(short idcode)
Definition idtype.cc:261
void(*)(ID *id, FunctionRef< void(AssetWeakReference &weak_ref)> fn) IDTypeForeachAssetWeakReferenceFunction
void BKE_idtype_id_foreach_cache(ID *id, IDTypeForeachCacheFunctionCallback function_callback, void *user_data)
Definition idtype.cc:489
IDTypeInfo IDType_ID_ME
uint64_t BKE_idtype_idcode_to_idfilter(short idcode)
Definition idtype.cc:473
IDTypeInfo IDType_ID_CU_LEGACY
Definition curve.cc:300
unsigned __int64 uint64_t
Definition BKE_text.h:91
short BKE_idtype_index_to_idcode(int idtype_index)
Definition idtype.cc:451
const IDTypeInfo * BKE_idtype_get_info_from_idcode(short id_code)
Definition idtype.cc:227
IDTypeInfo IDType_ID_BR
Definition brush.cc:591
IDTypeInfo IDType_ID_SCE
Definition scene.cc:1651
unsigned int uint
Definition BKE_text.h:55
eIDTypeInfoCacheCallbackFlags
@ IDTYPE_CACHE_CB_FLAGS_PERSISTENT
IDTypeInfo IDType_ID_LT
Definition lattice.cc:167
bool BKE_idtype_idcode_is_valid(short idcode)
Definition idtype.cc:302
IDTypeInfo IDType_ID_LINK_PLACEHOLDER
Definition lib_id.cc:89
IDTypeInfo IDType_ID_PAL
bool BKE_idtype_idcode_is_linkable(short idcode)
Definition idtype.cc:307
IDTypeInfo IDType_ID_PA
Definition particle.cc:413
void(*)(ID *id, const IDCacheKey *cache_key, void **cache_p, uint flags, void *user_data) IDTypeForeachCacheFunctionCallback
IDTypeInfo IDType_ID_OB
Definition object.cc:1269
uint BKE_idtype_cache_key_hash(const void *key_v)
Definition idtype.cc:30
IDTypeInfo IDType_ID_PC
bool BKE_idtype_idcode_append_is_reusable(short idcode)
Definition idtype.cc:326
IDTypeInfo IDType_ID_MC
Definition movieclip.cc:294
void(*)(BlendLibReader *reader, ID *id) IDTypeBlendReadAfterLiblinkFunction
void(*)(ID *id, const IDTypeForeachColorFunctionCallback &cb) IDTypeForeachColorFunction
void(*)(BlendDataReader *reader, ID *id) IDTypeBlendReadDataFunction
void(*)(Main *bmain, ID *id, int flags) IDTypeMakeLocalFunction
const char * BKE_idtype_name_normalize(const char *idtype_name)
Definition idtype.cc:296
IDTypeInfo IDType_ID_GD_LEGACY
IDTypeInfo IDType_ID_WM
Definition wm.cc:242
IDTypeInfo IDType_ID_MB
Definition mball.cc:139
void BKE_idtype_init()
Definition idtype.cc:207
unsigned int uint32_t
Definition BKE_text.h:81
void(*)(ID *id, IDTypeForeachCacheFunctionCallback function_callback, void *user_data) IDTypeForeachCacheFunction
IDTypeInfo IDType_ID_SO
const IDTypeInfo * BKE_idtype_get_info_from_id(const ID *id)
Definition idtype.cc:232
IDTypeInfo IDType_ID_TE
Definition texture.cc:185
void(*)(BlendLibReader *reader, ID *id_new, ID *id_old) IDTypeBlendReadUndoPreserve
IDTypeInfo IDType_ID_TXT
Definition text.cc:230
void(*)(ID *id, BPathForeachPathData *bpath_data) IDTypeForeachPathFunction
IDTypeInfo IDType_ID_PT
short BKE_idtype_idcode_iter_step(int *idtype_index)
Definition idtype.cc:483
BMesh const char void * data
IDTypeInfo IDType_ID_GP
void(*)(ID *id) IDTypeInitDataFunction
Definition BKE_idtype.hh:91
const IDTypeInfo * BKE_idtype_get_info_from_idtype_index(const int idtype_index)
Definition idtype.cc:213
int BKE_idtype_idcode_to_index(short idcode)
Definition idtype.cc:338
void(*)(ID *id, LibraryForeachIDData *data) IDTypeForeachIDFunction
const char * BKE_idtype_idcode_to_name_plural(short idcode)
Definition idtype.cc:268
IDTypeInfo IDType_ID_WO
ID **(*)(ID *id, bool debug_relationship_assert) IDTypeEmbeddedOwnerPointerGetFunction
IDTypeInfo IDType_ID_GR
bool BKE_idtype_idcode_is_only_appendable(short idcode)
Definition idtype.cc:314
IDTypeInfo IDType_ID_LI
Definition library.cc:217
uint64_t BKE_idtype_index_to_idfilter(int idtype_index)
Definition idtype.cc:462
IDTypeInfo IDType_ID_LA
IDTypeInfo IDType_ID_SCR
Definition screen.cc:271
IDTypeInfo IDType_ID_LS
Definition linestyle.cc:716
IDTypeInfo IDType_ID_WS
Definition workspace.cc:226
IDTypeInfo IDType_ID_NT
Definition node.cc:2527
IDTypeInfo IDType_ID_SPK
Definition speaker.cc:50
IDTypeInfo IDType_ID_VF
Definition vfont.cc:167
void(*)(BlendWriter *writer, ID *id, const void *id_address) IDTypeBlendWriteFunction
short BKE_idtype_idfilter_to_idcode(uint64_t idfilter)
Definition idtype.cc:478
bool BKE_idtype_cache_key_cmp(const void *key_a_v, const void *key_b_v)
Definition idtype.cc:38
short BKE_idtype_idcode_from_name_case_insensitive(const char *idtype_name)
Definition idtype.cc:289
IDTypeInfo IDType_ID_LP
Definition lightprobe.cc:53
void(*)(ID *id_dst, ID *id_src) IDTypeLibOverrideApplyPost
short BKE_idtype_idcode_from_name(const char *idtype_name)
Definition idtype.cc:282
ColorSceneLinear4f< eAlpha::Premultiplied > ColorGeometry4f
IDTypeInfo IDType_ID_CF
Definition cachefile.cc:124
int BKE_idtype_idfilter_to_index(uint64_t id_filter)
Definition idtype.cc:396
void(*)(ID *id) IDTypeFreeDataFunction
Definition BKE_idtype.hh:97
IDTypeInfo IDType_ID_MSK
void(*)( Main *bmain, std::optional< Library * > owner_library, ID *id_dst, const ID *id_src, int flag) IDTypeCopyDataFunction
Definition BKE_idtype.hh:94
const char * BKE_idtype_idcode_to_translation_context(short idcode)
Definition idtype.cc:275
IDTypeInfo IDType_ID_KE
Definition key.cc:173
@ IDTYPE_FLAGS_NO_MEMFILE_UNDO
Definition BKE_idtype.hh:59
@ IDTYPE_FLAGS_NO_COPY
Definition BKE_idtype.hh:36
@ IDTYPE_FLAGS_NO_ANIMDATA
Definition BKE_idtype.hh:52
@ IDTYPE_FLAGS_ONLY_APPEND
Definition BKE_idtype.hh:44
@ IDTYPE_FLAGS_NO_LIBLINKING
Definition BKE_idtype.hh:38
@ IDTYPE_FLAGS_NEVER_UNUSED
Definition BKE_idtype.hh:73
@ IDTYPE_FLAGS_APPEND_IS_REUSABLE
Definition BKE_idtype.hh:50
unsigned int id_session_uid
Definition BKE_idtype.hh:78
const FunctionRef< void(float rgb[3])> single
const FunctionRef< void(ImplicitSharingPtr<> &sharing_info, ColorGeometry4f *&data, size_t size)> implicit_sharing_array
IDTypeForeachIDFunction foreach_id
const char * name_plural
IDTypeForeachPathFunction foreach_path
IDTypeBlendWriteFunction blend_write
static constexpr T InvalidPointer()
IDTypeBlendReadAfterLiblinkFunction blend_read_after_liblink
IDTypeForeachCacheFunction foreach_cache
IDTypeEmbeddedOwnerPointerGetFunction owner_pointer_get
IDTypeForeachColorFunction foreach_working_space_color
IDTypeMakeLocalFunction make_local
AssetTypeInfo * asset_type_info
IDTypeForeachAssetWeakReferenceFunction foreach_asset_weak_reference
IDTypeLibOverrideApplyPost lib_override_apply_post
IDTypeInitDataFunction init_data
IDTypeBlendReadUndoPreserve blend_read_undo_preserve
IDTypeCopyDataFunction copy_data
const char * translation_context
IDTypeBlendReadDataFunction blend_read_data
uint64_t dependencies_id_types
IDTypeFreeDataFunction free_data
const char * name