Blender V5.3
BKE_lib_query.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2014 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4#pragma once
5
21
22#include "DNA_ID.h"
23
24#include "BLI_enum_flags.hh"
25#include "BLI_function_ref.hh"
26
27#include <array>
28
29namespace blender {
30
31struct IDTypeInfo;
33struct Main;
34
35/* Tips for the callback for cases it's gonna to modify the pointer. */
133
134enum {
148};
149
167
174
175/* Flags for the foreach function itself. */
251
258 ID **id_pp,
264 bool do_replace);
265
267#define BKE_LIB_FOREACHID_PROCESS_ID_NOCHECK(data_, id_, cb_flag_) \
268 { \
269 BKE_lib_query_foreachid_process((data_), (ID **)&(id_), (cb_flag_)); \
270 if (BKE_lib_query_foreachid_iter_stop((data_))) { \
271 return; \
272 } \
273 } \
274 ((void)0)
275
276#define BKE_LIB_FOREACHID_PROCESS_ID(data_, id_, cb_flag_) \
277 { \
278 CHECK_TYPE_ANY((id_), ID *, void *); \
279 BKE_LIB_FOREACHID_PROCESS_ID_NOCHECK(data_, id_, cb_flag_); \
280 } \
281 ((void)0)
282
283#define BKE_LIB_FOREACHID_PROCESS_IDSUPER_P(data_, id_super_p_, cb_flag_) \
284 { \
285 CHECK_TYPE(&((*(id_super_p_))->id), ID *); \
286 BKE_lib_query_foreachid_process((data_), (ID **)(id_super_p_), (cb_flag_)); \
287 if (BKE_lib_query_foreachid_iter_stop((data_))) { \
288 return; \
289 } \
290 } \
291 ((void)0)
292
293#define BKE_LIB_FOREACHID_PROCESS_IDSUPER(data_, id_super_, cb_flag_) \
294 { \
295 BKE_LIB_FOREACHID_PROCESS_IDSUPER_P(data_, &(id_super_), cb_flag_); \
296 } \
297 ((void)0)
298
299#define BKE_LIB_FOREACHID_PROCESS_FUNCTION_CALL(data_, func_call_) \
300 { \
301 func_call_; \
302 if (BKE_lib_query_foreachid_iter_stop((data_))) { \
303 return; \
304 } \
305 } \
306 ((void)0)
307
314void BKE_library_foreach_ID_embedded(LibraryForeachIDData *data, ID **id_pp);
315void BKE_lib_query_idpropertiesForeachIDLink_callback(IDProperty *id_prop, void *user_data);
316
327void BKE_library_foreach_ID_link(Main *bmain,
328 ID *id,
329 FunctionRef<LibraryIDLinkCallback> callback,
330 void *user_data,
332
363 Main *bmain,
364 ID *owner_id,
365 ID *self_id,
366 FunctionRef<void(LibraryForeachIDData *data)> subdata_foreach_id,
367 FunctionRef<LibraryIDLinkCallback> callback,
368 void *user_data,
369 const LibraryForeachIDFlag flag);
370
374void BKE_library_update_ID_link_user(ID *id_dst, ID *id_src, int cb_flag);
375
386int BKE_library_ID_use_ID(ID *id_user, ID *id_used);
387
394bool BKE_library_id_can_use_idtype(ID *owner_id, short id_type_used);
395
400 const bool include_ui,
401 const IDTypeInfo *owner_id_type = nullptr);
402
406bool BKE_library_ID_is_locally_used(Main *bmain, void *idv);
410bool BKE_library_ID_is_indirectly_used(Main *bmain, void *idv);
415void BKE_library_ID_test_usages(Main *bmain,
416 void *idv,
417 bool *r_is_used_local,
418 bool *r_is_used_linked);
419
423 bool do_local_ids = false;
425 bool do_linked_ids = false;
431 bool do_recursive = false;
432
444 FunctionRef<bool(ID *id)> filter_fn = nullptr;
445
452 std::array<int, INDEX_ID_MAX> num_total;
459 std::array<int, INDEX_ID_MAX> num_local;
466 std::array<int, INDEX_ID_MAX> num_linked;
467};
468
496void BKE_lib_query_unused_ids_tag(Main *bmain, int tag, LibQueryUnusedIDsData &parameters);
497
507void BKE_library_unused_linked_data_set_tag(Main *bmain, bool do_init_tag);
517
518} // namespace blender
ID and Library types, which are fundamental for SDNA.
unsigned long long int uint64_t
ENUM_OPERATORS(Layer::Flags)
BMesh Iterators.
Main * BKE_lib_query_foreachid_process_main_get(const LibraryForeachIDData *data)
Definition lib_query.cc:138
void BKE_lib_query_unused_ids_tag(Main *bmain, int tag, LibQueryUnusedIDsData &parameters)
int(LibraryIDLinkCallbackData *cb_data) LibraryIDLinkCallback
bool BKE_library_id_can_use_idtype(ID *owner_id, short id_type_used)
Definition lib_query.cc:538
@ IDWALK_NO_ORIG_POINTERS_ACCESS
@ IDWALK_IGNORE_EMBEDDED_ID
@ IDWALK_DO_INTERNAL_RUNTIME_POINTERS
@ IDWALK_DO_LIBRARY_POINTER
@ IDWALK_DO_DEPRECATED_POINTERS
@ IDWALK_IGNORE_MISSING_OWNER_ID
LibraryForeachIDFlag BKE_lib_query_foreachid_process_flags_get(const LibraryForeachIDData *data)
Definition lib_query.cc:133
void BKE_lib_query_foreachid_process(LibraryForeachIDData *data, ID **id_pp, LibraryForeachIDCallbackFlag cb_flag)
Definition lib_query.cc:82
void BKE_library_ID_test_usages(Main *bmain, void *idv, bool *r_is_used_local, bool *r_is_used_linked)
Definition lib_query.cc:657
void BKE_lib_query_unused_ids_amounts(Main *bmain, LibQueryUnusedIDsData &parameters)
void BKE_library_foreach_subdata_id(Main *bmain, ID *owner_id, ID *self_id, FunctionRef< void(LibraryForeachIDData *data)> subdata_foreach_id, FunctionRef< LibraryIDLinkCallback > callback, void *user_data, const LibraryForeachIDFlag flag)
Definition lib_query.cc:469
int BKE_lib_query_foreachid_process_callback_flag_override(LibraryForeachIDData *data, LibraryForeachIDCallbackFlag cb_flag, bool do_replace)
Definition lib_query.cc:143
bool BKE_library_ID_is_locally_used(Main *bmain, void *idv)
Definition lib_query.cc:647
BMesh const char void * data
void BKE_library_foreach_ID_embedded(LibraryForeachIDData *data, ID **id_pp)
Definition lib_query.cc:176
void BKE_library_unused_linked_data_set_tag(Main *bmain, bool do_init_tag)
bool BKE_lib_query_foreachid_iter_stop(const LibraryForeachIDData *data)
Definition lib_query.cc:77
@ IDWALK_RET_STOP_ITER
@ IDWALK_RET_STOP_RECURSION
uint64_t BKE_library_id_can_use_filter_id(const ID *owner_id, const bool include_ui, const IDTypeInfo *owner_id_type=nullptr)
Definition lib_query.cc:494
void BKE_library_update_ID_link_user(ID *id_dst, ID *id_src, int cb_flag)
Definition lib_query.cc:458
bool BKE_library_ID_is_indirectly_used(Main *bmain, void *idv)
Definition lib_query.cc:652
LibraryForeachIDCallbackFlag
@ IDWALK_CB_LOOPBACK
@ IDWALK_CB_WRITEFILE_IGNORE
@ IDWALK_CB_DIRECT_WEAK_LINK
@ IDWALK_CB_EMBEDDED_NOT_OWNING
@ IDWALK_CB_OVERRIDE_LIBRARY_NOT_OVERRIDABLE
@ IDWALK_CB_HASH_IGNORE
@ IDWALK_CB_OVERRIDE_LIBRARY_HIERARCHY_DEFAULT
@ IDWALK_CB_NEVER_NULL
@ IDWALK_CB_NEVER_SELF
@ IDWALK_CB_INTERNAL
@ IDWALK_CB_OVERRIDE_LIBRARY_HIERARCHY_ROOT
@ IDWALK_CB_READFILE_IGNORE
@ IDWALK_CB_OVERRIDE_LIBRARY_REFERENCE
@ IDWALK_CB_EMBEDDED
@ IDWALK_CB_INDIRECT_USAGE
int BKE_library_ID_use_ID(ID *id_user, ID *id_used)
Definition lib_query.cc:596
void BKE_lib_query_idpropertiesForeachIDLink_callback(IDProperty *id_prop, void *user_data)
Definition lib_query.cc:164
void BKE_library_foreach_ID_link(Main *bmain, ID *id, FunctionRef< LibraryIDLinkCallback > callback, void *user_data, LibraryForeachIDFlag flag)
Definition lib_query.cc:449
void BKE_library_indirectly_used_data_tag_clear(Main *bmain)
FunctionRef< bool(ID *id)> filter_fn
std::array< int, INDEX_ID_MAX > num_linked
std::array< int, INDEX_ID_MAX > num_total
std::array< int, INDEX_ID_MAX > num_local
LibraryForeachIDCallbackFlag cb_flag