e955c94ed3
Listing the "Blender Foundation" as copyright holder implied the Blender Foundation holds copyright to files which may include work from many developers. While keeping copyright on headers makes sense for isolated libraries, Blender's own code may be refactored or moved between files in a way that makes the per file copyright holders less meaningful. Copyright references to the "Blender Foundation" have been replaced with "Blender Authors", with the exception of `./extern/` since these this contains libraries which are more isolated, any changed to license headers there can be handled on a case-by-case basis. Some directories in `./intern/` have also been excluded: - `./intern/cycles/` it's own `AUTHORS` file is planned. - `./intern/opensubdiv/`. An "AUTHORS" file has been added, using the chromium projects authors file as a template. Design task: #110784 Ref !110783.
130 lines
3.4 KiB
C++
130 lines
3.4 KiB
C++
/* SPDX-FileCopyrightText: 2023 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
/** \file
|
|
* \ingroup bke
|
|
*/
|
|
|
|
#include "BLI_listbase.h"
|
|
#include "BLI_utildefines.h"
|
|
|
|
#include "BKE_callbacks.h"
|
|
|
|
#include "MEM_guardedalloc.h"
|
|
|
|
#include "RNA_access.hh"
|
|
#include "RNA_prototypes.h"
|
|
#include "RNA_types.hh"
|
|
|
|
static ListBase callback_slots[BKE_CB_EVT_TOT] = {{nullptr}};
|
|
|
|
static bool callbacks_initialized = false;
|
|
|
|
#define ASSERT_CALLBACKS_INITIALIZED() \
|
|
BLI_assert_msg(callbacks_initialized, \
|
|
"Callbacks should be initialized with BKE_callback_global_init() before using " \
|
|
"the callback system.")
|
|
|
|
void BKE_callback_exec(Main *bmain, PointerRNA **pointers, const int num_pointers, eCbEvent evt)
|
|
{
|
|
ASSERT_CALLBACKS_INITIALIZED();
|
|
|
|
/* Use mutable iteration so handlers are able to remove themselves. */
|
|
ListBase *lb = &callback_slots[evt];
|
|
LISTBASE_FOREACH_MUTABLE (bCallbackFuncStore *, funcstore, lb) {
|
|
funcstore->func(bmain, pointers, num_pointers, funcstore->arg);
|
|
}
|
|
}
|
|
|
|
void BKE_callback_exec_null(Main *bmain, eCbEvent evt)
|
|
{
|
|
BKE_callback_exec(bmain, nullptr, 0, evt);
|
|
}
|
|
|
|
void BKE_callback_exec_id(Main *bmain, ID *id, eCbEvent evt)
|
|
{
|
|
PointerRNA id_ptr;
|
|
RNA_id_pointer_create(id, &id_ptr);
|
|
|
|
PointerRNA *pointers[1] = {&id_ptr};
|
|
|
|
BKE_callback_exec(bmain, pointers, 1, evt);
|
|
}
|
|
|
|
void BKE_callback_exec_id_depsgraph(Main *bmain, ID *id, Depsgraph *depsgraph, eCbEvent evt)
|
|
{
|
|
PointerRNA id_ptr;
|
|
RNA_id_pointer_create(id, &id_ptr);
|
|
|
|
PointerRNA depsgraph_ptr;
|
|
RNA_pointer_create(nullptr, &RNA_Depsgraph, depsgraph, &depsgraph_ptr);
|
|
|
|
PointerRNA *pointers[2] = {&id_ptr, &depsgraph_ptr};
|
|
|
|
BKE_callback_exec(bmain, pointers, 2, evt);
|
|
}
|
|
|
|
void BKE_callback_exec_string(Main *bmain, eCbEvent evt, const char *str)
|
|
{
|
|
PointerRNA str_ptr;
|
|
PrimitiveStringRNA data = {nullptr};
|
|
data.value = str;
|
|
RNA_pointer_create(nullptr, &RNA_PrimitiveString, &data, &str_ptr);
|
|
|
|
PointerRNA *pointers[1] = {&str_ptr};
|
|
|
|
BKE_callback_exec(bmain, pointers, 1, evt);
|
|
}
|
|
|
|
void BKE_callback_add(bCallbackFuncStore *funcstore, eCbEvent evt)
|
|
{
|
|
ASSERT_CALLBACKS_INITIALIZED();
|
|
ListBase *lb = &callback_slots[evt];
|
|
BLI_addtail(lb, funcstore);
|
|
}
|
|
|
|
void BKE_callback_remove(bCallbackFuncStore *funcstore, eCbEvent evt)
|
|
{
|
|
/* The callback may have already been removed by BKE_callback_global_finalize(), for
|
|
* example when removing callbacks in response to a BKE_blender_atexit_register callback
|
|
* function. `BKE_blender_atexit()` runs after `BKE_callback_global_finalize()`. */
|
|
if (!callbacks_initialized) {
|
|
return;
|
|
}
|
|
|
|
ListBase *lb = &callback_slots[evt];
|
|
|
|
/* Be noisy about potential programming errors. */
|
|
BLI_assert_msg(BLI_findindex(lb, funcstore) != -1, "To-be-removed callback not found");
|
|
|
|
BLI_remlink(lb, funcstore);
|
|
|
|
if (funcstore->alloc) {
|
|
MEM_freeN(funcstore);
|
|
}
|
|
}
|
|
|
|
void BKE_callback_global_init()
|
|
{
|
|
callbacks_initialized = true;
|
|
}
|
|
|
|
void BKE_callback_global_finalize()
|
|
{
|
|
for (int evt_i = 0; evt_i < BKE_CB_EVT_TOT; evt_i++) {
|
|
const eCbEvent evt = eCbEvent(evt_i);
|
|
ListBase *lb = &callback_slots[evt];
|
|
bCallbackFuncStore *funcstore;
|
|
bCallbackFuncStore *funcstore_next;
|
|
for (funcstore = static_cast<bCallbackFuncStore *>(lb->first); funcstore;
|
|
funcstore = funcstore_next)
|
|
{
|
|
funcstore_next = funcstore->next;
|
|
BKE_callback_remove(funcstore, evt);
|
|
}
|
|
}
|
|
|
|
callbacks_initialized = false;
|
|
}
|