BKE_main.h File Reference

#include "DNA_listBase.h"
#include "BLI_compiler_attrs.h"
#include "BLI_sys_types.h"

Go to the source code of this file.

Classes
struct	BlendThumbnail
struct	MainIDRelationsEntryItem
struct	MainIDRelationsEntry
struct	MainIDRelations
struct	Main

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_ATLEAST(main, ver, subver)
#define	MAIN_VERSION_OLDER(main, ver, subver)
#define	BLEN_THUMB_SIZE   128
#define	BLEN_THUMB_MEMSIZE(_x, _y)    (sizeof(BlendThumbnail) + ((size_t)(_x) * (size_t)(_y)) * sizeof(int))
#define	BLEN_THUMB_MEMSIZE_IS_VALID(_x, _y)    (((_x) > 0 && (_y) > 0) && ((uint64_t)(_x) * (uint64_t)(_y) < (SIZE_MAX / (sizeof(int) * 4))))

Typedefs
typedef struct BlendThumbnail	BlendThumbnail
typedef struct MainIDRelationsEntryItem	MainIDRelationsEntryItem
typedef struct MainIDRelationsEntry	MainIDRelationsEntry
typedef enum MainIDRelationsEntryTags	MainIDRelationsEntryTags
typedef struct MainIDRelations	MainIDRelations
typedef struct Main	Main

Enumerations
enum	MainIDRelationsEntryTags { MAINIDRELATIONS_ENTRY_TAGS_DOIT = 1 << 0 , MAINIDRELATIONS_ENTRY_TAGS_PROCESSED = 1 << 1 }
enum	{ MAINIDRELATIONS_INCLUDE_UI = 1 << 0 }

Functions
struct Main *	BKE_main_new (void)
void	BKE_main_free (struct Main *mainvar)
void	BKE_main_lock (struct Main *bmain)
void	BKE_main_unlock (struct Main *bmain)
void	BKE_main_relations_create (struct Main *bmain, const short flag)
void	BKE_main_relations_free (struct Main *bmain)
void	BKE_main_relations_tag_set (struct Main *bmain, const MainIDRelationsEntryTags tag, const bool value)
struct GSet *	BKE_main_gset_create (struct Main *bmain, struct GSet *gset)
struct BlendThumbnail *	BKE_main_thumbnail_from_imbuf (struct Main *bmain, struct ImBuf *img)
struct ImBuf *	BKE_main_thumbnail_to_imbuf (struct Main *bmain, struct BlendThumbnail *data)
void	BKE_main_thumbnail_create (struct Main *bmain)
const char *	BKE_main_blendfile_path (const struct Main *bmain) ATTR_NONNULL()
const char *	BKE_main_blendfile_path_from_global (void)
struct ListBase *	which_libbase (struct Main *bmain, short type)
int	set_listbasepointers (struct Main *main, struct ListBase *lb[])

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.h.

Macro Definition Documentation

BLEN_THUMB_MEMSIZE

#define BLEN_THUMB_MEMSIZE	(		_x,
			_y
	)		(sizeof(BlendThumbnail) + ((size_t)(_x) * (size_t)(_y)) * sizeof(int))

Definition at line 279 of file BKE_main.h.

BLEN_THUMB_MEMSIZE_IS_VALID

#define BLEN_THUMB_MEMSIZE_IS_VALID	(		_x,
			_y
	)		(((_x) > 0 && (_y) > 0) && ((uint64_t)(_x) * (uint64_t)(_y) < (SIZE_MAX / (sizeof(int) * 4))))

Protect against buffer overflow vulnerability & negative sizes.

Definition at line 282 of file BKE_main.h.

BLEN_THUMB_SIZE

#define BLEN_THUMB_SIZE   128

Definition at line 277 of file BKE_main.h.

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 244 of file BKE_main.h.

FOREACH_MAIN_ID_END

#define FOREACH_MAIN_ID_END

Value:

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

Definition at line 250 of file BKE_main.h.

FOREACH_MAIN_LISTBASE_BEGIN

#define FOREACH_MAIN_LISTBASE_BEGIN	(		_bmain,
			_lb
	)

