#include <array>
#include "DNA_listBase.h"
#include "BLI_compiler_attrs.h"
#include "BLI_math_matrix_types.hh"
#include "BLI_sys_types.h"
#include "BLI_utility_mixins.hh"
#include "BLI_vector_set.hh"
#include "BKE_lib_query.hh"

Classes
struct	BlendThumbnail
struct	MainIDRelationsEntryItem
struct	MainIDRelationsEntry
struct	MainIDRelations
struct	MainColorspace
struct	Main
struct	MainMergeReport

Macros
#define	FOREACH_MAIN_LISTBASE_ID_BEGIN(_lb, _id)
#define	FOREACH_MAIN_LISTBASE_ID_END
#define	FOREACH_MAIN_LISTBASE_BEGIN(_bmain, _lb)
#define	FOREACH_MAIN_LISTBASE_END
#define	FOREACH_MAIN_ID_BEGIN(_bmain, _id)
#define	FOREACH_MAIN_ID_END
#define	MAIN_VERSION_FILE_ATLEAST(main, ver, subver)
#define	MAIN_VERSION_FILE_OLDER(main, ver, subver)
#define	MAIN_VERSION_FILE_OLDER_OR_EQUAL(main, ver, subver)
#define	LIBRARY_VERSION_FILE_ATLEAST(lib, ver, subver)
#define	BLEN_THUMB_SIZE 128
#define	BLEN_THUMB_MEMSIZE(_x, _y)
#define	BLEN_THUMB_MEMSIZE_IS_VALID(_x, _y)

Typedefs
using	MainListsArray = std::array<ListBase *, INDEX_ID_MAX - 1>

Enumerations
enum	eMainIDRelationsEntryTags { MAINIDRELATIONS_ENTRY_TAGS_DOIT = 1 << 0 , MAINIDRELATIONS_ENTRY_TAGS_PROCESSED_TO = 1 << 4 , MAINIDRELATIONS_ENTRY_TAGS_PROCESSED_FROM = 1 << 5 , MAINIDRELATIONS_ENTRY_TAGS_PROCESSED , MAINIDRELATIONS_ENTRY_TAGS_INPROGRESS_TO = 1 << 8 , MAINIDRELATIONS_ENTRY_TAGS_INPROGRESS_FROM = 1 << 9 , MAINIDRELATIONS_ENTRY_TAGS_INPROGRESS }
enum	{ MAINIDRELATIONS_INCLUDE_UI = 1 << 0 }

Functions
Main *	BKE_main_new ()
void	BKE_main_clear (Main &bmain)
void	BKE_main_free (Main *bmain)
void	BKE_main_merge (Main bmain_dst, Main *r_bmain_src, MainMergeReport &reports)
bool	BKE_main_is_empty (Main *bmain)
bool	BKE_main_has_issues (const Main *bmain)
bool	BKE_main_needs_overwrite_confirm (const Main *bmain)
void	BKE_main_lock (Main *bmain)
void	BKE_main_unlock (Main *bmain)
void	BKE_main_relations_create (Main *bmain, short flag)
void	BKE_main_relations_free (Main *bmain)
void	BKE_main_relations_tag_set (Main *bmain, eMainIDRelationsEntryTags tag, bool value)
GSet *	BKE_main_gset_create (Main bmain, GSet gset)
MainLibraryWeakReferenceMap *	BKE_main_library_weak_reference_create (Main *bmain) ATTR_NONNULL()
void	BKE_main_library_weak_reference_destroy (MainLibraryWeakReferenceMap *library_weak_reference_mapping) ATTR_NONNULL()
ID *	BKE_main_library_weak_reference_search_item (MainLibraryWeakReferenceMap library_weak_reference_mapping, const char library_filepath, const char *library_id_name) ATTR_NONNULL()
void	BKE_main_library_weak_reference_add_item (MainLibraryWeakReferenceMap library_weak_reference_mapping, const char library_filepath, const char library_id_name, ID new_id) ATTR_NONNULL()
void	BKE_main_library_weak_reference_update_item (MainLibraryWeakReferenceMap library_weak_reference_mapping, const char library_filepath, const char library_id_name, ID old_id, ID *new_id) ATTR_NONNULL()
void	BKE_main_library_weak_reference_remove_item (MainLibraryWeakReferenceMap library_weak_reference_mapping, const char library_filepath, const char library_id_name, ID old_id) ATTR_NONNULL()
ID *	BKE_main_library_weak_reference_find (Main bmain, const char library_filepath, const char *library_id_name)
void	BKE_main_library_weak_reference_add (ID local_id, const char library_filepath, const char *library_id_name)
BlendThumbnail *	BKE_main_thumbnail_from_buffer (Main bmain, const uint8_t rect, const int size[2])
BlendThumbnail *	BKE_main_thumbnail_from_imbuf (Main bmain, ImBuf img)
ImBuf *	BKE_main_thumbnail_to_imbuf (Main bmain, BlendThumbnail data)
void	BKE_main_thumbnail_create (Main *bmain)
const char *	BKE_main_blendfile_path (const Main *bmain) ATTR_NONNULL()
const char *	BKE_main_blendfile_path_from_global ()
const char *	BKE_main_blendfile_path_from_library (const Library &library)
ListBase *	which_libbase (Main *bmain, short type)
MainListsArray	BKE_main_lists_get (Main &bmain)

