Page MenuHome
Differential D2917 Diff 9605 source/blender/windowmanager/message_bus/intern/wm_message_bus_rna.c

Changeset View

Standalone View

View Options

source/blender/windowmanager/message_bus/intern/wm_message_bus_rna.c

  • This file was added.
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file blender/windowmanager/intern/wm_message_bus_rna.c
* \ingroup wm
*/
#define WM_MESSAGE_BUS_INTERN
#include <stdio.h>
#include "DNA_ID.h"
#include "BLI_utildefines.h"
#include "BLI_ghash.h"
#include "BLI_listbase.h"
#include "WM_types.h"
#include "WM_message.h"
#include "RNA_access.h"
#include "MEM_guardedalloc.h"
/* -------------------------------------------------------------------------- */
BLI_INLINE uint void_hash_uint(const void *key)
{
size_t y = (size_t)key >> (sizeof(void *));
return (unsigned int)y;
}
static uint wm_msg_rna_gset_hash(const void *key_p)
mont29Unsubmitted
Done
Inline Actions

Think should rather be named something like wm_msg_rna_gset_hash or something? Same for the next ones too…

mont29: Think should rather be named something like `wm_msg_rna_gset_hash` or something? Same for the…
{
const wmMsgSubscribeKey_RNA *key = key_p;
const wmMsgParams_RNA *params = &key->msg.params;
// printf("%s\n", RNA_struct_identifier(params->ptr.type));
uint k = void_hash_uint(params->ptr.type);
k ^= void_hash_uint(params->ptr.data);
k ^= void_hash_uint(params->ptr.id.data);
k ^= void_hash_uint(params->prop);
return k;
}
static bool wm_msg_rna_gset_cmp(const void *key_a_p, const void *key_b_p)
{
const wmMsgParams_RNA *params_a = &((const wmMsgSubscribeKey_RNA *)key_a_p)->msg.params;
const wmMsgParams_RNA *params_b = &((const wmMsgSubscribeKey_RNA *)key_b_p)->msg.params;
return !(
(params_a->ptr.type ==
params_b->ptr.type) &&
(params_a->ptr.id.data ==
params_b->ptr.id.data) &&
(params_a->ptr.data ==
params_b->ptr.data) &&
(params_a->prop ==
params_b->prop)
);
}
static void wm_msg_rna_gset_key_free(void *key_p)
{
wmMsgSubscribeKey *key = key_p;
wmMsgSubscribeValueLink *msg_lnk_next;
for (wmMsgSubscribeValueLink *msg_lnk = key->values.first; msg_lnk; msg_lnk = msg_lnk_next) {
msg_lnk_next = msg_lnk->next;
BLI_remlink(&key->values, msg_lnk);
MEM_freeN(msg_lnk);
}
MEM_freeN(key);
}
static void wm_msg_rna_repr(FILE *stream, const wmMsgSubscribeKey *msg_key)
{
const wmMsgSubscribeKey_RNA *m = (wmMsgSubscribeKey_RNA *)msg_key;
const char *none = "<none>";
fprintf(stream,
"<wmMsg_RNA %p, "
"id='%s', "
"%s.%s values_len=%d\n",
m, m->msg.head.id,
m->msg.params.ptr.type ? RNA_struct_identifier(m->msg.params.ptr.type) : none,
m->msg.params.prop ? RNA_property_identifier((PropertyRNA *)m->msg.params.prop) : none,
BLI_listbase_count(&m->head.values));
}
static void wm_msg_rna_remove_by_id(struct wmMsgBus *mbus, const ID *id)
{
GSet *gs = mbus->messages_gset[WM_MSG_TYPE_RNA];
GSetIterator gs_iter;
BLI_gsetIterator_init(&gs_iter, gs);
while (BLI_gsetIterator_done(&gs_iter) == false) {
wmMsgSubscribeKey_RNA *key = BLI_gsetIterator_getKey(&gs_iter);
BLI_gsetIterator_step(&gs_iter);
if (key->msg.params.ptr.id.data == id) {
BLI_remlink(&mbus->messages, key);
BLI_gset_remove(gs, key, NULL);
wm_msg_rna_gset_key_free(key);
}
}
}
void WM_msgtypeinfo_init_rna(wmMsgTypeInfo *msgtype_info)
{
msgtype_info->gset.hash_fn = wm_msg_rna_gset_hash;
msgtype_info->gset.cmp_fn = wm_msg_rna_gset_cmp;
msgtype_info->gset.key_free_fn = wm_msg_rna_gset_key_free;
msgtype_info->repr = wm_msg_rna_repr;
msgtype_info->remove_by_id = wm_msg_rna_remove_by_id;
msgtype_info->msg_key_size = sizeof(wmMsgSubscribeKey_RNA);
}
/* -------------------------------------------------------------------------- */
wmMsgSubscribeKey_RNA *WM_msg_lookup_rna(struct wmMsgBus *mbus, const wmMsgParams_RNA *msg_key_params)
{
wmMsgSubscribeKey_RNA key_test;
key_test.msg.params = *msg_key_params;
return BLI_gset_lookup(mbus->messages_gset[WM_MSG_TYPE_RNA], &key_test);
}
void WM_msg_publish_rna_params(struct wmMsgBus *mbus, const wmMsgParams_RNA *msg_key_params)
{
wmMsgSubscribeKey_RNA *key = WM_msg_lookup_rna(mbus, msg_key_params);
if (key) {
WM_msg_publish_with_key(mbus, &key->head);
}
/* Support anonymous subscribers, this may be some extra overhead
* but we want to be able to be more ambiguous. */
if (msg_key_params->ptr.id.data || msg_key_params->ptr.data) {
wmMsgParams_RNA msg_key_params_anon = *msg_key_params;
msg_key_params_anon.ptr.id.data = NULL;
msg_key_params_anon.ptr.data = NULL;
key = WM_msg_lookup_rna(mbus, &msg_key_params_anon);
if (key) {
WM_msg_publish_with_key(mbus, &key->head);
}
/* Support subscribers to a type. */
if (msg_key_params->prop) {
msg_key_params_anon.prop = NULL;
key = WM_msg_lookup_rna(mbus, &msg_key_params_anon);
if (key) {
WM_msg_publish_with_key(mbus, &key->head);
}
}
}
}
void WM_msg_publish_rna(struct wmMsgBus *mbus, PointerRNA *ptr, PropertyRNA *prop)
{
WM_msg_publish_rna_params(mbus, &(wmMsgParams_RNA){ .ptr = *ptr, .prop = prop, });
}
void WM_msg_subscribe_rna_params(
struct wmMsgBus *mbus,
const wmMsgParams_RNA *msg_key_params,
const wmMsgSubscribeValue *msg_val_params)
{
wmMsgSubscribeKey_RNA msg_key_test = {{NULL}};
/* use when added */
msg_key_test.msg.head.id = __func__;
msg_key_test.msg.head.type = WM_MSG_TYPE_RNA;
/* for lookup */
msg_key_test.msg.params = *msg_key_params;
WM_msg_subscribe_with_key(mbus, &msg_key_test.head, msg_val_params);
}
void WM_msg_subscribe_rna(
struct wmMsgBus *mbus,
PointerRNA *ptr, const PropertyRNA *prop,
const wmMsgSubscribeValue *msg_val_params)
{
WM_msg_subscribe_rna_params(mbus, &(const wmMsgParams_RNA){.ptr = *ptr, .prop = prop,}, msg_val_params);
}
/** \} */
/* -------------------------------------------------------------------------- */
/** \name ID variants of RNA API
*
* \note While we could have a separate type for ID's, use RNA since there is enough overlap.
* \{ */
void WM_msg_subscribe_ID(struct wmMsgBus *mbus, ID *id, const wmMsgSubscribeValue *msg_val_params)
{
wmMsgParams_RNA msg_key_params = {NULL};
RNA_id_pointer_create(id, &msg_key_params.ptr);
WM_msg_subscribe_rna_params(mbus, &msg_key_params, msg_val_params);
}
void WM_msg_publish_ID(struct wmMsgBus *mbus, ID *id)
{
wmMsgParams_RNA msg_key_params = {NULL};
RNA_id_pointer_create(id, &msg_key_params.ptr);
WM_msg_publish_rna_params(mbus, &msg_key_params);
}
/** \} */