From 7bfea773db46a87835741d536b0edc39008c9547 Mon Sep 17 00:00:00 2001
From: Ryan Roden-Corrent <ryan@rcorre.net>
Date: Mon, 11 Apr 2016 23:18:09 -0400
Subject: [PATCH] Add set_mark and jump_mark modes.

These modes use a custom handler to pass whatever the next keypress is
to either set_mark or jump_mark.
---
 qutebrowser/keyinput/modeman.py     |  2 ++
 qutebrowser/keyinput/modeparsers.py | 47 +++++++++++++++++++++++++++--
 qutebrowser/utils/usertypes.py      |  3 +-
 3 files changed, 49 insertions(+), 3 deletions(-)

diff --git a/qutebrowser/keyinput/modeman.py b/qutebrowser/keyinput/modeman.py
index fb948ec18..11156e4e4 100644
--- a/qutebrowser/keyinput/modeman.py
+++ b/qutebrowser/keyinput/modeman.py
@@ -78,6 +78,8 @@ def init(win_id, parent):
                                                   warn=False),
         KM.yesno: modeparsers.PromptKeyParser(win_id, modeman),
         KM.caret: modeparsers.CaretKeyParser(win_id, modeman),
+        KM.set_mark: modeparsers.MarkKeyParser(win_id, KM.set_mark, modeman),
+        KM.jump_mark: modeparsers.MarkKeyParser(win_id, KM.jump_mark, modeman),
     }
     objreg.register('keyparsers', keyparsers, scope='window', window=win_id)
     modeman.destroyed.connect(
diff --git a/qutebrowser/keyinput/modeparsers.py b/qutebrowser/keyinput/modeparsers.py
index 7ad622114..73abf2110 100644
--- a/qutebrowser/keyinput/modeparsers.py
+++ b/qutebrowser/keyinput/modeparsers.py
@@ -25,9 +25,9 @@ Module attributes:
 
 from PyQt5.QtCore import pyqtSlot, Qt
 
-from qutebrowser.utils import message
+from qutebrowser.utils import utils, message
 from qutebrowser.config import config
-from qutebrowser.keyinput import keyparser
+from qutebrowser.keyinput import keyparser, modeman
 from qutebrowser.utils import usertypes, log, objreg, utils
 
 
@@ -230,3 +230,46 @@ class CaretKeyParser(keyparser.CommandKeyParser):
         super().__init__(win_id, parent, supports_count=True,
                          supports_chains=True)
         self.read_config('caret')
+
+class MarkKeyParser(keyparser.CommandKeyParser):
+
+    """KeyParser for set_mark and jump_mark mode.
+
+       Attributes:
+           _mode: Either KeyMode.set_mark or KeyMode.jump_mark.
+    """
+
+    def __init__(self, win_id, mode, parent=None):
+        super().__init__(win_id, parent, supports_count=False,
+                         supports_chains=False)
+        self._mode = mode
+
+    def handle(self, e):
+        """Override handle to always match the next key and create a mark
+
+        Args:
+            e: the KeyPressEvent from Qt.
+
+        Return:
+            True if event has been handled, False otherwise.
+        """
+
+        if utils.keyevent_to_string(e) is None:
+            # this is a modifier key, let it pass and keep going
+            return True;
+
+        if not e.text().isalpha() and e.text() != "'":
+            # only valid mark names are [a-zA-Z']
+            message.error(self._win_id, e.text() + " isn't a valid mark")
+            return True
+
+        if self._mode == usertypes.KeyMode.set_mark:
+            self._commandrunner.run('set-mark "{}"'.format(e.text()))
+        elif self._mode == usertypes.KeyMode.jump_mark:
+            self._commandrunner.run('jump-mark "{}"'.format(e.text()))
+        else:
+            raise ValueError("{} is not a valid mark mode".format(mode))
+
+        modeman.leave(self._win_id, self._mode, "valid mark key")
+
+        return True
diff --git a/qutebrowser/utils/usertypes.py b/qutebrowser/utils/usertypes.py
index 5e29ee535..0af42b291 100644
--- a/qutebrowser/utils/usertypes.py
+++ b/qutebrowser/utils/usertypes.py
@@ -231,7 +231,8 @@ ClickTarget = enum('ClickTarget', ['normal', 'tab', 'tab_bg', 'window'])
 
 # Key input modes
 KeyMode = enum('KeyMode', ['normal', 'hint', 'command', 'yesno', 'prompt',
-                           'insert', 'passthrough', 'caret'])
+                           'insert', 'passthrough', 'caret', 'set_mark',
+                           'jump_mark'])
 
 
 # Available command completions