From 03e83ff8e1373e2f35d51ad70497c455c251e3eb Mon Sep 17 00:00:00 2001
From: Florian Bruhin <git@the-compiler.org>
Date: Thu, 3 Jul 2014 06:51:24 +0200
Subject: [PATCH] Move key to string converting to utils.misc

---
 qutebrowser/keyinput/basekeyparser.py | 24 +++-----------
 qutebrowser/utils/misc.py             | 48 +++++++++++++++++++++++++--
 2 files changed, 50 insertions(+), 22 deletions(-)

diff --git a/qutebrowser/keyinput/basekeyparser.py b/qutebrowser/keyinput/basekeyparser.py
index a42eec854..51cc0653a 100644
--- a/qutebrowser/keyinput/basekeyparser.py
+++ b/qutebrowser/keyinput/basekeyparser.py
@@ -29,6 +29,7 @@ from PyQt5.QtGui import QKeySequence
 import qutebrowser.config.config as config
 from qutebrowser.utils.usertypes import enum, Timer
 from qutebrowser.utils.log import keyboard as logger
+from qutebrowser.utils.misc import keyevent_to_string
 
 
 class BaseKeyParser(QObject):
@@ -135,28 +136,11 @@ class BaseKeyParser(QObject):
         Return:
             True if event has been handled, False otherwise.
         """
-        modmask2str = {
-            Qt.ControlModifier: 'Ctrl',
-            Qt.AltModifier: 'Alt',
-            Qt.MetaModifier: 'Meta',
-            Qt.ShiftModifier: 'Shift'
-        }
-        modifiers = (Qt.Key_Control, Qt.Key_Alt, Qt.Key_Shift, Qt.Key_Meta,
-                     Qt.Key_AltGr, Qt.Key_Super_L, Qt.Key_Super_R,
-                     Qt.Key_Hyper_L, Qt.Key_Hyper_R)
-        if e.key() in modifiers:
-            # Only modifier pressed
-            return False
-        mod = e.modifiers()
-        modstr = ''
-        for (mask, s) in modmask2str.items():
-            if mod & mask:
-                modstr += s + '+'
-        keystr = QKeySequence(e.key()).toString().replace("Backtab", "Tab")
+        binding = keyevent_to_string(e)
         try:
-            cmdstr = self.special_bindings[modstr + keystr]
+            cmdstr = self.special_bindings[binding]
         except KeyError:
-            self._debug_log("No binding found for {}.".format(modstr + keystr))
+            self._debug_log("No binding found for {}.".format(binding))
             return False
         self.execute(cmdstr, self.Type.special)
         return True
diff --git a/qutebrowser/utils/misc.py b/qutebrowser/utils/misc.py
index 7f328f1fb..839b38b98 100644
--- a/qutebrowser/utils/misc.py
+++ b/qutebrowser/utils/misc.py
@@ -29,8 +29,8 @@ from urllib.parse import urljoin, urlencode
 from functools import reduce
 
 import rfc6266
-from PyQt5.QtCore import QCoreApplication, QStandardPaths
-from PyQt5.QtGui import QColor
+from PyQt5.QtCore import QCoreApplication, QStandardPaths, Qt
+from PyQt5.QtGui import QKeySequence, QColor
 from pkg_resources import resource_string
 
 import qutebrowser
@@ -342,3 +342,47 @@ def parse_content_disposition(reply):
     if not filename:
         filename = 'qutebrowser-download'
     return is_inline, os.path.basename(filename)
+
+
+def key_to_string(key):
+    """Convert a Qt::Key member to a meaningful name.
+
+    Args:
+        key: A Qt::Key member.
+
+    Return:
+        A name of the key as a string.
+    """
+    name = QKeySequence(key).toString().replace("Backtab", "Tab")
+    return name
+
+
+def keyevent_to_string(e):
+    """Convert a QKeyEvent to a meaningful name.
+
+    Args:
+        e: A QKeyEvent.
+
+    Return:
+        A name of the key (combination) as a string or
+        None if only modifiers are pressed..
+    """
+    modmask2str = {
+        Qt.ControlModifier: 'Ctrl',
+        Qt.AltModifier: 'Alt',
+        Qt.MetaModifier: 'Meta',
+        Qt.ShiftModifier: 'Shift'
+    }
+    modifiers = (Qt.Key_Control, Qt.Key_Alt, Qt.Key_Shift, Qt.Key_Meta,
+                 Qt.Key_AltGr, Qt.Key_Super_L, Qt.Key_Super_R,
+                 Qt.Key_Hyper_L, Qt.Key_Hyper_R)
+    if e.key() in modifiers:
+        # Only modifier pressed
+        return None
+    mod = e.modifiers()
+    parts = []
+    for (mask, s) in modmask2str.items():
+        if mod & mask:
+            parts.append(s)
+    parts.append(key_to_string(e.key()))
+    return '+'.join(parts)