Detailed Description

Main struct

Main is the root of the 'data-base' of a Blender context. All data is put into lists, and all these lists are stored here.

Note: A Blender file is not much more than a binary dump of these lists. This list of lists is not serialized itself.; BKE_main files are for operations over the Main database itself, or generating extra temp data to help working with it. Those should typically not affect the data-blocks themselves.

Names

BKE_main_ should be used for functions in that file.

Definition in file BKE_main.hh.

Macro Definition Documentation

◆ BLEN_THUMB_MEMSIZE

#define BLEN_THUMB_MEMSIZE	(		_x,
			_y )

Value:

(sizeof(BlendThumbnail) + ((size_t)(_x) * (size_t)(_y)) * sizeof(int))

BlendThumbnail

Definition BKE_main.hh:50

Definition at line 686 of file BKE_main.hh.

Referenced by BKE_main_thumbnail_create(), BKE_main_thumbnail_from_buffer(), BKE_main_thumbnail_from_imbuf(), blo_read_file_internal(), and BLO_thumbnail_from_file().

◆ BLEN_THUMB_MEMSIZE_IS_VALID

#define BLEN_THUMB_MEMSIZE_IS_VALID	(		_x,
			_y )

Value:

(((_x) > 0 && (_y) > 0) && ((uint64_t)(_x) * (uint64_t)(_y) < (SIZE_MAX / (sizeof(int) * 4))))

uint64_t

unsigned long long int uint64_t

Definition btConvexHullComputer.cpp:33

SIZE_MAX

#define SIZE_MAX

Protect against buffer overflow vulnerability & negative sizes.

Definition at line 689 of file BKE_main.hh.

Referenced by blo_read_file_internal(), BLO_thumbnail_from_file(), and read_file_thumbnail().

◆ BLEN_THUMB_SIZE

#define BLEN_THUMB_SIZE 128

The size of thumbnails (optionally) stored in the .blend files header.

NOTE(@ideasman42): This is kept small as it's stored uncompressed in the .blend file, where a larger size would increase the size of every .blend file unreasonably. If we wanted to increase the size, we'd want to use compression (JPEG or similar).

Definition at line 684 of file BKE_main.hh.

Referenced by BKE_main_thumbnail_create(), blend_file_thumb_from_camera(), and blend_file_thumb_from_screenshot().

◆ FOREACH_MAIN_ID_BEGIN

#define FOREACH_MAIN_ID_BEGIN	(		_bmain,
			_id )

Value:

{ \
  ListBase *_lb; \
  FOREACH_MAIN_LISTBASE_BEGIN ((_bmain), _lb) { \
    FOREACH_MAIN_LISTBASE_ID_BEGIN (_lb, (_id))

Top level foreach-like macro allowing to loop over all IDs in a given Main data-base.

NOTE: Order tries to go from 'user IDs' to 'used IDs' (e.g. collections will be processed before objects, which will be processed before obdata types, etc.).

WARNING: DO NOT use break statement with that macro, use #FOREACH_MAIN_LISTBASE and #FOREACH_MAIN_LISTBASE_ID instead if you need that kind of control flow.

Definition at line 577 of file BKE_main.hh.

◆ FOREACH_MAIN_ID_END

#define FOREACH_MAIN_ID_END

Value:

FOREACH_MAIN_LISTBASE_ID_END; \
} \
FOREACH_MAIN_LISTBASE_END; \
} \
((void)0)

Definition at line 583 of file BKE_main.hh.

◆ FOREACH_MAIN_LISTBASE_BEGIN

#define FOREACH_MAIN_LISTBASE_BEGIN	(		_bmain,
			_lb )

Value:

