Blender V5.3
keyconfig.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 <cstddef>
10#include <cstdio>
11#include <cstdlib>
12
13#include "RNA_types.hh"
14
15#include "BLI_ghash.hh"
16#include "BLI_listbase.hh"
17#include "BLI_string.hh"
18
19#include "DNA_listBase.h"
20#include "DNA_userdef_types.h"
22
23#include "BKE_idprop.hh"
24#include "BKE_keyconfig.h" /* own include */
25
26#include "MEM_guardedalloc.h"
27
28namespace blender {
29
30/* -------------------------------------------------------------------- */
35
36wmKeyConfigPref *BKE_keyconfig_pref_ensure(UserDef *userdef, const char *kc_idname)
37{
39 &userdef->user_keyconfig_prefs, kc_idname, offsetof(wmKeyConfigPref, idname)));
40 if (kpt == nullptr) {
41 kpt = MEM_new<wmKeyConfigPref>(__func__);
42 STRNCPY(kpt->idname, kc_idname);
43 BLI_addtail(&userdef->user_keyconfig_prefs, kpt);
44 }
45 if (kpt->prop == nullptr) {
46 /* name is unimportant. */
47 kpt->prop = bke::idprop::create_group(kc_idname).release();
48 }
49 return kpt;
50}
51
53
54/* -------------------------------------------------------------------- */
59
61
62wmKeyConfigPrefType_Runtime *BKE_keyconfig_pref_type_find(const char *idname, bool quiet)
63{
64 if (idname[0]) {
65 wmKeyConfigPrefType_Runtime *kpt_rt;
66
67 kpt_rt = static_cast<wmKeyConfigPrefType_Runtime *>(
69 if (kpt_rt) {
70 return kpt_rt;
71 }
72
73 if (!quiet) {
74 printf("search for unknown keyconfig-pref '%s'\n", idname);
75 }
76 }
77 else {
78 if (!quiet) {
79 printf("search for empty keyconfig-pref\n");
80 }
81 }
82
83 return nullptr;
84}
85
86void BKE_keyconfig_pref_type_add(wmKeyConfigPrefType_Runtime *kpt_rt)
87{
88 BLI_ghash_insert(global_keyconfigpreftype_hash, kpt_rt->idname, kpt_rt);
89}
90
91void BKE_keyconfig_pref_type_remove(const wmKeyConfigPrefType_Runtime *kpt_rt)
92{
94}
95
101
107
109
110/* -------------------------------------------------------------------- */
113
114void BKE_keyconfig_pref_set_select_mouse(UserDef *userdef, int value, bool override)
115{
117 IDProperty *idprop = IDP_GetPropertyFromGroup(kpt->prop, "select_mouse");
118 if (!idprop) {
119 IDP_AddToGroup(kpt->prop, bke::idprop::create("select_mouse", value).release());
120 }
121 else if (override) {
122 IDP_int_set(idprop, value);
123 }
124}
125
127{
129 if (kmi->ptr) {
130 MEM_delete(kmi->ptr);
131 }
132 MEM_delete(kmi);
133}
134
136{
137 if (kmdi->add_item) {
139 }
140 if (kmdi->remove_item) {
142 }
143 MEM_delete(kmdi);
144}
145
147 const wmKeyConfigFilterItemParams *params,
148 bool (*filter_fn)(wmKeyMapItem *kmi, void *user_data),
149 void *user_data)
150{
151 if (params->check_diff_item_add || params->check_diff_item_remove) {
152 for (wmKeyMapDiffItem *kmdi = keymap->diff_items.first(), *kmdi_next; kmdi; kmdi = kmdi_next) {
153 kmdi_next = kmdi->next;
154 bool remove = false;
155
156 if (params->check_diff_item_add) {
157 if (kmdi->add_item) {
158 if (filter_fn(kmdi->add_item, user_data)) {
159 remove = true;
160 }
161 }
162 }
163
164 if (!remove && params->check_diff_item_remove) {
165 if (kmdi->remove_item) {
166 if (filter_fn(kmdi->remove_item, user_data)) {
167 remove = true;
168 }
169 }
170 }
171
172 if (remove) {
173 BLI_remlink(&keymap->diff_items, kmdi);
175 }
176 }
177 }
178
179 if (params->check_item) {
180 for (wmKeyMapItem *kmi = keymap->items.first(), *kmi_next; kmi; kmi = kmi_next) {
181 kmi_next = kmi->next;
182 if (filter_fn(kmi, user_data)) {
183 BLI_remlink(&keymap->items, kmi);
184 keymap_item_free(kmi);
185 }
186 }
187 }
188}
189
191 const wmKeyConfigFilterItemParams *params,
192 bool (*filter_fn)(wmKeyMapItem *kmi, void *user_data),
193 void *user_data)
194{
195 for (wmKeyMap &keymap : userdef->user_keymaps) {
196 BKE_keyconfig_keymap_filter_item(&keymap, params, filter_fn, user_data);
197 }
198}
199
201
202} // namespace blender
#define IDP_int_set(prop, value)
These structs are the foundation for all linked lists in the library system.
#define WM_KEYCONFIG_STR_DEFAULT
Read Blender memory allocation and freeing.
#define offsetof(t, d)
std::unique_ptr< IDProperty, IDPropertyDeleter > create(StringRef prop_name, int32_t value, eIDPropertyFlag flags={})
Allocate a new IDProperty of type IDP_INT, set its name and value.
std::unique_ptr< IDProperty, IDPropertyDeleter > create_group(StringRef prop_name, eIDPropertyFlag flags={})
Allocate a new IDProperty of type IDP_GROUP.
BMesh Iterators.
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
static void keymap_diff_item_free(wmKeyMapDiffItem *kmdi)
Definition keyconfig.cc:135
char * STRNCPY(char(&dst)[N], const char *src)
GHash * BLI_ghash_str_new(const char *info) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT
void * BLI_ghash_lookup(const GHash *gh, const void *key) ATTR_WARN_UNUSED_RESULT
Definition BLI_ghash.cc:735
bool IDP_AddToGroup(IDProperty *group, IDProperty *prop) ATTR_NONNULL()
Definition idprop.cc:788
IDProperty * IDP_GetPropertyFromGroup(const IDProperty *prop, StringRef name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
Definition idprop.cc:818
void * BLI_findstring(const ListBase *listbase, const char *id, int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
Definition listbase.cc:615
void MEM_delete_void(void *vmemh)
void BLI_ghash_insert(GHash *gh, void *key, void *val)
Definition BLI_ghash.cc:711
void BKE_keyconfig_keymap_filter_item(struct wmKeyMap *keymap, const struct wmKeyConfigFilterItemParams *params, bool(*filter_fn)(struct wmKeyMapItem *kmi, void *user_data), void *user_data)
static void keymap_item_free(wmKeyMapItem *kmi)
Definition blender.cc:265
void BLI_ghash_free(GHash *gh, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfreefp)
Definition BLI_ghash.cc:866
void BKE_keyconfig_pref_set_select_mouse(struct UserDef *userdef, int value, bool override)
Definition keyconfig.cc:114
void BLI_remlink(ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition listbase.cc:138
void BKE_keyconfig_pref_type_init()
Definition keyconfig.cc:96
void BKE_keyconfig_pref_filter_items(struct UserDef *userdef, const struct wmKeyConfigFilterItemParams *params, bool(*filter_fn)(struct wmKeyMapItem *kmi, void *user_data), void *user_data)
void BKE_keyconfig_pref_type_remove(const struct wmKeyConfigPrefType_Runtime *kpt_rt)
static GHash * global_keyconfigpreftype_hash
Definition keyconfig.cc:60
void BLI_addtail(ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition listbase.cc:118
void IDP_FreeProperty(IDProperty *prop)
Definition idprop.cc:1403
bool BLI_ghash_remove(GHash *gh, const void *key, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfreefp)
Definition BLI_ghash.cc:792
struct wmKeyConfigPref * BKE_keyconfig_pref_ensure(struct UserDef *userdef, const char *kc_idname)
Definition keyconfig.cc:36
void BKE_keyconfig_pref_type_free()
Definition keyconfig.cc:102
void BKE_keyconfig_pref_type_add(struct wmKeyConfigPrefType_Runtime *kpt_rt)
Definition keyconfig.cc:86
struct wmKeyConfigPrefType_Runtime * BKE_keyconfig_pref_type_find(const char *idname, bool quiet)
Definition keyconfig.cc:62
ListBaseT< struct wmKeyMap > user_keymaps
ListBaseT< struct wmKeyConfigPref > user_keyconfig_prefs
ListBaseT< wmKeyMapDiffItem > diff_items
ListBaseT< wmKeyMapItem > items