242 lines
8.1 KiB
Python
242 lines
8.1 KiB
Python
# Copyright 2014 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
|
|
#
|
|
# This file is part of qutebrowser.
|
|
#
|
|
# qutebrowser 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 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# qutebrowser 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 qutebrowser. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
"""Parse keypresses/keychains in the main window."""
|
|
|
|
import re
|
|
import logging
|
|
|
|
from PyQt5.QtCore import pyqtSignal, Qt, QObject
|
|
from PyQt5.QtGui import QKeySequence
|
|
|
|
from qutebrowser.commands.utils import (CommandParser, ArgumentCountError,
|
|
NoSuchCommandError)
|
|
|
|
# Possible chars for starting a commandline input
|
|
startchars = ":/?"
|
|
|
|
|
|
class KeyParser(QObject):
|
|
|
|
"""Parser for vim-like key sequences.
|
|
|
|
Attributes:
|
|
commandparser: Commandparser instance.
|
|
_keystring: The currently entered key sequence
|
|
_bindings: Bound keybindings
|
|
_modifier_bindings: Bound modifier bindings.
|
|
|
|
Signals:
|
|
set_cmd_text: Emitted when the statusbar should set a partial command.
|
|
arg: Text to set.
|
|
keystring_updated: Emitted when the keystring is updated.
|
|
arg: New keystring.
|
|
|
|
"""
|
|
|
|
set_cmd_text = pyqtSignal(str)
|
|
keystring_updated = pyqtSignal(str)
|
|
|
|
MATCH_PARTIAL = 0
|
|
MATCH_DEFINITIVE = 1
|
|
MATCH_NONE = 2
|
|
|
|
def __init__(self, mainwindow):
|
|
super().__init__(mainwindow)
|
|
self.commandparser = CommandParser()
|
|
self._keystring = ''
|
|
self._bindings = {}
|
|
self._modifier_bindings = {}
|
|
|
|
def from_config_sect(self, sect):
|
|
"""Load keybindings from a ConfigParser section.
|
|
|
|
Config format: key = command, e.g.:
|
|
gg = scrollstart
|
|
|
|
"""
|
|
for (key, cmd) in sect.items():
|
|
if key.startswith('@') and key.endswith('@'):
|
|
# normalize keystring
|
|
keystr = self._normalize_keystr(key.strip('@'))
|
|
logging.debug('registered mod key: {} -> {}'.format(keystr,
|
|
cmd))
|
|
self._modifier_bindings[keystr] = cmd
|
|
else:
|
|
logging.debug('registered key: {} -> {}'.format(key, cmd))
|
|
self._bindings[key] = cmd
|
|
|
|
def handle(self, e):
|
|
"""Handle a new keypress and call the respective handlers.
|
|
|
|
e -- the KeyPressEvent from Qt
|
|
|
|
"""
|
|
handled = self._handle_modifier_key(e)
|
|
if not handled:
|
|
self._handle_single_key(e)
|
|
self.keystring_updated.emit(self._keystring)
|
|
|
|
def _handle_modifier_key(self, e):
|
|
"""Handle a new keypress with modifiers.
|
|
|
|
Return True if the keypress has been handled, and False if not.
|
|
|
|
e -- the KeyPressEvent from Qt
|
|
|
|
"""
|
|
MODMASK2STR = {
|
|
Qt.ControlModifier: 'Ctrl',
|
|
Qt.AltModifier: 'Alt',
|
|
Qt.MetaModifier: 'Meta',
|
|
Qt.ShiftModifier: 'Shift'
|
|
}
|
|
if e.key() in [Qt.Key_Control, Qt.Key_Alt, Qt.Key_Shift, Qt.Key_Meta]:
|
|
# Only modifier pressed
|
|
return False
|
|
mod = e.modifiers()
|
|
modstr = ''
|
|
if not mod & (Qt.ControlModifier | Qt.AltModifier | Qt.MetaModifier):
|
|
# won't be a shortcut with modifiers
|
|
return False
|
|
for (mask, s) in MODMASK2STR.items():
|
|
if mod & mask:
|
|
modstr += s + '+'
|
|
keystr = QKeySequence(e.key()).toString()
|
|
try:
|
|
cmdstr = self._modifier_bindings[modstr + keystr]
|
|
except KeyError:
|
|
logging.debug('No binding found for {}.'.format(modstr + keystr))
|
|
return True
|
|
self._run_or_fill(cmdstr, ignore_exc=False)
|
|
return True
|
|
|
|
def _handle_single_key(self, e):
|
|
"""Handle a new keypress with a single key (no modifiers).
|
|
|
|
Separate the keypress into count/command, then check if it matches
|
|
any possible command, and either run the command, ignore it, or
|
|
display an error.
|
|
|
|
e -- the KeyPressEvent from Qt.
|
|
|
|
"""
|
|
# FIXME maybe we can do this in an easier way by using QKeySeqyence
|
|
# which has a matches method.
|
|
logging.debug('Got key: {} / text: "{}"'.format(e.key(), e.text()))
|
|
txt = e.text().strip()
|
|
if not txt:
|
|
logging.debug('Ignoring, no text')
|
|
return
|
|
|
|
self._keystring += txt
|
|
|
|
if any(self._keystring == c for c in startchars):
|
|
self.set_cmd_text.emit(self._keystring)
|
|
self._keystring = ''
|
|
return
|
|
|
|
(countstr, cmdstr_needle) = re.match(r'^(\d*)(.*)',
|
|
self._keystring).groups()
|
|
|
|
if not cmdstr_needle:
|
|
return
|
|
|
|
# FIXME this doesn't handle ambigious keys correctly.
|
|
#
|
|
# If a keychain is ambigious, we probably should set up a QTimer with a
|
|
# configurable timeout, which triggers cmd.run() when expiring. Then
|
|
# when we enter _handle() again in time we stop the timer.
|
|
|
|
(match, cmdstr_hay) = self._match_key(cmdstr_needle)
|
|
|
|
if match == self.MATCH_DEFINITIVE:
|
|
pass
|
|
elif match == self.MATCH_PARTIAL:
|
|
logging.debug('No match for "{}" (added {})'.format(
|
|
self._keystring, txt))
|
|
return
|
|
elif match == self.MATCH_NONE:
|
|
logging.debug('Giving up with "{}", no matches'.format(
|
|
self._keystring))
|
|
self._keystring = ''
|
|
return
|
|
|
|
self._keystring = ''
|
|
count = int(countstr) if countstr else None
|
|
self._run_or_fill(cmdstr_hay, count=count, ignore_exc=False)
|
|
return
|
|
|
|
def _match_key(self, cmdstr_needle):
|
|
"""Try to match a given keystring with any bound keychain.
|
|
|
|
cmdstr_needle: The command string to find.
|
|
|
|
"""
|
|
try:
|
|
cmdstr_hay = self._bindings[cmdstr_needle]
|
|
return (self.MATCH_DEFINITIVE, cmdstr_hay)
|
|
except KeyError:
|
|
# No definitive match, check if there's a chance of a partial match
|
|
for hay in self._bindings:
|
|
try:
|
|
if cmdstr_needle[-1] == hay[len(cmdstr_needle) - 1]:
|
|
return (self.MATCH_PARTIAL, None)
|
|
except IndexError:
|
|
# current cmd is shorter than our cmdstr_needle, so it
|
|
# won't match
|
|
continue
|
|
# no definitive and no partial matches if we arrived here
|
|
return (self.MATCH_NONE, None)
|
|
|
|
def _normalize_keystr(self, keystr):
|
|
"""Normalize a keystring like Ctrl-Q to a keystring like Ctrl+Q.
|
|
|
|
keystr -- The key combination as a string.
|
|
|
|
"""
|
|
replacements = [
|
|
('Control', 'Ctrl'),
|
|
('Windows', 'Meta'),
|
|
('Mod1', 'Alt'),
|
|
('Mod4', 'Meta'),
|
|
]
|
|
for (orig, repl) in replacements:
|
|
keystr = keystr.replace(orig, repl)
|
|
for mod in ['Ctrl', 'Meta', 'Alt', 'Shift']:
|
|
keystr = keystr.replace(mod + '-', mod + '+')
|
|
keystr = QKeySequence(keystr).toString()
|
|
return keystr
|
|
|
|
def _run_or_fill(self, cmdstr, count=None, ignore_exc=True):
|
|
"""Run the command in cmdstr or fill the statusbar if args missing.
|
|
|
|
cmdstr -- The command string.
|
|
count -- Optional command count.
|
|
ignore_exc -- Ignore exceptions.
|
|
|
|
"""
|
|
try:
|
|
self.commandparser.run(cmdstr, count=count, ignore_exc=ignore_exc)
|
|
except NoSuchCommandError:
|
|
pass
|
|
except ArgumentCountError:
|
|
logging.debug('Filling statusbar with partial command {}'.format(
|
|
cmdstr))
|
|
self.set_cmd_text.emit(':{} '.format(cmdstr))
|
|
return
|