Value:

  { \
    ListBase *_lbarray[INDEX_ID_MAX]; \
    int _i = set_listbasepointers((_bmain), _lbarray); \
    while (_i--) { \
      (_lb) = _lbarray[_i];

Definition at line 224 of file BKE_main.h.

FOREACH_MAIN_LISTBASE_END

#define FOREACH_MAIN_LISTBASE_END

Value:

  } \
  } \
  ((void)0)

Definition at line 231 of file BKE_main.h.

FOREACH_MAIN_LISTBASE_ID_BEGIN

#define FOREACH_MAIN_LISTBASE_ID_BEGIN	(		_lb,
			_id
	)

Value:

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

Definition at line 213 of file BKE_main.h.

FOREACH_MAIN_LISTBASE_ID_END

#define FOREACH_MAIN_LISTBASE_ID_END

Value:

  } \
  } \
  ((void)0)

Definition at line 219 of file BKE_main.h.

MAIN_VERSION_ATLEAST

#define MAIN_VERSION_ATLEAST	(		main,
			ver,
			subver
	)

Value:

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

Definition at line 269 of file BKE_main.h.

MAIN_VERSION_OLDER

#define MAIN_VERSION_OLDER	(		main,
			ver,
			subver
	)

Value:

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

Definition at line 273 of file BKE_main.h.

Typedef Documentation

BlendThumbnail

typedef struct BlendThumbnail BlendThumbnail

Main

typedef struct Main Main

MainIDRelations

typedef struct MainIDRelations MainIDRelations

MainIDRelationsEntry

typedef struct MainIDRelationsEntry MainIDRelationsEntry

MainIDRelationsEntryItem

typedef struct MainIDRelationsEntryItem MainIDRelationsEntryItem

MainIDRelationsEntryTags

typedef enum MainIDRelationsEntryTags MainIDRelationsEntryTags

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
MAINIDRELATIONS_INCLUDE_UI

Definition at line 111 of file BKE_main.h.

MainIDRelationsEntryTags

enum MainIDRelationsEntryTags

Enumerator
MAINIDRELATIONS_ENTRY_TAGS_DOIT
MAINIDRELATIONS_ENTRY_TAGS_PROCESSED

Definition at line 92 of file BKE_main.h.

Function Documentation

BKE_main_blendfile_path()

const char* BKE_main_blendfile_path

(

const struct Main *

bmain

)

Referenced by blender::io::alembic::ArchiveReader::ArchiveReader(), bake_targets_output_external(), BKE_blendfile_read_from_memfile(), BKE_bpath_missing_files_find(), BKE_image_load(), BKE_library_filepath_set(), 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_all_libraries(), BKE_packedfile_unpack_image(), BKE_packedfile_unpack_sound(), BKE_packedfile_unpack_vfont(), BKE_packedfile_unpack_volume(), BKE_scene_set_name(), BKE_sound_new_file(), BKE_sound_new_file_exists_ex(), BKE_vfont_load(), BKE_vfont_load_exists_ex(), blf_dir_search(), blo_do_versions_250(), BLO_memfile_main_get(), block_create__close_file_dialog(), bookmark_select_exec(), bpy_lib_load(), BPY_modules_load_user(), cachefile_open_invoke(), detect_clip_source(), do_write_image_or_movie(), ED_image_filesel_detect_sequences(), file_browse_exec(), file_directory_enter_handle(), file_exec(), file_expand_directory(), file_filename_enter_handle(), file_operator_to_sfile(), file_parent_exec(), file_select_do(), file_sfile_to_operator_ex(), filelist_readjob_start(), blender::io::gpencil::GpencilIO::filename_set(), image_open_exec(), image_save_options_from_op(), image_save_options_init(), image_save_sequence_exec(), lib_id_library_local_paths(), library_link_begin(), library_link_end(), load_data_init_from_operator(), make_paths_absolute_exec(), make_paths_relative_exec(), multires_external_save_exec(), namebutton_fn(), preview_prepare_scene(), RE_RenderAnim(), RE_RenderFrame(), read_global(), save_set_filepath(), screen_opengl_render_anim_step(), screen_opengl_render_write(), SEQ_add_image_strip(), SEQ_add_movie_strip(), seq_disk_cache_get_project_dir(), sequencer_change_path_exec(), sequencer_export_subtitles_invoke(), sequencer_generic_invoke_path__internal(), sound_mixdown_exec(), text_open_exec(), text_open_invoke(), text_save_as_invoke(), txt_write_file(), unpack_menu(), volume_import_exec(), wm_block_file_close_save(), WM_file_read(), wm_file_write(), wm_lib_relocate_exec_do(), wm_link_append_exec(), wm_open_mainfile__select_file_path(), WM_operator_drop_load_path(), wm_revert_mainfile_exec(), wm_save_as_mainfile_exec(), and write_result_func().

