CapsLock as a modifier key; adding a modifier mapping table

IssueID #87

7 files changed, 117 insertions, 36 deletions

diff --git a/src/ui/documentwidget.c b/src/ui/documentwidget.c
index 0af022c5..242afe30 100644
--- a/src/ui/documentwidget.c
+++ b/src/ui/documentwidget.c
@@ -2270,7 +2270,7 @@ static iBool processEvent_DocumentWidget_(iDocumentWidget *d, const SDL_Event *e
                         postCommandf_App("open newtab:%d url:%s",
                                          d->ordinalMode ==
                                                  numbersAndAlphabet_DocumentLinkOrdinalMode
-                                             ? openTabMode_Sym(SDL_GetModState())
+                                             ? openTabMode_Sym(modState_Keys())
                                              : (d->flags & newTabViaHomeKeys_DocumentWidgetFlag ? 1 : 0),
                                          cstr_String(absoluteUrl_String(
                                              d->mod.url, linkUrl_GmDocument(d->doc, run->linkId))));
@@ -2352,7 +2352,7 @@ static iBool processEvent_DocumentWidget_(iDocumentWidget *d, const SDL_Event *e
 #else
             const int amount = ev->wheel.y;
 #endif
-            if (keyMods_Sym(SDL_GetModState()) == KMOD_PRIMARY) {
+            if (keyMods_Sym(modState_Keys()) == KMOD_PRIMARY) {
                 postCommandf_App("zoom.delta arg:%d", amount > 0 ? 10 : -10);
                 return iTrue;
             }
@@ -2397,7 +2397,7 @@ static iBool processEvent_DocumentWidget_(iDocumentWidget *d, const SDL_Event *e
         }
         if (ev->button.button == SDL_BUTTON_MIDDLE && d->hoverLink) {
             postCommandf_App("open newtab:%d url:%s",
-                             SDL_GetModState() & KMOD_SHIFT ? 1 : 2,
+                             modState_Keys() & KMOD_SHIFT ? 1 : 2,
                              cstr_String(linkUrl_GmDocument(d->doc, d->hoverLink->linkId)));
             return iTrue;
         }
@@ -2634,7 +2634,7 @@ static iBool processEvent_DocumentWidget_(iDocumentWidget *d, const SDL_Event *e
                     }
                     else if (linkFlags & supportedProtocol_GmLinkFlag) {
                         postCommandf_App("open newtab:%d url:%s",
-                                         openTabMode_Sym(SDL_GetModState()),
+                                         openTabMode_Sym(modState_Keys()),
                                          cstr_String(absoluteUrl_String(
                                              d->mod.url, linkUrl_GmDocument(d->doc, linkId))));
                     }
diff --git a/src/ui/inputwidget.c b/src/ui/inputwidget.c
index 600a4462..dd8fa744 100644
--- a/src/ui/inputwidget.c
+++ b/src/ui/inputwidget.c
@@ -377,7 +377,7 @@ iLocalDef size_t cursorMax_InputWidget_(const iInputWidget *d) {
 }
 
 iLocalDef iBool isMarking_(void) {
-    return (SDL_GetModState() & KMOD_SHIFT) != 0;
+    return (modState_Keys() & KMOD_SHIFT) != 0;
 }
 
 void setCursor_InputWidget(iInputWidget *d, size_t pos) {
diff --git a/src/ui/keys.c b/src/ui/keys.c
index 4aa42d36..ce80d9f0 100644
--- a/src/ui/keys.c
+++ b/src/ui/keys.c
@@ -27,6 +27,67 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
 #include <the_Foundation/file.h>
 #include <the_Foundation/path.h>
 #include <the_Foundation/ptrset.h>
+#include <SDL_keyboard.h>
+
+enum iModMap {
+    none_ModMap,
+    leftShift_ModMap,
+    leftControl_ModMap,
+    leftAlt_ModMap,
+    leftGui_ModMap,
+    rightShift_ModMap,
+    rightControl_ModMap,
+    rightAlt_ModMap,
+    rightGui_ModMap,
+    capsLock_ModMap,
+    max_ModMap
+};
+
+static int modMap_[max_ModMap];
+static iBool capsLockDown_;
+
+static void init_ModMap_(void) {
+    for (int i = 0; i < max_ModMap; i++) {
+        modMap_[i] = i;
+    }
+}
+
+int mapMods_Keys(int modFlags) {
+    static const int bits[max_ModMap] = {
+        0,
+        KMOD_LSHIFT,
+        KMOD_LCTRL,
+        KMOD_LALT,
+        KMOD_LGUI,
+        KMOD_RSHIFT,
+        KMOD_RCTRL,
+        KMOD_RALT,
+        KMOD_RGUI,
+        KMOD_CAPS,
+    };
+    int mapped = 0;
+    /* Treat capslock as a modifier key. */
+    modFlags |= (capsLockDown_ ? KMOD_CAPS : 0);
+    for (int i = 0; i < max_ModMap; ++i) {
+        if (modFlags & bits[i]) {
+            mapped |= bits[modMap_[i]];
+        }
+    }
+    return mapped;
+}
+
+int modState_Keys(void) {
+    int state = SDL_GetModState() & ~(KMOD_NUM | KMOD_MODE | KMOD_CAPS);
+    /* Treat capslock as a modifier key. */
+    if (capsLockDown_) state |= KMOD_CAPS;
+    return mapMods_Keys(state);
+}
+
+void setCapsLockDown_Keys(iBool isDown) {
+    capsLockDown_ = isDown;
+}
+
+/*----------------------------------------------------------------------------------------------*/
 
 iDeclareType(Keys)
 
@@ -64,35 +125,35 @@ enum iBindFlag {
 /* TODO: This indirection could be used for localization, although all UI strings
    would need to be similarly handled. */
 static const struct { int id; iMenuItem bind; int flags; } defaultBindings_[] = {
-    { 1,  { "Jump to top",               SDLK_HOME, 0,                  "scroll.top"         }, 0 },
-    { 2,  { "Jump to bottom",            SDLK_END, 0,                   "scroll.bottom"      }, 0 },
-    { 10, { "Scroll up",                 SDLK_UP, 0,                    "scroll.step arg:-1" }, argRepeat_BindFlag },
-    { 11, { "Scroll down",               SDLK_DOWN, 0,                  "scroll.step arg:1"  }, argRepeat_BindFlag },
-    { 20, { "Scroll up half a page",     SDLK_PAGEUP, 0,                "scroll.page arg:-1" }, argRepeat_BindFlag },
-    { 21, { "Scroll down half a page",   SDLK_PAGEDOWN, 0,              "scroll.page arg:1"  }, argRepeat_BindFlag },
-    { 30, { "Go back",                   navigateBack_KeyShortcut,      "navigate.back"      }, 0 },
-    { 31, { "Go forward",                navigateForward_KeyShortcut,   "navigate.forward"   }, 0 },
-    { 32, { "Go to parent directory",    navigateParent_KeyShortcut,    "navigate.parent"    }, 0 },
-    { 33, { "Go to site root",           navigateRoot_KeyShortcut,      "navigate.root"      }, 0 },
-    { 35, { "Reload page",               reload_KeyShortcut,            "document.reload"    }, 0 },
-    { 41, { "Open link via modifier key", SDLK_LALT, 0,                 "document.linkkeys arg:0" }, argRelease_BindFlag },
-    { 42, { "Open link via home row keys", 'f', 0,                      "document.linkkeys arg:1" }, 0 },
-    { 45, { "Open link in new tab via home row keys", 'f', KMOD_SHIFT,  "document.linkkeys arg:1 newtab:1" }, 0 },
-    { 46, { "Hover on link via home row keys", 'h', 0,                  "document.linkkeys arg:1 hover:1" }, 0 },
-    { 47, { "Next set of home row key links", '.', 0,                   "document.linkkeys more:1" }, 0 },
-    { 50, { "Add bookmark",              'd', KMOD_PRIMARY,             "bookmark.add"       }, 0 },
-    { 60, { "Find text on page",         'f', KMOD_PRIMARY,             "focus.set id:find.input" }, 0 },
-    { 70, { "Zoom in",                   SDLK_EQUALS, KMOD_PRIMARY,     "zoom.delta arg:10"  }, 0 },
-    { 71, { "Zoom out",                  SDLK_MINUS, KMOD_PRIMARY,      "zoom.delta arg:-10" }, 0 },
-    { 72, { "Reset zoom",                SDLK_0, KMOD_PRIMARY,          "zoom.set arg:100"   }, 0 },
+    { 1,  { "Jump to top",               SDLK_HOME, 0,                  "scroll.top"                        }, 0 },
+    { 2,  { "Jump to bottom",            SDLK_END, 0,                   "scroll.bottom"                     }, 0 },
+    { 10, { "Scroll up",                 SDLK_UP, 0,                    "scroll.step arg:-1"                }, argRepeat_BindFlag },
+    { 11, { "Scroll down",               SDLK_DOWN, 0,                  "scroll.step arg:1"                 }, argRepeat_BindFlag },
+    { 20, { "Scroll up half a page",     SDLK_PAGEUP, 0,                "scroll.page arg:-1"                }, argRepeat_BindFlag },
+    { 21, { "Scroll down half a page",   SDLK_PAGEDOWN, 0,              "scroll.page arg:1"                 }, argRepeat_BindFlag },
+    { 30, { "Go back",                   navigateBack_KeyShortcut,      "navigate.back"                     }, 0 },
+    { 31, { "Go forward",                navigateForward_KeyShortcut,   "navigate.forward"                  }, 0 },
+    { 32, { "Go to parent directory",    navigateParent_KeyShortcut,    "navigate.parent"                   }, 0 },
+    { 33, { "Go to site root",           navigateRoot_KeyShortcut,      "navigate.root"                     }, 0 },
+    { 35, { "Reload page",               reload_KeyShortcut,            "document.reload"                   }, 0 },
+    { 41, { "Open link via modifier key", SDLK_LALT, 0,                 "document.linkkeys arg:0"           }, argRelease_BindFlag },
+    { 42, { "Open link via home row keys", 'f', 0,                      "document.linkkeys arg:1"           }, 0 },
+    { 45, { "Open link in new tab via home row keys", 'f', KMOD_SHIFT,  "document.linkkeys arg:1 newtab:1"  }, 0 },
+    { 46, { "Hover on link via home row keys", 'h', 0,                  "document.linkkeys arg:1 hover:1"   }, 0 },
+    { 47, { "Next set of home row key links", '.', 0,                   "document.linkkeys more:1"          }, 0 },
+    { 50, { "Add bookmark",              'd', KMOD_PRIMARY,             "bookmark.add"                      }, 0 },
+    { 60, { "Find text on page",         'f', KMOD_PRIMARY,             "focus.set id:find.input"           }, 0 },
+    { 70, { "Zoom in",                   SDLK_EQUALS, KMOD_PRIMARY,     "zoom.delta arg:10"                 }, 0 },
+    { 71, { "Zoom out",                  SDLK_MINUS, KMOD_PRIMARY,      "zoom.delta arg:-10"                }, 0 },
+    { 72, { "Reset zoom",                SDLK_0, KMOD_PRIMARY,          "zoom.set arg:100"                  }, 0 },
 #if !defined (iPlatformApple) /* Ctrl-Cmd-F on macOS */
-    { 73, { "Toggle fullscreen mode",    SDLK_F11, 0,                   "window.fullscreen"  }, 0 },
+    { 73, { "Toggle fullscreen mode",    SDLK_F11, 0,                   "window.fullscreen"                 }, 0 },
 #endif
-    { 76, { "New tab",                   newTab_KeyShortcut,            "tabs.new"           }, 0 },
-    { 77, { "Close tab",                 closeTab_KeyShortcut,          "tabs.close"         }, 0 },
-    { 80, { "Previous tab",              prevTab_KeyShortcut,           "tabs.prev"          }, 0 },
-    { 81, { "Next tab",                  nextTab_KeyShortcut,           "tabs.next"          }, 0 },
-    { 100,{ "Toggle show URL on hover",  '/', KMOD_PRIMARY,             "prefs.hoverlink.toggle" }, 0 },
+    { 76, { "New tab",                   newTab_KeyShortcut,            "tabs.new"                          }, 0 },
+    { 77, { "Close tab",                 closeTab_KeyShortcut,          "tabs.close"                        }, 0 },
+    { 80, { "Previous tab",              prevTab_KeyShortcut,           "tabs.prev"                         }, 0 },
+    { 81, { "Next tab",                  nextTab_KeyShortcut,           "tabs.next"                         }, 0 },
+    { 100,{ "Toggle show URL on hover",  '/', KMOD_PRIMARY,             "prefs.hoverlink.toggle"            }, 0 },
     /* The following cannot currently be changed (built-in duplicates). */
     { 1000, { NULL, SDLK_SPACE, KMOD_SHIFT, "scroll.page arg:-1" }, argRepeat_BindFlag },
     { 1001, { NULL, SDLK_SPACE, 0, "scroll.page arg:1" }, argRepeat_BindFlag },
@@ -193,6 +254,7 @@ static const char *filename_Keys_ = "bindings.txt";
 
 void init_Keys(void) {
     iKeys *d = &keys_;
+    init_ModMap_();
     init_Array(&d->bindings, sizeof(iBinding));
     initCmp_PtrSet(&d->lookup, cmpPtr_Binding_);
     bindDefaults_();
@@ -227,6 +289,7 @@ void load_Keys(const char *saveDir) {
                     if (*m == 'a') bind->mods |= KMOD_ALT;
                     if (*m == 'c') bind->mods |= KMOD_CTRL;
                     if (*m == 'g') bind->mods |= KMOD_GUI;
+                    if (*m == 'k') bind->mods |= KMOD_CAPS;
                 }
             }
         }
@@ -250,6 +313,7 @@ void save_Keys(const char *saveDir) {
                 if (bind->mods & KMOD_ALT) appendChar_String(line, 'a');
                 if (bind->mods & KMOD_CTRL) appendChar_String(line, 'c');
                 if (bind->mods & KMOD_GUI) appendChar_String(line, 'g');
+                if (bind->mods & KMOD_CAPS) appendChar_String(line, 'k');
             }
             appendChar_String(line, '\n');
             write_File(f, &line->chars);
diff --git a/src/ui/keys.h b/src/ui/keys.h
index f6f0b465..90e33b7c 100644
--- a/src/ui/keys.h
+++ b/src/ui/keys.h
@@ -90,3 +90,7 @@ const iBinding *findCommand_Keys    (const char *command);
 
 iBool           processEvent_Keys   (const SDL_Event *);
 const iPtrArray *list_Keys          (void);
+
+int             mapMods_Keys        (int modFlags);
+int             modState_Keys       (void); /* current modifier key state */
+void            setCapsLockDown_Keys(iBool isDown);
diff --git a/src/ui/sidebarwidget.c b/src/ui/sidebarwidget.c
index 4e908f1e..4d3818bd 100644
--- a/src/ui/sidebarwidget.c
+++ b/src/ui/sidebarwidget.c
@@ -33,6 +33,7 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
 #include "inputwidget.h"
 #include "labelwidget.h"
 #include "listwidget.h"
+#include "keys.h"
 #include "paint.h"
 #include "scrollwidget.h"
 #include "util.h"
@@ -605,14 +606,14 @@ static void itemClicked_SidebarWidget_(iSidebarWidget *d, const iSidebarItem *it
         }
         case feeds_SidebarMode: {
             postCommandString_App(
-                feedEntryOpenCommand_String(&item->url, openTabMode_Sym(SDL_GetModState())));
+                feedEntryOpenCommand_String(&item->url, openTabMode_Sym(modState_Keys())));
             break;
         }
         case bookmarks_SidebarMode:
         case history_SidebarMode: {
             if (!isEmpty_String(&item->url)) {
                 postCommandf_App("open newtab:%d url:%s",
-                                 openTabMode_Sym(SDL_GetModState()),
+                                 openTabMode_Sym(modState_Keys()),
                                  cstr_String(&item->url));
             }
             break;
diff --git a/src/ui/util.c b/src/ui/util.c
index 5fb3e9f3..934a6d9b 100644
--- a/src/ui/util.c
+++ b/src/ui/util.c
@@ -89,6 +89,9 @@ void toString_Sym(int key, int kmods, iString *str) {
         appendCStr_String(str, "Meta+");
     }
 #endif
+    if (kmods & KMOD_CAPS) {
+        appendCStr_String(str, "Caps+");
+    }
     if (key == 0x20) {
         appendCStr_String(str, "Space");
     }
@@ -120,7 +123,8 @@ void toString_Sym(int key, int kmods, iString *str) {
 
 iBool isMod_Sym(int key) {
     return key == SDLK_LALT || key == SDLK_RALT || key == SDLK_LCTRL || key == SDLK_RCTRL ||
-           key == SDLK_LGUI || key == SDLK_RGUI || key == SDLK_LSHIFT || key == SDLK_RSHIFT;
+           key == SDLK_LGUI || key == SDLK_RGUI || key == SDLK_LSHIFT || key == SDLK_RSHIFT ||
+           key == SDLK_CAPSLOCK;
 }
 
 int normalizedMod_Sym(int key) {
@@ -132,7 +136,7 @@ int normalizedMod_Sym(int key) {
 }
 
 int keyMods_Sym(int kmods) {
-    kmods &= (KMOD_SHIFT | KMOD_ALT | KMOD_CTRL | KMOD_GUI);
+    kmods &= (KMOD_SHIFT | KMOD_ALT | KMOD_CTRL | KMOD_GUI | KMOD_CAPS);
     /* Don't treat left/right modifiers differently. */
     if (kmods & KMOD_SHIFT) kmods |= KMOD_SHIFT;
     if (kmods & KMOD_ALT)   kmods |= KMOD_ALT;
diff --git a/src/ui/window.c b/src/ui/window.c
index 3518d97e..cbcca902 100644
--- a/src/ui/window.c
+++ b/src/ui/window.c
@@ -1532,6 +1532,7 @@ static iBool handleWindowEvent_Window_(iWindow *d, const SDL_WindowEvent *ev) {
             return iTrue;
         case SDL_WINDOWEVENT_FOCUS_GAINED:
             d->focusGainedAt = SDL_GetTicks();
+            setCapsLockDown_Keys(iFalse);
             postCommand_App("window.focus.gained");
             return iFalse;
         case SDL_WINDOWEVENT_FOCUS_LOST:
@@ -1593,6 +1594,13 @@ iBool processEvent_Window(iWindow *d, const SDL_Event *ev) {
                    As a workaround, ignore these events. */
                 return iTrue; /* won't go to bindings, either */
             }
+            /* Apply keyboard modifier mapping. */
+            if (event.type == SDL_KEYDOWN || event.type == SDL_KEYUP) {
+                if (event.key.keysym.sym == SDLK_CAPSLOCK) {
+                    setCapsLockDown_Keys(event.key.state == SDL_PRESSED);
+                }
+                event.key.keysym.mod = mapMods_Keys(event.key.keysym.mod & ~KMOD_CAPS);
+            }
             if (event.type == SDL_MOUSEBUTTONDOWN && d->ignoreClick) {
                 d->ignoreClick = iFalse;
                 return iTrue;