#include <cstring>
#include "CLG_log.h"
#include "MEM_guardedalloc.h"
#include "BLI_listbase.h"
#include "BLI_utildefines.h"
#include "BLI_ghash.h"
#include "WM_types.hh"
#include "message_bus/intern/wm_message_bus_intern.hh"
#include "message_bus/wm_message_bus.hh"

Functions
Internal API
Note While we could have a separate type for ID's, use RNA since there is enough overlap.
void	wm_msg_subscribe_value_free (wmMsgSubscribeKey msg_key, wmMsgSubscribeValueLink msg_lnk)

Public API
using	wmMsgTypeInitFn = void ()(wmMsgTypeInfo )

static wmMsgTypeInfo	wm_msg_types [WM_MSG_TYPE_NUM] = {{{nullptr}}}

static wmMsgTypeInitFn	wm_msg_init_fn [WM_MSG_TYPE_NUM]

void	WM_msgbus_types_init ()

wmMsgBus *	WM_msgbus_create ()

void	WM_msgbus_destroy (wmMsgBus *mbus)

void	WM_msgbus_clear_by_owner (wmMsgBus mbus, void owner)

void	WM_msg_dump (wmMsgBus mbus, const char info_str)

void	WM_msgbus_handle (wmMsgBus mbus, bContext C)

wmMsgSubscribeKey *	WM_msg_subscribe_with_key (wmMsgBus mbus, const wmMsgSubscribeKey msg_key_test, const wmMsgSubscribeValue *msg_val_params)

void	WM_msg_publish_with_key (wmMsgBus mbus, wmMsgSubscribeKey msg_key)

void	WM_msg_id_update (wmMsgBus mbus, ID id_src, ID *id_dst)

void	WM_msg_id_remove (wmMsgBus mbus, const ID id)

Typedef Documentation

◆ wmMsgTypeInitFn

using wmMsgTypeInitFn = void (*)(wmMsgTypeInfo *)

Definition at line 31 of file wm_message_bus.cc.

Function Documentation

◆ WM_msg_dump()

void WM_msg_dump	(	wmMsgBus *	mbus,
		const char *	info_str )

Definition at line 104 of file wm_message_bus.cc.

References LISTBASE_FOREACH, wmMsgBus::messages, printf, wmMsgTypeInfo::repr, wmMsg::type, wm_msg_subscribe_value_msg_cast(), and wm_msg_types.

Referenced by bpy_msgbus_subscribe_rna(), and WM_msgbus_handle().

◆ WM_msg_id_remove()

void WM_msg_id_remove	(	wmMsgBus *	mbus,
		const ID *	id )

Definition at line 209 of file wm_message_bus.cc.

References wmMsgTypeInfo::remove_by_id, WM_MSG_TYPE_NUM, and wm_msg_types.

Referenced by WM_main_remap_editor_id_reference(), and WM_main_remove_notifier_reference().

◆ WM_msg_id_update()

void WM_msg_id_update	(	wmMsgBus *	mbus,
		ID *	id_src,
		ID *	id_dst )

Definition at line 199 of file wm_message_bus.cc.

References wmMsgTypeInfo::update_by_id, WM_MSG_TYPE_NUM, and wm_msg_types.

Referenced by WM_main_remap_editor_id_reference().

◆ WM_msg_publish_with_key()

void WM_msg_publish_with_key	(	wmMsgBus *	mbus,
		wmMsgSubscribeKey *	msg_key )

Definition at line 178 of file wm_message_bus.cc.

References BLI_listbase_count(), CLOG_INFO, LISTBASE_FOREACH, wmMsgBus::messages_tag_count, wmMsgSubscribeKey::values, and WM_LOG_MSGBUS_SUB.

Referenced by WM_msg_publish_rna_params(), and WM_msg_publish_static_params().

◆ wm_msg_subscribe_value_free()

void wm_msg_subscribe_value_free	(	wmMsgSubscribeKey *	msg_key,
		wmMsgSubscribeValueLink *	msg_lnk )