BKE_main_blendfile_path_from_global()

const char* BKE_main_blendfile_path_from_global

(

void

)

Return filepath 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 439 of file main.c.

References BKE_main_blendfile_path(), and G_MAIN.

Referenced by bpy_lib_write(), blender::compositor::OutputOpenExrSingleLayerMultiViewOperation::deinitExecution(), blender::compositor::OutputOpenExrMultiLayerMultiViewOperation::deinitExecution(), blender::compositor::OutputStereoOperation::deinitExecution(), blender::compositor::OutputSingleLayerOperation::deinitExecution(), blender::compositor::OutputOpenExrMultiLayerOperation::deinitExecution(), dynamicPaint_outputSurfaceImage(), filelist_setdir(), fileselect_ensure_updated_file_params(), fileselect_initialize_params_common(), get_proxy_fname(), icon_preview_imbuf_from_brush(), library_link_end(), movieclip_open_anim_file(), pose_copy_exec(), pose_paste_exec(), ptcache_path(), render_result_exr_file_cache_path(), render_result_exr_file_path(), screenshot_exec(), screenshot_invoke(), SEQ_add_image_init_alpha_mode(), SEQ_add_reload_new_file(), seq_open_anim_file(), seq_proxy_get_custom_file_fname(), seq_proxy_get_fname(), seq_proxy_multiview_context_invalid(), seq_render_image_strip(), stampdata(), wm_autosave_location(), wm_history_file_update(), WM_init(), wm_link_append_invoke(), wm_window_title(), and write_crash_blend().

BKE_main_free()

void BKE_main_free

(

struct Main *

mainvar

)

Definition at line 53 of file main.c.

References Freestyle::a, BKE_id_free_ex(), BKE_main_relations_free(), Main::blen_thumb, BLI_assert_unreachable, BLI_listbase_clear(), BLI_spin_end(), ListBase::first, id, INDEX_ID_MAX, LIB_ID_FREE_NO_DEG_TAG, LIB_ID_FREE_NO_MAIN, LIB_ID_FREE_NO_UI_USER, LIB_ID_FREE_NO_USER_REFCOUNT, Main::lock, MEM_freeN, MEM_SAFE_FREE, ID::next, NULL, Main::relations, and set_listbasepointers().

Referenced by BKE_blender_free(), BKE_blender_globals_clear(), BKE_blendfile_userdef_read(), BKE_blendfile_userdef_read_from_memory(), BKE_blendfile_workspace_config_data_free(), BKE_lib_override_library_operations_store_finalize(), BLO_blendfiledata_free(), blo_join_main(), BLO_library_temp_free(), bpy_rna_data_context_exit(), ED_preview_free_dbase(), library_link_end(), object_preview_render(), pose_copy_exec(), pose_paste_exec(), read_libraries(), render_endjob(), seq_prefetch_free(), blender::io::alembic::AlembicExportTest::TearDown(), and Freestyle::BlenderStrokeRenderer::~BlenderStrokeRenderer().

BKE_main_gset_create()

struct 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 342 of file main.c.

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

Referenced by BKE_main_idmap_create().

BKE_main_lock()

void BKE_main_lock

(

struct Main *

bmain

)

Definition at line 202 of file main.c.

References BLI_spin_lock(), and Main::lock.

Referenced by BKE_id_free_ex(), BKE_libblock_alloc(), BKE_libblock_management_main_add(), BKE_libblock_management_main_remove(), BKE_libblock_remap(), BKE_libblock_remap_locked(), BKE_libblock_unlink(), BKE_objects_materials_test_all(), BLO_main_validate_libraries(), BLO_main_validate_shapekeys(), id_delete(), and lib_relocate_do().

BKE_main_new()

struct Main* BKE_main_new

(

void

)

Definition at line 45 of file main.c.

References BLI_spin_init(), Main::lock, MEM_callocN, and MEM_mallocN.

