Keymap: add support for key-config preferences

This is needed for keymaps to define their own options,
which can include left/right mouse select.

This can also help to us to provide popular keymap tweaks as options,
so users can easily fit blender to their workflow with well supported
adjustments which don't give the overhead of having to maintain
your own keymap, which become out-dated when operators change.

4 files changed, 157 insertions, 0 deletions

diff --git a/source/blender/blenkernel/BKE_keyconfig.h b/source/blender/blenkernel/BKE_keyconfig.h
new file mode 100644
index 00000000000..bef6aab2d82
--- /dev/null
+++ b/source/blender/blenkernel/BKE_keyconfig.h
@@ -0,0 +1,50 @@
+/*
+ * ***** 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 *****
+ */
+#ifndef __BKE_KEYCONFIG_H__
+#define __BKE_KEYCONFIG_H__
+
+/** \file BKE_keyconfig.h
+ *  \ingroup bke
+ */
+
+/** Based on #BKE_addon_pref_type_init and friends */
+
+/** Actual data is stored in #wmKeyConfigPrefType. */
+#if defined(__RNA_TYPES_H__)
+typedef struct wmKeyConfigPrefType_Runtime {
+	char idname[64];
+
+	/* RNA integration */
+	ExtensionRNA ext;
+} wmKeyConfigPrefType_Runtime;
+
+#else
+typedef struct wmKeyConfigPrefType_Runtime wmKeyConfigPrefType_Runtime;
+#endif
+
+/* KeyConfig preferenes. */
+struct wmKeyConfigPrefType_Runtime *BKE_keyconfig_pref_type_find(const char *idname, bool quiet);
+void BKE_keyconfig_pref_type_add(struct wmKeyConfigPrefType_Runtime *kpt_rt);
+void BKE_keyconfig_pref_type_remove(const struct wmKeyConfigPrefType_Runtime *kpt_rt);
+
+void BKE_keyconfig_pref_type_init(void);
+void BKE_keyconfig_pref_type_free(void);
+
+#endif  /* __BKE_KEYCONFIG_H__ */
diff --git a/source/blender/blenkernel/CMakeLists.txt b/source/blender/blenkernel/CMakeLists.txt
index 4161a5ecd79..7d09374c99e 100644
--- a/source/blender/blenkernel/CMakeLists.txt
+++ b/source/blender/blenkernel/CMakeLists.txt
@@ -128,6 +128,7 @@ set(SRC
 	intern/image_gen.c
 	intern/ipo.c
 	intern/key.c
+	intern/keyconfig.c
 	intern/lamp.c
 	intern/lattice.c
 	intern/library.c
@@ -280,6 +281,7 @@ set(SRC
 	BKE_image.h
 	BKE_ipo.h
 	BKE_key.h
+	BKE_keyconfig.h
 	BKE_lamp.h
 	BKE_lattice.h
 	BKE_library.h
diff --git a/source/blender/blenkernel/intern/blender.c b/source/blender/blenkernel/intern/blender.c
index d0dea75860e..b90d4fd3948 100644
--- a/source/blender/blenkernel/intern/blender.c
+++ b/source/blender/blenkernel/intern/blender.c
@@ -208,6 +208,17 @@ static void userdef_free_keymaps(UserDef *userdef)
 	BLI_listbase_clear(&userdef->user_keymaps);
 }
 
+static void userdef_free_keyconfig_prefs(UserDef *userdef)
+{
+	for (wmKeyConfigPrefType *kpt = userdef->user_keyconfig_prefs.first, *kpt_next; kpt; kpt = kpt_next) {
+		kpt_next = kpt->next;
+		IDP_FreeProperty(kpt->prop);
+		MEM_freeN(kpt->prop);
+		MEM_freeN(kpt);
+	}
+	BLI_listbase_clear(&userdef->user_keyconfig_prefs);
+}
+
 static void userdef_free_user_menus(UserDef *userdef)
 {
 	for (bUserMenu *um = userdef->user_menus.first, *um_next; um; um = um_next) {
@@ -237,6 +248,7 @@ void BKE_blender_userdef_data_free(UserDef *userdef, bool clear_fonts)
 #endif
 
 	userdef_free_keymaps(userdef);
+	userdef_free_keyconfig_prefs(userdef);
 	userdef_free_user_menus(userdef);
 	userdef_free_addons(userdef);
 
diff --git a/source/blender/blenkernel/intern/keyconfig.c b/source/blender/blenkernel/intern/keyconfig.c
new file mode 100644
index 00000000000..46b82569f47
--- /dev/null
+++ b/source/blender/blenkernel/intern/keyconfig.c
@@ -0,0 +1,93 @@
+/*
+ * ***** 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/blenkernel/intern/keyconfig.c
+ *  \ingroup bke
+ */
+
+#include <stddef.h>
+#include <stdlib.h>
+
+#include "RNA_types.h"
+
+#include "BLI_utildefines.h"
+#include "BLI_ghash.h"
+
+#include "DNA_listBase.h"
+
+#include "BKE_keyconfig.h"  /* own include */
+
+#include "MEM_guardedalloc.h"
+
+/* -------------------------------------------------------------------- */
+/** \name Key-Config Preference API
+ *
+ * \see #BKE_addon_pref_type_init for logic this is bases on.
+ * \{ */
+
+static GHash *global_keyconfigpreftype_hash = NULL;
+
+
+wmKeyConfigPrefType_Runtime *BKE_keyconfig_pref_type_find(const char *idname, bool quiet)
+{
+	if (idname[0]) {
+		wmKeyConfigPrefType_Runtime *kpt_rt;
+
+		kpt_rt = BLI_ghash_lookup(global_keyconfigpreftype_hash, idname);
+		if (kpt_rt) {
+			return kpt_rt;
+		}
+
+		if (!quiet) {
+			printf("search for unknown keyconfig-pref '%s'\n", idname);
+		}
+	}
+	else {
+		if (!quiet) {
+			printf("search for empty keyconfig-pref\n");
+		}
+	}
+
+	return NULL;
+}
+
+void BKE_keyconfig_pref_type_add(wmKeyConfigPrefType_Runtime *kpt_rt)
+{
+	BLI_ghash_insert(global_keyconfigpreftype_hash, kpt_rt->idname, kpt_rt);
+}
+
+void BKE_keyconfig_pref_type_remove(const wmKeyConfigPrefType_Runtime *kpt_rt)
+{
+	BLI_ghash_remove(global_keyconfigpreftype_hash, kpt_rt->idname, NULL, MEM_freeN);
+}
+
+void BKE_keyconfig_pref_type_init(void)
+{
+	BLI_assert(global_keyconfigpreftype_hash == NULL);
+	global_keyconfigpreftype_hash = BLI_ghash_str_new(__func__);
+}
+
+void BKE_keyconfig_pref_type_free(void)
+{
+	BLI_ghash_free(global_keyconfigpreftype_hash, NULL, MEM_freeN);
+	global_keyconfigpreftype_hash = NULL;
+}
+
+/** \} */