Blender V5.3
callbacks.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include "BLI_listbase.hh"
10
11#include "BKE_callbacks.hh"
12
13#include "MEM_guardedalloc.h"
14
15#include "RNA_access.hh"
16#include "RNA_prototypes.hh"
17
18namespace blender {
19
20static ListBaseT<bCallbackFuncStore> callback_slots[BKE_CB_EVT_TOT] = {{nullptr}};
21
22static bool callbacks_initialized = false;
23
24#define ASSERT_CALLBACKS_INITIALIZED() \
25 BLI_assert_msg(callbacks_initialized, \
26 "Callbacks should be initialized with BKE_callback_global_init() before using " \
27 "the callback system.")
28
29void BKE_callback_exec(Main *bmain, PointerRNA **pointers, const int pointers_num, eCbEvent evt)
30{
32
33 /* Use mutable iteration so handlers are able to remove themselves. */
34 ListBaseT<bCallbackFuncStore> *lb = &callback_slots[evt];
35 for (bCallbackFuncStore &funcstore : lb->items_mutable()) {
36 funcstore.func(bmain, pointers, pointers_num, funcstore.arg);
37 }
38}
39
41{
42 BKE_callback_exec(bmain, nullptr, 0, evt);
43}
44
45void BKE_callback_exec_id(Main *bmain, ID *id, eCbEvent evt)
46{
48
49 PointerRNA *pointers[1] = {&id_ptr};
50
51 BKE_callback_exec(bmain, pointers, ARRAY_SIZE(pointers), evt);
52}
53
54void BKE_callback_exec_id_depsgraph(Main *bmain, ID *id, Depsgraph *depsgraph, eCbEvent evt)
55{
57
58 PointerRNA depsgraph_ptr = RNA_pointer_create_discrete(nullptr, RNA_Depsgraph, depsgraph);
59
60 PointerRNA *pointers[2] = {&id_ptr, &depsgraph_ptr};
61
62 BKE_callback_exec(bmain, pointers, ARRAY_SIZE(pointers), evt);
63}
64
65void BKE_callback_exec_boolean(Main *bmain, bool value, eCbEvent evt)
66{
68 data.value = value;
69 PointerRNA boolean_ptr = RNA_pointer_create_discrete(nullptr, RNA_PrimitiveBoolean, &data);
70
71 PointerRNA *pointers[1] = {&boolean_ptr};
72
73 BKE_callback_exec(bmain, pointers, ARRAY_SIZE(pointers), evt);
74}
75
76void BKE_callback_exec_string(Main *bmain, const char *str, eCbEvent evt)
77{
78 PrimitiveStringRNA data = {nullptr};
79 data.value = str;
80 PointerRNA str_ptr = RNA_pointer_create_discrete(nullptr, RNA_PrimitiveString, &data);
81
82 PointerRNA *pointers[1] = {&str_ptr};
83
84 BKE_callback_exec(bmain, pointers, ARRAY_SIZE(pointers), evt);
85}
86
88{
90 ListBaseT<bCallbackFuncStore> *lb = &callback_slots[evt];
91 BLI_addtail(lb, funcstore);
92}
93
95{
96 /* The callback may have already been removed by BKE_callback_global_finalize(), for
97 * example when removing callbacks in response to a BKE_blender_atexit_register callback
98 * function. `BKE_blender_atexit()` runs after `BKE_callback_global_finalize()`. */
100 return;
101 }
102
103 ListBaseT<bCallbackFuncStore> *lb = &callback_slots[evt];
104
105 /* Be noisy about potential programming errors. */
106 BLI_assert_msg(BLI_findindex(lb, funcstore) != -1, "To-be-removed callback not found");
107
108 BLI_remlink(lb, funcstore);
109
110 if (funcstore->alloc) {
111 MEM_delete(funcstore);
112 }
113}
114
119
121{
122 for (int evt_i = 0; evt_i < BKE_CB_EVT_TOT; evt_i++) {
123 const eCbEvent evt = eCbEvent(evt_i);
124 ListBaseT<bCallbackFuncStore> *lb = &callback_slots[evt];
125 bCallbackFuncStore *funcstore;
126 bCallbackFuncStore *funcstore_next;
127 for (funcstore = lb->first(); funcstore; funcstore = funcstore_next) {
128 funcstore_next = funcstore->next;
129 BKE_callback_remove(funcstore, evt);
130 }
131 }
132
133 callbacks_initialized = false;
134}
135
136} // namespace blender
Read Blender memory allocation and freeing.
#define BLI_assert_msg(a, msg)
#define ASSERT_CALLBACKS_INITIALIZED()
Definition callbacks.cc:24
#define str(s)
BMesh Iterators.
void BKE_callback_exec_id_depsgraph(Main *bmain, ID *id, Depsgraph *depsgraph, eCbEvent evt)
Definition callbacks.cc:54
void BKE_callback_exec_string(Main *bmain, const char *str, eCbEvent evt)
Definition callbacks.cc:76
void BKE_callback_exec_null(Main *bmain, eCbEvent evt)
Definition callbacks.cc:40
PointerRNA RNA_id_pointer_create(ID *id)
void BKE_callback_exec_boolean(Main *bmain, bool value, eCbEvent evt)
Definition callbacks.cc:65
void BKE_callback_exec_id(Main *bmain, ID *id, eCbEvent evt)
Definition callbacks.cc:45
void BKE_callback_add(bCallbackFuncStore *funcstore, eCbEvent evt)
Definition callbacks.cc:87
int BLI_findindex(const ListBase *listbase, const void *vlink) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
Definition listbase.cc:593
void BLI_remlink(ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition listbase.cc:138
BMesh const char void * data
void BKE_callback_remove(bCallbackFuncStore *funcstore, eCbEvent evt)
Definition callbacks.cc:94
constexpr size_t ARRAY_SIZE(const T(&arg)[N]) noexcept
PointerRNA RNA_pointer_create_discrete(ID *id, StructRNA *type, void *data)
void BKE_callback_global_finalize()
Definition callbacks.cc:120
void BLI_addtail(ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition listbase.cc:118
static bool callbacks_initialized
Definition callbacks.cc:22
void BKE_callback_global_init()
Definition callbacks.cc:115
static ListBaseT< bCallbackFuncStore > callback_slots[BKE_CB_EVT_TOT]
Definition callbacks.cc:20
void BKE_callback_exec(Main *bmain, PointerRNA **pointers, int pointers_num, eCbEvent evt)
Definition callbacks.cc:29
bCallbackFuncStore * next