Referenced by BKE_blender_globals_init(), BKE_lib_override_library_operations_store_init(), Freestyle::BlenderStrokeRenderer::BlenderStrokeRenderer(), blo_find_main(), BLO_library_temp_load_id(), blo_read_file_internal(), blo_split_main(), bpy_rna_data_context_enter(), direct_link_library(), library_link_end(), object_preview_render(), pose_copy_exec(), pose_paste_exec(), read_libraries(), seq_prefetch_start_ex(), and blender::io::alembic::AlembicExportTest::SetUp().

BKE_main_relations_create()

void BKE_main_relations_create	(	Main *	bmain,
		const short	flag
	)

Generate the mappings between used IDs and their users, and vice-versa.

Definition at line 265 of file main.c.

References BKE_library_foreach_ID_link(), BKE_main_relations_free(), BLI_assert, BLI_ghash_ensure_p(), BLI_ghash_new(), BLI_ghashutil_ptrcmp(), BLI_ghashutil_ptrhash(), BLI_mempool_create(), BLI_MEMPOOL_NOP, MainIDRelations::entry_items_pool, MainIDRelations::flag, FOREACH_MAIN_ID_BEGIN, FOREACH_MAIN_ID_END, id, IDWALK_INCLUDE_UI, IDWALK_READONLY, main_relations_create_idlink_cb(), MAINIDRELATIONS_INCLUDE_UI, MEM_callocN, MEM_mallocN, NULL, Main::relations, MainIDRelations::relations_from_pointers, and ID::session_uuid.

Referenced by BKE_lib_override_library_delete(), BKE_lib_override_library_id_hierarchy_reset(), BKE_lib_override_library_main_resync(), BKE_lib_override_library_resync(), BKE_lib_query_unused_ids_tag(), BKE_library_make_local(), and lib_override_library_create_do().

BKE_main_relations_free()

void BKE_main_relations_free

(

struct Main *

bmain

)

Definition at line 300 of file main.c.

References BLI_ghash_free(), BLI_mempool_destroy(), MainIDRelations::entry_items_pool, MEM_freeN, NULL, Main::relations, and MainIDRelations::relations_from_pointers.

Referenced by BKE_lib_override_library_delete(), BKE_lib_override_library_id_hierarchy_reset(), BKE_lib_override_library_main_resync(), BKE_lib_override_library_resync(), BKE_lib_query_unused_ids_tag(), BKE_library_make_local(), BKE_main_free(), BKE_main_relations_create(), and lib_override_library_create_do().

BKE_main_relations_tag_set()

void BKE_main_relations_tag_set	(	struct Main *	bmain,
		const MainIDRelationsEntryTags	tag,
		const bool	value
	)

Set or clear given tag in all relation entries of given bmain.

Definition at line 313 of file main.c.

References BLI_ghashIterator_done(), BLI_ghashIterator_free(), BLI_ghashIterator_getValue(), BLI_ghashIterator_new(), BLI_ghashIterator_step(), NULL, Main::relations, MainIDRelations::relations_from_pointers, and MainIDRelationsEntry::tags.

Referenced by BKE_lib_override_library_main_resync(), BKE_lib_override_library_resync(), and lib_override_library_create_do().

BKE_main_thumbnail_create()

void BKE_main_thumbnail_create

(

struct Main *

bmain

)

Generates an empty (black) thumbnail for given Main.

Definition at line 416 of file main.c.

References Main::blen_thumb, BLEN_THUMB_MEMSIZE, BLEN_THUMB_SIZE, BlendThumbnail::height, MEM_callocN, MEM_SAFE_FREE, and BlendThumbnail::width.

BKE_main_thumbnail_from_imbuf()

struct BlendThumbnail* BKE_main_thumbnail_from_imbuf	(	Main *	bmain,
		ImBuf *	img
	)

Generates a raw .blend file thumbnail data from given image.

Parameters

bmain	If not NULL, also store generated data in this Main.
img	ImBuf image to generate thumbnail data from.

Returns

The generated .blend file raw thumbnail data.

Definition at line 363 of file main.c.

References Main::blen_thumb, BLEN_THUMB_MEMSIZE, data, IMB_rect_from_float(), MEM_mallocN, MEM_SAFE_FREE, NULL, ImBuf::rect, ImBuf::x, and ImBuf::y.

Referenced by blend_file_thumb().

