KEYMAP REFACTORING

Diff Keymaps

User edited keymaps now no longer override the builtin keymaps entirely, but
rather save only the difference and reapply those changes. This means they can
stay better in sync when the builtin keymaps change. The diff/patch algorithm
is not perfect, but better for the common case where only a few items are changed
rather than entire keymaps The main weakness is that if a builtin keymap item
changes, user modification of that item may need to be redone in some cases.

Keymap Editor

The most noticeable change here is that there is no longer an "Edit" button for
keymaps, all are editable immediately, but a "Restore" buttons shows for keymaps
and items that have been edited. Shortcuts for addons can also be edited in the
keymap editor. 

Addons

Addons now should only modify the new addon keyconfiguration, the keymap items
there will be added to the builtin ones for handling events, and not get lost
when starting new files. Example code of register/unregister:

km = wm.keyconfigs.addon.keymaps.new("3D View", space_type="VIEW_3D")
km.keymap_items.new('my.operator', 'ESC', 'PRESS')

km = wm.keyconfigs.addon.keymaps["3D View"]
km.keymap_items.remove(km.keymap_items["my.operator"])

Compatibility

The changes made are not forward compatible, i.e. if you save user preferences
with newer versions, older versions will not have key configuration changes that
were made.

1 files changed, 20 insertions, 4 deletions

diff --git a/source/blender/makesdna/DNA_windowmanager_types.h b/source/blender/makesdna/DNA_windowmanager_types.h
index 31e59f18626..1f0ae28a00d 100644
--- a/source/blender/makesdna/DNA_windowmanager_types.h
+++ b/source/blender/makesdna/DNA_windowmanager_types.h
@@ -144,7 +144,9 @@ typedef struct wmWindowManager {
 	ListBase drags;			/* active dragged items */
 	
 	ListBase keyconfigs;				/* known key configurations */
-	struct wmKeyConfig *defaultconf;	/* default configuration, not saved */
+	struct wmKeyConfig *defaultconf;	/* default configuration */
+	struct wmKeyConfig *addonconf;		/* addon configuration */
+	struct wmKeyConfig *userconf;		/* user configuration */
 
 	ListBase timers;					/* active timers */
 	struct wmTimer *autosavetimer;		/* timer for auto save */
@@ -239,15 +241,26 @@ typedef struct wmKeyMapItem {
 	struct PointerRNA *ptr;			/* rna pointer to access properties */
 } wmKeyMapItem;
 
+/* used instead of wmKeyMapItem for diff keymaps */
+typedef struct wmKeyMapDiffItem {
+	struct wmKeyMapDiffItem *next, *prev;
+
+	wmKeyMapItem *remove_item;
+	wmKeyMapItem *add_item;
+} wmKeyMapDiffItem;
+
 /* wmKeyMapItem.flag */
-#define KMI_INACTIVE	1
-#define KMI_EXPANDED	2
+#define KMI_INACTIVE		1
+#define KMI_EXPANDED		2
+#define KMI_USER_MODIFIED	4
+#define KMI_UPDATE			8
 
 /* stored in WM, the actively used keymaps */
 typedef struct wmKeyMap {
 	struct wmKeyMap *next, *prev;
 	
 	ListBase items;
+	ListBase diff_items;
 	
 	char idname[64];	/* global editor keymaps, or for more per space/region */
 	short spaceid;		/* same IDs as in DNA_space_types.h */
@@ -263,9 +276,12 @@ typedef struct wmKeyMap {
 
 /* wmKeyMap.flag */
 #define KEYMAP_MODAL				1	/* modal map, not using operatornames */
-#define KEYMAP_USER					2	/* user created keymap */
+#define KEYMAP_USER					2	/* user keymap */
 #define KEYMAP_EXPANDED				4
 #define KEYMAP_CHILDREN_EXPANDED	8
+#define KEYMAP_DIFF					16	/* diff keymap for user preferences */
+#define KEYMAP_USER_MODIFIED		32	/* keymap has user modifications */
+#define KEYMAP_UPDATE				64
 
 typedef struct wmKeyConfig {
 	struct wmKeyConfig *next, *prev;