{ \
  MainListsArray _lbarray = BKE_main_lists_get(*(_bmain)); \
  size_t _i = _lbarray.size(); \
  while (_i--) { \
    (_lb) = _lbarray[_i];

Definition at line 557 of file BKE_main.hh.

Referenced by assert_sorted_ids(), BKE_blendfile_read_make_empty(), BKE_main_library_weak_reference_create(), blo_cache_storage_init(), blo_cache_storage_old_bmain_clear(), BLO_main_validate_shapekeys(), bpy_file_path_foreach(), bpy_file_path_map(), bpy_user_map(), lib_override_library_resync(), long_id_names_ensure_unique_id_names(), main_namemap_validate_and_fix(), rebuild_hierarchy_best_parent_find(), blender::animrig::internal::rebuild_slot_user_cache(), blender::animrig::Action::slot_identifier_propagate(), and sort_linked_ids().

◆ FOREACH_MAIN_LISTBASE_END

#define FOREACH_MAIN_LISTBASE_END

Value:

} \
} \
((void)0)

Definition at line 564 of file BKE_main.hh.

Referenced by assert_sorted_ids(), BKE_blendfile_read_make_empty(), BKE_main_library_weak_reference_create(), blo_cache_storage_init(), blo_cache_storage_old_bmain_clear(), BLO_main_validate_shapekeys(), bpy_file_path_foreach(), bpy_file_path_map(), bpy_user_map(), lib_override_library_resync(), long_id_names_ensure_unique_id_names(), main_namemap_validate_and_fix(), rebuild_hierarchy_best_parent_find(), blender::animrig::internal::rebuild_slot_user_cache(), blender::animrig::Action::slot_identifier_propagate(), and sort_linked_ids().

◆ FOREACH_MAIN_LISTBASE_ID_BEGIN

#define FOREACH_MAIN_LISTBASE_ID_BEGIN	(		_lb,
			_id )

Value:

{ \
  ID *_id_next = static_cast<ID *>((_lb)->first); \
  for ((_id) = _id_next; (_id) != nullptr; (_id) = _id_next) { \
    _id_next = static_cast<ID *>((_id)->next);

Definition at line 546 of file BKE_main.hh.

Referenced by blender::animrig::add_object_data_users(), BKE_blendfile_read_make_empty(), BKE_main_library_weak_reference_create(), blo_cache_storage_init(), blo_cache_storage_old_bmain_clear(), BLO_main_validate_shapekeys(), bpy_file_path_foreach(), bpy_file_path_map(), bpy_user_map(), blender::animrig::find_related_ids(), id_delete(), lib_override_library_resync(), lib_query_unused_ids_tag(), rebuild_hierarchy_best_parent_find(), blender::animrig::internal::rebuild_slot_user_cache(), reuse_editable_asset_bmain_data_for_blendfile(), blender::animrig::Action::slot_identifier_propagate(), swap_old_bmain_data_dependencies_process(), swap_old_bmain_data_for_blendfile(), and unpin_file_local_grease_pencil_brush_materials().

◆ FOREACH_MAIN_LISTBASE_ID_END

#define FOREACH_MAIN_LISTBASE_ID_END

◆ LIBRARY_VERSION_FILE_ATLEAST

#define LIBRARY_VERSION_FILE_ATLEAST	(	lib,
		ver,
		subver )

Value:

((lib)->runtime->versionfile == 0 || (lib)->runtime->versionfile > (ver) || \

((lib)->runtime->versionfile == (ver) && (lib)->runtime->subversionfile >= (subver)))

lib

static DynamicLibrary lib

Definition wayland_dynload_client.c:22

Definition at line 673 of file BKE_main.hh.

Referenced by blendfile_or_libraries_versions_atleast().

◆ MAIN_VERSION_FILE_ATLEAST

#define MAIN_VERSION_FILE_ATLEAST	(	main,
		ver,
		subver )

Value:

((main)->versionfile > (ver) || \

((main)->versionfile == (ver) && (main)->subversionfile >= (subver)))

main

#define main()

Definition gpu_shader_compat_cxx.hh:126

Definition at line 658 of file BKE_main.hh.

◆ MAIN_VERSION_FILE_OLDER

#define MAIN_VERSION_FILE_OLDER	(	main,
		ver,
		subver )

Value:

((main)->versionfile < (ver) || \

((main)->versionfile == (ver) && (main)->subversionfile < (subver)))

Definition at line 662 of file BKE_main.hh.

Referenced by blo_do_versions_260(), and blo_do_versions_290().

◆ MAIN_VERSION_FILE_OLDER_OR_EQUAL

#define MAIN_VERSION_FILE_OLDER_OR_EQUAL	(	main,
		ver,
		subver )

Value:

((main)->versionfile < (ver) || \

((main)->versionfile == (ver) && (main)->subversionfile <= (subver)))

Definition at line 666 of file BKE_main.hh.