BKE_main_thumbnail_to_imbuf()

struct ImBuf* BKE_main_thumbnail_to_imbuf	(	Main *	bmain,
		BlendThumbnail *	data
	)

Generates an image from raw .blend file thumbnail data.

Parameters

bmain	Use this bmain->blen_thumb data if given data is NULL.
data	Raw .blend file thumbnail data.

Returns

An ImBuf from given data, or NULL if invalid.

Definition at line 394 of file main.c.

References Main::blen_thumb, BLEN_THUMB_MEMSIZE, data, IB_metadata, IB_rect, IMB_allocImBuf(), NULL, and ImBuf::rect.

Referenced by blend_file_thumb(), and IMB_thumb_load_blend().

BKE_main_unlock()

void BKE_main_unlock

(

struct Main *

bmain

)

Definition at line 207 of file main.c.

References BLI_spin_unlock(), and Main::lock.

Referenced by BKE_id_free_ex(), BKE_libblock_alloc(), BKE_libblock_management_main_add(), BKE_libblock_management_main_remove(), BKE_libblock_remap(), BKE_libblock_remap_locked(), BKE_libblock_unlink(), BKE_objects_materials_test_all(), BLO_main_validate_libraries(), BLO_main_validate_shapekeys(), id_delete(), and lib_relocate_do().

set_listbasepointers()

int set_listbasepointers	(	struct Main *	main,
		struct ListBase *	lb[]
	)

Referenced by add_loose_object_data_to_scene(), add_main_to_main(), BKE_blendfile_write_partial(), BKE_bpath_traverse_main(), BKE_library_ID_test_usages(), BKE_library_indirectly_used_data_tag_clear(), BKE_library_make_local(), BKE_main_id_flag_all(), BKE_main_id_tag_all(), blo_add_library_pointer_map(), blo_do_versions_270(), BLO_expand_main(), BLO_main_validate_libraries(), blo_split_main(), blender::ed::outliner::TreeDisplayIDOrphans::buildTree(), has_linked_ids_to_read(), id_delete(), lib_relocate_do(), library_ID_is_used(), read_library_clear_weak_links(), read_library_linked_ids(), split_main_newid(), write_file_handle(), and write_libraries().

which_libbase()

struct ListBase* which_libbase	(	Main *	bmain,
		short	type
	)

Returns

A pointer to the ListBase of given bmain for requested type ID type.

Definition at line 447 of file main.c.

References Main::actions, Main::armatures, Main::brushes, Main::cachefiles, Main::cameras, Main::collections, Main::curves, Main::fonts, Main::gpencils, Main::hairs, 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, Main::images, Main::ipo, Main::lattices, Main::libraries, Main::lightprobes, Main::lights, Main::linestyles, Main::masks, Main::materials, Main::meshes, Main::metaballs, Main::movieclips, Main::nodetrees, NULL, Main::objects, Main::paintcurves, Main::palettes, Main::particles, Main::pointclouds, Main::scenes, Main::screens, Main::shapekeys, Main::simulations, Main::sounds, Main::speakers, Main::texts, Main::textures, type, Main::volumes, Main::wm, Main::workspaces, and Main::worlds.

Referenced by BKE_id_free_ex(), BKE_id_is_in_global_main(), BKE_libblock_alloc(), BKE_libblock_find_name(), BKE_libblock_management_main_add(), BKE_libblock_management_main_remove(), BKE_libblock_rename(), BKE_main_id_tag_idcode(), BKE_main_idmap_lookup_name(), BKE_mask_clipboard_paste_to_layer(), BKE_node_clipboard_validate(), BLI_libblock_ensure_unique_name(), blo_do_versions_280(), blo_do_versions_290(), BLO_library_link_copypaste(), blender::ed::outliner::TreeDisplayIDOrphans::buildTree(), create_placeholder(), is_yet_read(), lib_id_clear_library_data_ex(), lib_relocate_do(), lib_relocate_do_remap(), link_named_part(), outliner_id_itemf(), outliner_id_remap_exec(), pastebuf_match_path_property(), read_libblock(), read_libblock_undo_restore_at_old_address(), read_libblock_undo_restore_identical(), rename_id_for_versioning(), seqclipboard_ptr_restore(), split_libdata(), ui_template_id(), and undosys_id_ref_resolve().