Classes
struct	LibraryIDLinkCallbackData

Macros
#define	BKE_LIB_FOREACHID_PROCESS_ID(_data, _id, _cb_flag)

#define	BKE_LIB_FOREACHID_PROCESS(_data, _id_super, _cb_flag)

Typedefs
typedef struct LibraryIDLinkCallbackData	LibraryIDLinkCallbackData

typedef int(*	LibraryIDLinkCallback) (LibraryIDLinkCallbackData *cb_data)

typedef struct LibraryForeachIDData	LibraryForeachIDData

Enumerations
enum	{ IDWALK_CB_NOP = 0 , IDWALK_CB_NEVER_NULL = (1 << 0) , IDWALK_CB_NEVER_SELF = (1 << 1) , IDWALK_CB_INDIRECT_USAGE = (1 << 2) , IDWALK_CB_EMBEDDED = (1 << 3) , IDWALK_CB_LOOPBACK = (1 << 4) , IDWALK_CB_OVERRIDE_LIBRARY_REFERENCE = (1 << 5) , IDWALK_CB_OVERRIDE_LIBRARY_NOT_OVERRIDABLE = (1 << 6) , IDWALK_CB_INTERNAL = (1 << 7) , IDWALK_CB_USER = (1 << 8) , IDWALK_CB_USER_ONE = (1 << 9) }

enum	{ IDWALK_RET_NOP = 0 , IDWALK_RET_STOP_ITER = 1 << 0 , IDWALK_RET_STOP_RECURSION = 1 << 1 }

enum	{ IDWALK_NOP = 0 , IDWALK_READONLY = (1 << 0) , IDWALK_RECURSE = (1 << 1) , IDWALK_INCLUDE_UI = (1 << 2) , IDWALK_IGNORE_EMBEDDED_ID = (1 << 3) , IDWALK_NO_INDIRECT_PROXY_DATA_USAGE = (1 << 8) , IDWALK_DO_INTERNAL_RUNTIME_POINTERS = (1 << 9) }

Functions
bool	BKE_lib_query_foreachid_process (struct LibraryForeachIDData data, struct ID *id_pp, int cb_flag)

int	BKE_lib_query_foreachid_process_flags_get (struct LibraryForeachIDData *data)

int	BKE_lib_query_foreachid_process_callback_flag_override (struct LibraryForeachIDData *data, const int cb_flag, const bool do_replace)

bool	BKE_library_foreach_ID_embedded (struct LibraryForeachIDData data, struct ID *id_pp)

void	BKE_lib_query_idpropertiesForeachIDLink_callback (struct IDProperty id_prop, void user_data)

void	BKE_library_foreach_ID_link (struct Main bmain, struct ID id, LibraryIDLinkCallback callback, void *user_data, int flag)

void	BKE_library_update_ID_link_user (struct ID id_dst, struct ID id_src, const int cb_flag)

int	BKE_library_ID_use_ID (struct ID id_user, struct ID id_used)

bool	BKE_library_id_can_use_idtype (struct ID *id_owner, const short id_type_used)

bool	BKE_library_ID_is_locally_used (struct Main bmain, void idv)

bool	BKE_library_ID_is_indirectly_used (struct Main bmain, void idv)

void	BKE_library_ID_test_usages (struct Main bmain, void idv, bool is_used_local, bool is_used_linked)

void	BKE_lib_query_unused_ids_tag (struct Main bmain, const int tag, const bool do_local_ids, const bool do_linked_ids, const bool do_tag_recursive, int r_num_tagged)

void	BKE_library_unused_linked_data_set_tag (struct Main *bmain, const bool do_init_tag)

void	BKE_library_indirectly_used_data_tag_clear (struct Main *bmain)

Detailed Description

API to perform operations over all ID pointers used by a given data-block.

Note: BKE_lib_ files are for operations over data-blocks themselves, although they might alter Main as well (when creating/renaming/deleting an ID e.g.).

Names

Warning: Descriptions below is ideal goal, current status of naming does not yet fully follow it (this is WIP).

BKE_lib_query_ should be used for functions in that file.

Definition in file BKE_lib_query.h.

Macro Definition Documentation

◆ BKE_LIB_FOREACHID_PROCESS