Referenced by blo_split_main(), read_file_version_and_colorspace(), and read_global().

Typedef Documentation

◆ MainListsArray

using MainListsArray = std::array<ListBase *, INDEX_ID_MAX - 1>

Subtracting 1, because INDEX_ID_NULL is ignored here.

Definition at line 645 of file BKE_main.hh.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
MAINIDRELATIONS_INCLUDE_UI	Those bmain relations include pointers/usages from editors.

Definition at line 139 of file BKE_main.hh.

◆ eMainIDRelationsEntryTags

enum eMainIDRelationsEntryTags

MainIDRelationsEntry.tags

Enumerator
MAINIDRELATIONS_ENTRY_TAGS_DOIT	Generic tag marking the entry as to be processed.
MAINIDRELATIONS_ENTRY_TAGS_PROCESSED_TO	Generic tag marking the entry as processed in the to direction (i.e. the IDs used by this item have been processed).
MAINIDRELATIONS_ENTRY_TAGS_PROCESSED_FROM	Generic tag marking the entry as processed in the from direction (i.e. the IDs using this item have been processed).
MAINIDRELATIONS_ENTRY_TAGS_PROCESSED	Generic tag marking the entry as processed.
MAINIDRELATIONS_ENTRY_TAGS_INPROGRESS_TO	Generic tag marking the entry as being processed in the to direction (i.e. the IDs used by this item are being processed). Useful for dependency loops detection and handling.
MAINIDRELATIONS_ENTRY_TAGS_INPROGRESS_FROM	Generic tag marking the entry as being processed in the from direction (i.e. the IDs using this item are being processed). Useful for dependency loops detection and handling.
MAINIDRELATIONS_ENTRY_TAGS_INPROGRESS	Generic tag marking the entry as being processed. Useful for dependency loops detection and handling.

Definition at line 87 of file BKE_main.hh.

Function Documentation

◆ BKE_main_blendfile_path()

const char * BKE_main_blendfile_path ( const Main * bmain )

Return file-path of given main.

Definition at line 887 of file main.cc.

References Main::filepath.

Referenced by blender::ed::object::bake_targets_output_external(), BKE_blendfile_read_from_memfile(), BKE_bpath_missing_files_find(), BKE_image_save_options_init(), BKE_library_filepath_set(), BKE_main_blendfile_path_from_global(), BKE_main_library_weak_reference_find(), BKE_memfile_undo_decode(), BKE_movieclip_file_add(), BKE_movieclip_file_add_exists_ex(), BKE_packedfile_pack_all(), BKE_packedfile_pack_all_libraries(), BKE_packedfile_unpack(), BKE_packedfile_unpack_all_libraries(), BKE_scene_set_name(), BKE_sound_new_file(), BKE_sound_new_file_exists_ex(), BKE_vfont_load(), BKE_vfont_load_exists_ex(), BLO_memfile_main_get(), block_create__close_file_dialog(), block_create_save_file_overwrite_dialog(), bookmark_select_exec(), bpy_lib_load(), BPY_modules_load_user(), blender::io::hydra::cache_or_get_image_file(), cachefile_layer_open_invoke(), cachefile_open_invoke(), blender::ed::object::collection_exporter_export(), do_write_image_or_movie(), blender::nodes::draw_common_bake_settings(), blender::ed::vse::draw_strip_in_view(), ED_fileselect_ensure_default_filepath(), file_browse_exec(), file_execute(), file_expand_directory(), file_filename_enter_handle(), file_operator_to_sfile(), file_parent_exec(), file_select_do(), file_sfile_to_operator_ex(), filelist_contains_main(), filelist_readjob_start_ex(), blender::bke::bake::get_blend_file_name(), image_abs_path(), image_file_browse_exec(), image_file_browse_invoke(), image_open_exec(), image_save_options_from_op(), library_link_begin(), library_link_end(), blender::ed::vse::load_data_init_from_operator(), blender::io::obj::load_image_at_path(), make_paths_absolute_exec(), make_paths_relative_exec(), blender::ed::object::multires_external_save_exec(), blender::ed::outliner::namebutton_fn(), blender::bke::blendfile::PartialWriteContext::PartialWriteContext(), blender::ed::space_node::preview_prepare_scene(), preview_prepare_scene(), RE_RenderAnim(), RE_RenderFrame(), save_set_filepath(), screen_opengl_render_anim_step(), screen_opengl_render_write(), blender::ed::vse::sequencer_add_image_strip_exec(), blender::ed::vse::sequencer_change_path_exec(), sound_mixdown_exec(), blender::seq::strip_doversion_250_sound_proxy_update_cb(), text_jump_to_file_at_point_exec(), text_jump_to_file_at_point_internal(), text_open_exec(), text_open_invoke(), text_save_as_invoke(), txt_write_file(), blender::bke::bake::unpack_geometry_nodes_bake(), unpack_menu(), blender::ed::object::volume_import_exec(), wm_autosave_location(), wm_block_file_close_save(), wm_file_link_append_datablock_ex(), wm_id_linked_relocate_exec(), wm_lib_relocate_exec_do(), wm_link_append_exec(), wm_open_mainfile__select_file_path_exec(), WM_operator_drop_load_path(), wm_revert_mainfile_exec(), wm_save_as_mainfile_exec(), workspace_append_activate_exec(), and write_result().

