1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
/* 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.h"
#include "RNA_types.h"
static ListBase callback_slots[BKE_CB_EVT_TOT] = {{NULL}};
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(struct Main *bmain,
struct 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(struct Main *bmain, eCbEvent evt)
{
BKE_callback_exec(bmain, NULL, 0, evt);
}
void BKE_callback_exec_id(struct Main *bmain, struct 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(struct Main *bmain,
struct ID *id,
struct Depsgraph *depsgraph,
eCbEvent evt)
{
PointerRNA id_ptr;
RNA_id_pointer_create(id, &id_ptr);
PointerRNA depsgraph_ptr;
RNA_pointer_create(NULL, &RNA_Depsgraph, depsgraph, &depsgraph_ptr);
PointerRNA *pointers[2] = {&id_ptr, &depsgraph_ptr};
BKE_callback_exec(bmain, pointers, 2, 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(void)
{
callbacks_initialized = true;
}
void BKE_callback_global_finalize(void)
{
eCbEvent evt;
for (evt = 0; evt < BKE_CB_EVT_TOT; evt++) {
ListBase *lb = &callback_slots[evt];
bCallbackFuncStore *funcstore;
bCallbackFuncStore *funcstore_next;
for (funcstore = lb->first; funcstore; funcstore = funcstore_next) {
funcstore_next = funcstore->next;
BKE_callback_remove(funcstore, evt);
}
}
callbacks_initialized = false;
}
|