#define BKE_LIB_FOREACHID_PROCESS	(	_data,
		_id_super,
		_cb_flag
	)

Value:

  { \
    CHECK_TYPE(&((_id_super)->id), ID *); \
    if (!BKE_lib_query_foreachid_process((_data), (ID **)&(_id_super), (_cb_flag))) { \
      return; \
    } \
  } \
  ((void)0)

Definition at line 163 of file BKE_lib_query.h.

◆ BKE_LIB_FOREACHID_PROCESS_ID

#define BKE_LIB_FOREACHID_PROCESS_ID	(	_data,
		_id,
		_cb_flag
	)

Value:

  { \
    CHECK_TYPE_ANY((_id), ID *, void *); \
    if (!BKE_lib_query_foreachid_process((_data), (ID **)&(_id), (_cb_flag))) { \
      return; \
    } \
  } \
  ((void)0)

Definition at line 154 of file BKE_lib_query.h.

Typedef Documentation

◆ LibraryForeachIDData

typedef struct LibraryForeachIDData LibraryForeachIDData

Definition at line 127 of file BKE_lib_query.h.

◆ LibraryIDLinkCallback

typedef int(* LibraryIDLinkCallback) (LibraryIDLinkCallbackData *cb_data)

Call a callback for each ID link which the given ID uses.

Returns: a set of flags to control further iteration (0 to keep going).

Definition at line 127 of file BKE_lib_query.h.

◆ LibraryIDLinkCallbackData