◆ BKE_main_blendfile_path_from_global()

const char * BKE_main_blendfile_path_from_global ( )

Return file-path of global main G_MAIN.

Warning: Usage is not recommended, you should always try to get a valid Main pointer from context.

Definition at line 892 of file main.cc.

References BKE_main_blendfile_path(), and G_MAIN.

Referenced by BKE_add_template_variables_general(), BKE_modifier_path_init(), BKE_ptcache_toggle_disk_cache(), block_create_autorun_warning(), bpy_lib_write(), blender::nodes::node_composite_file_output_cc::compute_image_path(), dynamicPaint_outputSurfaceImage(), filelist_setdir(), fileselect_ensure_updated_file_params(), fileselect_initialize_params_common(), get_proxy_filepath(), blender::io::usd::import_asset(), blender::io::usd::import_startjob(), library_link_end(), movieclip_open_anim_file(), paste_material_exec(), blender::ed::io::paths_from_operator_properties(), pose_paste_exec(), blender::seq::proxy_dir_get(), ptcache_file_open(), ptcache_filepath(), ptcache_path(), blender::io::grease_pencil::SVGImporter::read(), blender::io::usd::USDVolumeReader::read_object_data(), render_result_exr_file_cache_path(), save_set_compress(), screenshot_exec(), screenshot_invoke(), blender::seq::seq_proxy_get_custom_file_filepath(), blender::seq::seq_proxy_get_filepath(), stampdata(), wm_history_file_update(), WM_init(), wm_init_splash_show_on_startup_check(), wm_link_append_invoke(), wm_revert_mainfile_poll(), wm_save_mainfile_invoke(), WM_window_title(), and write_crash_blend().

◆ BKE_main_blendfile_path_from_library()

const char * BKE_main_blendfile_path_from_library ( const Library & library )

Return the absolute file-path of a library.

Definition at line 897 of file main.cc.

◆ BKE_main_clear()

void BKE_main_clear ( Main & bmain )

Make given bmain empty again, and free all runtime mappings.

This is similar to deleting and re-creating the Main, however the internal Main::lock is kept unchanged, and the Main::is_global_main flag is not reset to true either.

Note: Unlike BKE_main_free, only process the given bmain, without handling any potential other linked Main.

Definition at line 96 of file main.cc.

References BKE_id_free_ex(), BKE_main_idmap_destroy(), BKE_main_lists_get(), BKE_main_namemap_destroy(), BKE_main_relations_free(), Main::blen_thumb, BLI_assert_unreachable, BLI_listbase_clear(), ListBase::first, Main::id_map, INDEX_ID_AC, INDEX_ID_AR, INDEX_ID_BR, INDEX_ID_CA, INDEX_ID_CF, INDEX_ID_CU_LEGACY, INDEX_ID_CV, INDEX_ID_GD_LEGACY, INDEX_ID_GR, INDEX_ID_IM, INDEX_ID_KE, INDEX_ID_LA, INDEX_ID_LI, INDEX_ID_LP, INDEX_ID_LS, INDEX_ID_LT, INDEX_ID_MA, INDEX_ID_MB, INDEX_ID_MC, INDEX_ID_ME, INDEX_ID_MSK, INDEX_ID_NT, INDEX_ID_NULL, INDEX_ID_OB, INDEX_ID_PA, INDEX_ID_PAL, INDEX_ID_PC, INDEX_ID_PT, INDEX_ID_SCE, INDEX_ID_SCR, INDEX_ID_SO, INDEX_ID_SPK, INDEX_ID_TE, INDEX_ID_TXT, INDEX_ID_VF, INDEX_ID_VO, INDEX_ID_WM, INDEX_ID_WO, INDEX_ID_WS, LIB_ID_FREE_NO_DEG_TAG, LIB_ID_FREE_NO_MAIN, LIB_ID_FREE_NO_UI_USER, LIB_ID_FREE_NO_USER_REFCOUNT, MEM_SAFE_FREE, Main::name_map, Main::name_map_global, and Main::relations.