Note: wmMsgBus.messages_tag_count isn't updated, caller must handle.

Definition at line 227 of file wm_message_bus.cc.

References BLI_remlink(), wmMsgSubscribeValue::free_data, MEM_freeN(), wmMsgSubscribeValueLink::params, and wmMsgSubscribeKey::values.

Referenced by wm_msg_rna_gset_key_free(), wm_msg_rna_remove_by_id(), and wm_msg_rna_update_by_id().

◆ WM_msg_subscribe_with_key()

wmMsgSubscribeKey * WM_msg_subscribe_with_key	(	wmMsgBus *	mbus,
		const wmMsgSubscribeKey *	msg_key_test,
		const wmMsgSubscribeValue *	msg_val_params )

Parameters

msg_key_test

Needs following wmMsgSubscribeKey fields filled in:

msg.params
msg.head.type
msg.head.id .. other values should be zeroed.

Returns: The key for this subscription. note that this is only needed in rare cases when the key needs further manipulation.

Definition at line 143 of file wm_message_bus.cc.

References BLI_addtail(), BLI_assert, BLI_gset_ensure_p_ex(), LISTBASE_FOREACH, MEM_mallocN, wmMsgBus::messages, wmMsgBus::messages_gset, wmMsgTypeInfo::msg_key_size, wmMsgSubscribeValue::notify, wmMsgSubscribeValue::owner, wmMsgSubscribeValueLink::params, wmMsg::type, wmMsgSubscribeValue::user_data, wmMsgSubscribeKey::values, wm_msg_subscribe_value_msg_cast(), and wm_msg_types.

Referenced by WM_msg_subscribe_rna_params(), and WM_msg_subscribe_static_params().

◆ WM_msgbus_clear_by_owner()

void WM_msgbus_clear_by_owner	(	wmMsgBus *	mbus,
		void *	owner )

◆ WM_msgbus_create()

wmMsgBus * WM_msgbus_create ( )

Definition at line 45 of file wm_message_bus.cc.

References BLI_gset_new_ex(), wmMsgTypeInfo::cmp_fn, wmMsgTypeInfo::gset, wmMsgTypeInfo::hash_fn, MEM_callocN, wmMsgBus::messages_gset, WM_MSG_TYPE_NUM, and wm_msg_types.

Referenced by WM_check().

◆ WM_msgbus_destroy()

void WM_msgbus_destroy ( wmMsgBus * mbus )

Definition at line 57 of file wm_message_bus.cc.

References BLI_gset_free(), wmMsgTypeInfo::gset, wmMsgTypeInfo::key_free_fn, MEM_freeN(), wmMsgBus::messages_gset, WM_MSG_TYPE_NUM, and wm_msg_types.

Referenced by wm_close_and_free(), and wm_file_read_setup_wm_init().

◆ WM_msgbus_handle()

void WM_msgbus_handle	(	wmMsgBus *	mbus,
		bContext *	C )

Definition at line 115 of file wm_message_bus.cc.

References BLI_assert, LISTBASE_FOREACH, wmMsgBus::messages, wmMsgBus::messages_tag_count, and WM_msg_dump().

Referenced by wm_event_do_notifiers().

◆ WM_msgbus_types_init()

void WM_msgbus_types_init ( )

Definition at line 38 of file wm_message_bus.cc.

References wm_msg_init_fn, WM_MSG_TYPE_NUM, and wm_msg_types.

Referenced by WM_init().

Variable Documentation

◆ wm_msg_init_fn

wmMsgTypeInitFn wm_msg_init_fn[WM_MSG_TYPE_NUM]

static

Initial value:

= {
    WM_msgtypeinfo_init_rna,
    WM_msgtypeinfo_init_static,
}

Definition at line 33 of file wm_message_bus.cc.

Referenced by WM_msgbus_types_init().

◆ wm_msg_types

wmMsgTypeInfo wm_msg_types[WM_MSG_TYPE_NUM] = {{{nullptr}}}