typedef struct LibraryIDLinkCallbackData LibraryIDLinkCallbackData

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
IDWALK_CB_NOP
IDWALK_CB_NEVER_NULL
IDWALK_CB_NEVER_SELF
IDWALK_CB_INDIRECT_USAGE	Indicates whether this is direct (i.e. by local data) or indirect (i.e. by linked data) usage. Note Object proxies are half-local, half-linked...
IDWALK_CB_EMBEDDED	That ID is used as mere sub-data by its owner (only case currently: those root nodetrees in materials etc., and the Scene's master collections). This means callback shall not do anything, only use this as informative data if it needs it.
IDWALK_CB_LOOPBACK	That ID is not really used by its owner, it's just an internal hint/helper. This addresses Their Highest Ugliness the 'from' pointers: Object->from_proxy and Key->from. How to handle that kind of cases totally depends on what caller code is doing...
IDWALK_CB_OVERRIDE_LIBRARY_REFERENCE	That ID is used as library override's reference by its owner.
IDWALK_CB_OVERRIDE_LIBRARY_NOT_OVERRIDABLE	That ID pointer is not overridable.
IDWALK_CB_INTERNAL	Indicates that this is an internal runtime ID pointer, like e.g. `ID.newid` or `ID.original`. Note Those should be ignored in most cases, and won't be processed/generated anyway unless `IDWALK_DO_INTERNAL_RUNTIME_POINTERS` option is enabled.
IDWALK_CB_USER	This ID usage is fully refcounted. Callback is responsible to deal accordingly with ID.us if needed.
IDWALK_CB_USER_ONE	This ID usage is not refcounted, but at least one user should be generated by it (to avoid e.g. losing the used ID on save/reload). Callback is responsible to deal accordingly with ID.us if needed.

Definition at line 46 of file BKE_lib_query.h.

◆ anonymous enum

anonymous enum

Enumerator
IDWALK_RET_NOP
IDWALK_RET_STOP_ITER	Completely stop iteration.
IDWALK_RET_STOP_RECURSION	Stop recursion, that is, do not loop over ID used by current one.

Definition at line 96 of file BKE_lib_query.h.

◆ anonymous enum

anonymous enum

Enumerator
IDWALK_NOP
IDWALK_READONLY
IDWALK_RECURSE
IDWALK_INCLUDE_UI
IDWALK_IGNORE_EMBEDDED_ID	Do not process ID pointers inside embedded IDs. Needed by depsgraph processing e.g.
IDWALK_NO_INDIRECT_PROXY_DATA_USAGE
IDWALK_DO_INTERNAL_RUNTIME_POINTERS	Also process internal ID pointers like `ID.newid` or `ID.orig_id`. WARNING: Dangerous, use with caution.

Definition at line 130 of file BKE_lib_query.h.

Function Documentation

◆ BKE_lib_query_foreachid_process()

bool BKE_lib_query_foreachid_process	(	struct LibraryForeachIDData *	data,
		struct ID **	id_pp,
		int	cb_flag
	)

◆ BKE_lib_query_foreachid_process_callback_flag_override()

int BKE_lib_query_foreachid_process_callback_flag_override	(	struct LibraryForeachIDData *	data,
		const int	cb_flag,
		const bool	do_replace
	)

Definition at line 128 of file lib_query.c.

References data.

Referenced by object_foreach_id().

◆ BKE_lib_query_foreachid_process_flags_get()

int BKE_lib_query_foreachid_process_flags_get ( struct LibraryForeachIDData * data )

Definition at line 123 of file lib_query.c.

References data.

Referenced by object_foreach_id(), screen_foreach_id(), and window_manager_foreach_id().

◆ BKE_lib_query_idpropertiesForeachIDLink_callback()

void BKE_lib_query_idpropertiesForeachIDLink_callback	(	struct IDProperty *	id_prop,
		void *	user_data
	)

Definition at line 150 of file lib_query.c.

References BKE_LIB_FOREACHID_PROCESS_ID, BLI_assert, data, IDProperty::data, IDProperty::flag, IDP_FLAG_OVERRIDABLE_LIBRARY, IDP_ID, IDWALK_CB_OVERRIDE_LIBRARY_NOT_OVERRIDABLE, IDWALK_CB_USER, IDPropertyData::pointer, IDProperty::type, and user_data.

Referenced by armature_foreach_id_bone(), armature_foreach_id_editbone(), BKE_fcurve_foreach_id(), library_foreach_ID_link(), library_foreach_node_socket(), node_foreach_id(), object_foreach_id(), and scene_foreach_id().

◆ BKE_lib_query_unused_ids_tag()

void BKE_lib_query_unused_ids_tag	(	Main *	bmain,
		const int	tag,
		const bool	do_local_ids,
		const bool	do_linked_ids,
		const bool	do_tag_recursive,
		int *	r_num_tagged
	)

Tag all unused IDs (a.k.a 'orphaned').

By default only tag IDs with 0 user count. If do_tag_recursive is set, it will check dependencies to detect all IDs that are not actually used in current file, including 'archipelagos‘ (i.e. set of IDs referencing each other in loops, but without any 'external’ valid usages.

Valid usages here are defined as ref-counting usages, which are not towards embedded or loop-back data.

Parameters

r_num_tagged If non-NULL, must be a zero-initialized array of INDEX_ID_MAX integers. Number of tagged-as-unused IDs is then set for each type, and as total in INDEX_ID_NULL item.

Definition at line 726 of file lib_query.c.

References BKE_idtype_idcode_to_index(), BKE_main_relations_create(), BKE_main_relations_free(), FOREACH_MAIN_ID_BEGIN, FOREACH_MAIN_ID_END, GS, id, ID_IS_LINKED, INDEX_ID_NULL, lib_query_unused_ids_tag_recurse(), ID::name, NULL, and ID::us.

Referenced by bpy_orphans_purge(), outliner_orphans_purge_exec(), and outliner_orphans_purge_invoke().

◆ BKE_library_foreach_ID_embedded()

bool BKE_library_foreach_ID_embedded	(	struct LibraryForeachIDData *	data,
		struct ID **	id_pp
	)

Definition at line 161 of file lib_query.c.

References BKE_lib_query_foreachid_process(), BLI_assert, BLI_gset_add(), BLI_LINKSTACK_PUSH, data, IDWALK_CB_EMBEDDED, IDWALK_IGNORE_EMBEDDED_ID, IDWALK_RECURSE, library_foreach_ID_link(), and NULL.

Referenced by light_foreach_id(), linestyle_foreach_id(), material_foreach_id(), scene_foreach_id(), simulation_foreach_id(), texture_foreach_id(), and world_foreach_id().

◆ BKE_library_foreach_ID_link()

void BKE_library_foreach_ID_link	(	Main *	bmain,
		ID *	id,
		LibraryIDLinkCallback	callback,
		void *	user_data,
		int	flag
	)

Loop over all of the ID's this data-block links to.

Definition at line 322 of file lib_query.c.

References callback, library_foreach_ID_link(), NULL, and user_data.

Referenced by BKE_id_copy_ex(), BKE_lib_id_expand_local(), BKE_libblock_management_main_add(), BKE_libblock_management_usercounts_clear(), BKE_libblock_management_usercounts_set(), BKE_libblock_relink_to_newid(), BKE_library_ID_test_usages(), BKE_library_ID_use_ID(), BKE_library_indirectly_used_data_tag_clear(), BKE_library_unused_linked_data_set_tag(), BKE_main_id_refcount_recompute(), BKE_main_relations_create(), BKE_mesh_new_from_object_to_bmain(), bpy_user_map(), brush_undo_preserve(), blender::deg::deg_expand_copy_on_write_datablock(), blender::deg::deg_validate_copy_on_write_datablock(), gather_frames_to_render(), lib_id_clear_library_data_ex(), lib_link_main_data_restore(), libblock_remap_data(), library_ID_is_used(), memfile_undosys_step_decode(), previews_ensure_exec(), and tag_localizable_objects().

◆ BKE_library_id_can_use_idtype()

bool BKE_library_id_can_use_idtype	(	ID *	id_owner,
		const short	id_type_used
	)

Say whether given id_owner may use (in any way) a data-block of id_type_used.

This is a 'simplified' abstract version of BKE_library_foreach_ID_link() above, quite useful to reduce useless iterations in some cases.

Definition at line 348 of file lib_query.c.

References BKE_animdata_from_id(), ELEM, GS, ID_AC, ID_AR, ID_BR, ID_CA, ID_CF, ID_CU, ID_GD, ID_GR, ID_HA, ID_IM, ID_IP, ID_KE, ID_LA, ID_LI, ID_LP, ID_LS, ID_LT, ID_MA, ID_MB, ID_MC, ID_ME, ID_MSK, ID_NT, ID_OB, ID_PA, ID_PAL, ID_PC, ID_PT, ID_SCE, ID_SCR, ID_SIM, ID_SO, ID_SPK, ID_TE, ID_TXT, ID_VF, ID_VO, ID_WM, ID_WO, ID_WS, ID::name, ntreeFromID(), and ID::properties.

Referenced by BKE_library_ID_test_usages(), libblock_remap_data(), and library_ID_is_used().

◆ BKE_library_ID_is_indirectly_used()

bool BKE_library_ID_is_indirectly_used	(	Main *	bmain,
		void *	idv
	)

Check whether given ID is used indirectly (i.e. by another linked ID).

Definition at line 588 of file lib_query.c.

References library_ID_is_used().

Referenced by BKE_brush_delete(), ED_object_base_free_and_unlink(), ED_object_base_free_and_unlink_no_indirect_check(), id_delete(), object_delete_exec(), outline_batch_delete_hierarchy(), and outliner_object_delete_fn().

◆ BKE_library_ID_is_locally_used()

bool BKE_library_ID_is_locally_used	(	Main *	bmain,
		void *	idv
	)

Check whether given ID is used locally (i.e. by another non-linked ID).

Definition at line 580 of file lib_query.c.

References library_ID_is_used().

◆ BKE_library_ID_test_usages()

void BKE_library_ID_test_usages	(	Main *	bmain,
		void *	idv,
		bool *	is_used_local,
		bool *	is_used_linked
	)

Combine BKE_library_ID_is_locally_used() and BKE_library_ID_is_indirectly_used() in a single call.

Definition at line 597 of file lib_query.c.

References BKE_library_foreach_ID_link(), BKE_library_id_can_use_idtype(), IDUsersIter::count_direct, IDUsersIter::count_indirect, IDUsersIter::curr_id, ListBase::first, foreach_libblock_id_users_callback(), GS, IDUsersIter::id, id, IDWALK_READONLY, INDEX_ID_MAX, ID::name, ID::next, and set_listbasepointers().

Referenced by BKE_lib_id_make_local_generic(), BKE_library_make_local(), brush_make_local(), and object_make_local().

◆ BKE_library_ID_use_ID()

int BKE_library_ID_use_ID	(	ID *	id_user,
		ID *	id_used
	)

Return the number of times given id_user uses/references id_used.

Note: This only checks for pointer references of an ID, shallow usages (like e.g. by RNA paths, as done for FCurves) are not detected at all.

Parameters

id_user	the ID which is supposed to use (reference) id_used.
id_used	the ID which is supposed to be used (referenced) by id_user.

Returns: the number of direct usages/references of id_used by id_user.

Definition at line 529 of file lib_query.c.

References BKE_library_foreach_ID_link(), IDUsersIter::count_direct, IDUsersIter::count_indirect, IDUsersIter::curr_id, foreach_libblock_id_users_callback(), IDUsersIter::id, IDWALK_READONLY, and NULL.

◆ BKE_library_indirectly_used_data_tag_clear()

void BKE_library_indirectly_used_data_tag_clear ( Main * bmain )

Untag linked data blocks used by other untagged linked data-blocks. Used to detect data-blocks that we can forcefully make local (instead of copying them to later get rid of original): All data-blocks we want to make local are tagged by caller, after this function has ran caller knows data-blocks still tagged can directly be made local, since they are only used by other data-blocks that will also be made fully local.

Definition at line 836 of file lib_query.c.

References BKE_library_foreach_ID_link(), foreach_libblock_used_linked_data_tag_clear_cb(), id, IDWALK_READONLY, INDEX_ID_MAX, ID::lib, LIB_TAG_DOIT, LISTBASE_FOREACH, NULL, set_listbasepointers(), and ID::tag.

◆ BKE_library_unused_linked_data_set_tag()

void BKE_library_unused_linked_data_set_tag	(	Main *	bmain,
		const bool	do_init_tag
	)

Detect orphaned linked data blocks (i.e. linked data not used (directly or indirectly) in any way by any local data), including complex cases like 'linked archipelagoes', i.e. linked data-blocks that use each other in loops, which prevents their deletion by 'basic' usage checks.

Parameters

do_init_tag if true, all linked data are checked, if false, only linked data-blocks already tagged with LIB_TAG_DOIT are checked.

Definition at line 799 of file lib_query.c.

References BKE_library_foreach_ID_link(), foreach_libblock_used_linked_data_tag_clear_cb(), FOREACH_MAIN_ID_BEGIN, FOREACH_MAIN_ID_END, id, IDWALK_READONLY, ID::lib, LIB_TAG_DOIT, LIB_TAG_INDIRECT, and ID::tag.

◆ BKE_library_update_ID_link_user()

void BKE_library_update_ID_link_user	(	ID *	id_dst,
		ID *	id_src,
		const int	cb_flag
	)

re-usable function, use when replacing ID's

Definition at line 331 of file lib_query.c.

References id_us_ensure_real(), id_us_min(), id_us_plus(), IDWALK_CB_USER, and IDWALK_CB_USER_ONE.

Referenced by id_relink_to_newid_looper().

Classes

Macros

Typedefs

Enumerations

Functions

Detailed Description

Names

Macro Definition Documentation

◆ BKE_LIB_FOREACHID_PROCESS

◆ BKE_LIB_FOREACHID_PROCESS_ID

Typedef Documentation

◆ LibraryForeachIDData

◆ LibraryIDLinkCallback

◆ LibraryIDLinkCallbackData

Enumeration Type Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Function Documentation

◆ BKE_lib_query_foreachid_process()

◆ BKE_lib_query_foreachid_process_callback_flag_override()

◆ BKE_lib_query_foreachid_process_flags_get()

◆ BKE_lib_query_idpropertiesForeachIDLink_callback()

◆ BKE_lib_query_unused_ids_tag()

◆ BKE_library_foreach_ID_embedded()

◆ BKE_library_foreach_ID_link()

◆ BKE_library_id_can_use_idtype()

◆ BKE_library_ID_is_indirectly_used()

◆ BKE_library_ID_is_locally_used()

◆ BKE_library_ID_test_usages()

◆ BKE_library_ID_use_ID()

◆ BKE_library_indirectly_used_data_tag_clear()

◆ BKE_library_unused_linked_data_set_tag()

◆ BKE_library_update_ID_link_user()