Referenced by blender::bke::blendfile::PartialWriteContext::clear(), and Main::~Main().

◆ BKE_main_free()

void BKE_main_free ( Main * bmain )

Completely destroy the given bmain, and all its linked 'libraries' ones if any (all other bmains, following the #Main.next chained list).

Definition at line 192 of file main.cc.

◆ BKE_main_gset_create()

GSet * BKE_main_gset_create	(	Main *	bmain,
		GSet *	gset )

Create a GSet storing all IDs present in given bmain, by their pointers.

Parameters

gset	If not NULL, given GSet will be extended with IDs from given bmain, instead of creating a new one.

Definition at line 623 of file main.cc.

References BLI_ghashutil_ptrcmp(), BLI_ghashutil_ptrhash(), BLI_gset_add(), BLI_gset_new(), FOREACH_MAIN_ID_BEGIN, and FOREACH_MAIN_ID_END.

Referenced by BKE_main_idmap_create().

◆ BKE_main_has_issues()

bool BKE_main_has_issues ( const Main * bmain )

Check whether the bmain has issues, e.g. for reporting in the status bar.

Definition at line 474 of file main.cc.

References Main::colorspace, Main::has_forward_compatibility_issues, Main::is_asset_edit_file, and MainColorspace::is_missing_opencolorio_config.

Referenced by uiTemplateStatusInfo().

◆ BKE_main_is_empty()

bool BKE_main_is_empty ( Main * bmain )

Check whether given bmain is empty or contains some IDs.

Definition at line 462 of file main.cc.

References FOREACH_MAIN_ID_BEGIN, FOREACH_MAIN_ID_END, and result.

Referenced by library_link_end(), and read_libblock_undo_restore_at_old_address().

◆ BKE_main_library_weak_reference_add()

void BKE_main_library_weak_reference_add	(	ID *	local_id,
		const char *	library_filepath,
		const char *	library_id_name )

Add library weak reference to ID, referencing the specified library and ID name. For cases where creating a full MainLibraryWeakReferenceMap is unnecessary.

Definition at line 803 of file main.cc.

References LibraryWeakReference::library_filepath, LibraryWeakReference::library_id_name, ID::library_weak_reference, MEM_callocN(), and STRNCPY().

Referenced by blender::bke::asset_edit_id_ensure_local(), BKE_main_library_weak_reference_add_item(), and BLO_update_defaults_startup_blend().

◆ BKE_main_library_weak_reference_add_item()

void BKE_main_library_weak_reference_add_item	(	MainLibraryWeakReferenceMap *	library_weak_reference_mapping,
		const char *	library_filepath,
		const char *	library_id_name,
		ID *	new_id )

Add the given ID weak library reference to given local ID and the runtime mapping.

Parameters

library_weak_reference_mapping	the mapping data generated by BKE_main_library_weak_reference_create.
library_filepath	the path of a blend file library (relative to current working one).
library_id_name	the full ID name, including the leading two chars encoding the ID type.
new_id	New local ID matching given weak reference.

Definition at line 709 of file main.cc.

References Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add(), BKE_idtype_idcode_append_is_reusable(), BKE_main_library_weak_reference_add(), BLI_assert, GS, ID::library_weak_reference, MainLibraryWeakReferenceMap::map, and ID::name.

Referenced by BKE_blendfile_append().

◆ BKE_main_library_weak_reference_create()

MainLibraryWeakReferenceMap * BKE_main_library_weak_reference_create ( Main * bmain )

Generate a mapping between 'library path' of an ID (as a pair (relative blend file path, id name)), and a current local ID, if any.

This uses the information stored in ID.library_weak_reference.

Definition at line 664 of file main.cc.

References BKE_idtype_idcode_append_is_reusable(), BKE_idtype_idcode_is_linkable(), BLI_assert, ListBase::first, FOREACH_MAIN_LISTBASE_BEGIN, FOREACH_MAIN_LISTBASE_END, FOREACH_MAIN_LISTBASE_ID_BEGIN, FOREACH_MAIN_LISTBASE_ID_END, GS, LibraryWeakReference::library_filepath, LibraryWeakReference::library_id_name, ID::library_weak_reference, and ID::name.

Referenced by BKE_blendfile_append().

◆ BKE_main_library_weak_reference_destroy()

void BKE_main_library_weak_reference_destroy ( MainLibraryWeakReferenceMap * library_weak_reference_mapping )

Destroy the data generated by BKE_main_library_weak_reference_create.

Definition at line 694 of file main.cc.

Referenced by BKE_blendfile_append().

◆ BKE_main_library_weak_reference_find()

ID * BKE_main_library_weak_reference_find	(	Main *	bmain,
		const char *	library_filepath,
		const char *	library_id_name )

Find local ID with weak library reference matching library and ID name. For cases where creating a full MainLibraryWeakReferenceMap is unnecessary.

Definition at line 772 of file main.cc.

References BKE_main_blendfile_path(), BLI_path_abs(), FILE_MAX, GS, LISTBASE_FOREACH, STREQ, STRNCPY(), and which_libbase().

Referenced by blender::bke::asset_edit_id_find_local().

◆ BKE_main_library_weak_reference_remove_item()

void BKE_main_library_weak_reference_remove_item	(	MainLibraryWeakReferenceMap *	library_weak_reference_mapping,
		const char *	library_filepath,
		const char *	library_id_name,
		ID *	old_id )

Remove the given ID weak library reference from the given local ID and the runtime mapping.

Parameters

library_weak_reference_mapping	the mapping data generated by BKE_main_library_weak_reference_create.
library_filepath	the path of a blend file library (relative to current working one).
library_id_name	the full ID name, including the leading two chars encoding the ID type.
old_id	Existing local ID matching given weak reference.

Definition at line 755 of file main.cc.

References BLI_assert, GS, ID::library_weak_reference, Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup(), MainLibraryWeakReferenceMap::map, MEM_SAFE_FREE, ID::name, and Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::remove().

Referenced by blendfile_append_define_actions(), and foreach_libblock_append_ensure_reusable_local_id_callback().

◆ BKE_main_library_weak_reference_search_item()

ID * BKE_main_library_weak_reference_search_item	(	MainLibraryWeakReferenceMap *	library_weak_reference_mapping,
		const char *	library_filepath,
		const char *	library_id_name )

Search for a local ID matching the given linked ID reference.

Parameters

library_weak_reference_mapping	the mapping data generated by BKE_main_library_weak_reference_create.
library_filepath	the path of a blend file library (relative to current working one).
library_id_name	the full ID name, including the leading two chars encoding the ID type.

Definition at line 700 of file main.cc.

References Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_default(), and MainLibraryWeakReferenceMap::map.

Referenced by blendfile_append_define_actions().

◆ BKE_main_library_weak_reference_update_item()

void BKE_main_library_weak_reference_update_item	(	MainLibraryWeakReferenceMap *	library_weak_reference_mapping,
		const char *	library_filepath,
		const char *	library_id_name,
		ID *	old_id,
		ID *	new_id )

Update the status of the given ID weak library reference in current local IDs and the runtime mapping.

This effectively transfers the 'ownership' of the given weak reference from old_id to new_id.

Parameters

library_weak_reference_mapping	the mapping data generated by BKE_main_library_weak_reference_create.
library_filepath	the path of a blend file library (relative to current working one).
library_id_name	the full ID name, including the leading two chars encoding the ID type.
old_id	Existing local ID matching given weak reference.
new_id	New local ID matching given weak reference.

Definition at line 733 of file main.cc.

References Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add_overwrite(), BLI_assert, GS, LibraryWeakReference::library_filepath, LibraryWeakReference::library_id_name, ID::library_weak_reference, Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup(), MainLibraryWeakReferenceMap::map, ID::name, and STREQ.

◆ BKE_main_lists_get()

MainListsArray BKE_main_lists_get ( Main & bmain )

Returns the pointers to all the ListBase structs in given bmain.

This is useful for generic traversal of all the blocks in a Main (by traversing all the lists in turn), without worrying about block types.

Note: The order of each ID type ListBase in the array is determined by the INDEX_ID_<IDTYPE> enum definitions in DNA_ID.h. See also the FOREACH_MAIN_ID_BEGIN macro in BKE_main.hh

Definition at line 987 of file main.cc.

References Main::actions, Main::armatures, Main::brushes, Main::cachefiles, Main::cameras, Main::collections, Main::curves, Main::fonts, Main::gpencils, Main::grease_pencils, Main::hair_curves, Main::images, INDEX_ID_AC, INDEX_ID_AR, INDEX_ID_BR, INDEX_ID_CA, INDEX_ID_CF, INDEX_ID_CU_LEGACY, INDEX_ID_CV, INDEX_ID_GD_LEGACY, INDEX_ID_GP, INDEX_ID_GR, INDEX_ID_IM, INDEX_ID_KE, INDEX_ID_LA, INDEX_ID_LI, INDEX_ID_LP, INDEX_ID_LS, INDEX_ID_LT, INDEX_ID_MA, INDEX_ID_MB, INDEX_ID_MC, INDEX_ID_ME, INDEX_ID_MSK, INDEX_ID_NT, INDEX_ID_OB, INDEX_ID_PA, INDEX_ID_PAL, INDEX_ID_PC, INDEX_ID_PT, INDEX_ID_SCE, INDEX_ID_SCR, INDEX_ID_SO, INDEX_ID_SPK, INDEX_ID_TE, INDEX_ID_TXT, INDEX_ID_VF, INDEX_ID_VO, INDEX_ID_WM, INDEX_ID_WO, INDEX_ID_WS, Main::lattices, Main::libraries, Main::lightprobes, Main::lights, Main::linestyles, Main::masks, Main::materials, Main::meshes, Main::metaballs, Main::movieclips, Main::nodetrees, Main::objects, Main::paintcurves, Main::palettes, Main::particles, Main::pointclouds, Main::scenes, Main::screens, Main::shapekeys, Main::sounds, Main::speakers, Main::texts, Main::textures, Main::volumes, Main::wm, Main::workspaces, and Main::worlds.

Referenced by add_main_to_main(), BKE_blendfile_library_relocate(), BKE_library_ID_test_usages(), BKE_library_indirectly_used_data_tag_clear(), BKE_library_make_local(), BKE_main_clear(), BKE_main_id_flag_all(), BKE_main_id_tag_all(), blo_do_versions_270(), BLO_main_validate_libraries(), blo_read_file_internal(), blo_split_main(), blender::ed::outliner::TreeDisplayIDOrphans::build_tree(), has_linked_ids_to_read(), id_delete(), library_ID_is_used(), read_library_clear_weak_links(), read_library_linked_ids(), read_undo_reuse_noundo_local_ids(), and split_main_newid().

◆ BKE_main_lock()

void BKE_main_lock ( Main * bmain )

Definition at line 486 of file main.cc.

References BLI_spin_lock(), and Main::lock.

Referenced by BKE_blendfile_id_relocate(), BKE_blendfile_library_relocate(), BKE_libblock_alloc_in_lib(), BKE_libblock_management_main_add(), BKE_libblock_management_main_remove(), BKE_libblock_remap(), BKE_libblock_remap_multiple(), BKE_libblock_unlink(), BKE_objects_materials_sync_length_all(), BLO_main_validate_libraries(), BLO_main_validate_shapekeys(), filelist_readjob_main_assets_add_items(), id_delete(), id_free(), and libblock_remap_foreach_idpair().

◆ BKE_main_merge()

void BKE_main_merge	(	Main *	bmain_dst,
		Main **	r_bmain_src,
		MainMergeReport &	reports )

Merge the content of bmain_src into bmain_dst.

In case of collision (ID from same library with same name), the existing ID in bmain_dst is kept, the one from bmain_src is left in its original Main, and its usages in bmain_dst (from newly moved-in IDs) are remapped to its matching counterpart already in bmain_dst.

Libraries are also de-duplicated, based on their absolute filepath, and remapped accordingly. Note that local IDs in source Main always remain local IDs in destination Main.

In case some source IDs are linked data from the blendfile of bmain_dst, they are never moved. If a matching destination local ID is found, their usage get remapped as expected, otherwise they are dropped, their usages are remapped to null, and a warning is printed.

Since bmain_src is either empty or contains left-over IDs with (likely) invalid ID relationships and other potential issues after the merge, it is always freed.

Definition at line 326 of file main.cc.

References blender::bke::id::IDRemapper::add(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add(), are_ids_from_different_mains_matching(), BKE_bpath_absolute_convert(), BKE_bpath_relative_rebase(), BKE_libblock_management_main_add(), BKE_libblock_management_main_remove(), BKE_libblock_relink_multiple(), BKE_main_free(), BKE_main_namemap_clear(), BKE_main_namemap_validate(), BKE_reportf(), BLI_assert, BLI_path_normalize_native(), BLI_path_split_dir_part(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::contains(), FILE_MAXDIR, Main::filepath, FOREACH_MAIN_ID_BEGIN, FOREACH_MAIN_ID_END, GS, ID_LI, ID_REMAP_DO_LIBRARY_POINTERS, ID_REMAP_TYPE_REMAP, blender::Vector< T, InlineBufferCapacity, Allocator >::is_empty(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_default(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_or_add(), main_merge_add_id_to_move(), ID::name, MainMergeReport::num_merged_ids, MainMergeReport::num_remapped_ids, MainMergeReport::num_remapped_libraries, MainMergeReport::num_unknown_ids, MainMergeReport::reports, RPT_INFO, Library::runtime, and blender::Vector< T, InlineBufferCapacity, Allocator >::size().