qutebrowser/qutebrowser/utils/completer.py

230 lines
8.2 KiB
Python
Raw Normal View History

2014-06-19 09:04:37 +02:00
# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
2014-06-03 12:51:23 +02:00
# 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/>.
"""Completer attached to a CompletionView."""
2014-06-03 13:37:11 +02:00
from PyQt5.QtCore import pyqtSlot, pyqtSignal, QObject
2014-06-03 12:51:23 +02:00
2014-08-26 19:10:14 +02:00
from qutebrowser.config import config, configdata
from qutebrowser.commands import cmdutils
2014-09-26 15:48:24 +02:00
from qutebrowser.utils import usertypes, log, objreg, utils
2014-08-26 19:10:14 +02:00
from qutebrowser.models import completion as models
2014-06-03 12:51:23 +02:00
from qutebrowser.models.completionfilter import CompletionFilterModel as CFM
class Completer(QObject):
"""Completer which manages completions in a CompletionView.
Attributes:
_ignore_change: Whether to ignore the next completion update.
2014-06-03 12:51:23 +02:00
_models: dict of available completion models.
2014-06-03 13:37:11 +02:00
Signals:
change_completed_part: Text which should be substituted for the word
we're currently completing.
arg 0: The text to change to.
arg 1: True if the text should be set
immediately, without continuing
completing the current field.
2014-06-03 12:51:23 +02:00
"""
2014-06-03 13:37:11 +02:00
change_completed_part = pyqtSignal(str, bool)
def __init__(self, parent=None):
super().__init__(parent)
self._ignore_change = False
2014-06-03 12:51:23 +02:00
self._models = {
2014-08-26 19:10:14 +02:00
usertypes.Completion.option: {},
usertypes.Completion.value: {},
2014-06-03 12:51:23 +02:00
}
2014-09-08 06:57:22 +02:00
self._init_static_completions()
2014-06-03 12:51:23 +02:00
self._init_setting_completions()
2014-09-23 23:31:17 +02:00
def __repr__(self):
2014-09-26 15:48:24 +02:00
return utils.get_repr(self)
2014-09-23 23:31:17 +02:00
def _model(self):
"""Convienience method to get the current completion model."""
return objreg.get('completion').model()
2014-09-08 06:57:22 +02:00
def _init_static_completions(self):
"""Initialize the static completion models."""
2014-08-26 19:10:14 +02:00
self._models[usertypes.Completion.command] = CFM(
models.CommandCompletionModel(self), self)
2014-09-08 06:57:22 +02:00
self._models[usertypes.Completion.helptopic] = CFM(
models.HelpCompletionModel(self), self)
2014-06-03 12:51:23 +02:00
def _init_setting_completions(self):
"""Initialize setting completion models."""
2014-08-26 19:10:14 +02:00
self._models[usertypes.Completion.section] = CFM(
models.SettingSectionCompletionModel(self), self)
self._models[usertypes.Completion.option] = {}
self._models[usertypes.Completion.value] = {}
2014-06-04 07:16:48 +02:00
for sectname in configdata.DATA:
2014-08-26 19:10:14 +02:00
model = models.SettingOptionCompletionModel(sectname, self)
self._models[usertypes.Completion.option][sectname] = CFM(
model, self)
self._models[usertypes.Completion.value][sectname] = {}
for opt in configdata.DATA[sectname].keys():
2014-08-26 19:10:14 +02:00
model = models.SettingValueCompletionModel(sectname, opt, self)
self._models[usertypes.Completion.value][sectname][opt] = CFM(
2014-07-29 00:37:32 +02:00
model, self)
2014-06-03 12:51:23 +02:00
def _get_new_completion(self, parts, cursor_part):
"""Get a new completion model.
Args:
parts: The command chunks to get a completion for.
cursor_part: The part the cursor is over currently.
"""
if cursor_part == 0:
# '|' or 'set|'
2014-08-26 19:10:14 +02:00
return self._models[usertypes.Completion.command]
2014-06-03 12:51:23 +02:00
# delegate completion to command
try:
completions = cmdutils.cmd_dict[parts[0]].completion
except KeyError:
# entering an unknown command
return None
if completions is None:
# command without any available completions
return None
2014-07-29 00:37:32 +02:00
dbg_completions = [c.name for c in completions]
2014-06-03 12:51:23 +02:00
try:
idx = cursor_part - 1
2014-07-29 00:37:32 +02:00
completion = completions[idx]
2014-06-03 12:51:23 +02:00
except IndexError:
# More arguments than completions
2014-08-26 20:15:41 +02:00
log.completion.debug("completions: {}".format(
', '.join(dbg_completions)))
2014-06-03 12:51:23 +02:00
return None
2014-06-25 15:42:16 +02:00
dbg_completions[idx] = '*' + dbg_completions[idx] + '*'
2014-08-26 20:15:41 +02:00
log.completion.debug("completions: {}".format(
', '.join(dbg_completions)))
2014-08-26 19:10:14 +02:00
if completion == usertypes.Completion.option:
2014-06-03 12:51:23 +02:00
section = parts[cursor_part - 1]
2014-07-29 00:37:32 +02:00
model = self._models[completion].get(section)
2014-08-26 19:10:14 +02:00
elif completion == usertypes.Completion.value:
2014-06-03 12:51:23 +02:00
section = parts[cursor_part - 2]
option = parts[cursor_part - 1]
try:
2014-07-29 00:37:32 +02:00
model = self._models[completion][section][option]
2014-06-03 12:51:23 +02:00
except KeyError:
2014-06-20 23:26:19 +02:00
# No completion model for this section/option.
2014-06-03 12:51:23 +02:00
model = None
else:
2014-07-29 00:37:32 +02:00
model = self._models.get(completion)
2014-06-03 12:51:23 +02:00
return model
2014-06-03 12:59:50 +02:00
2014-09-08 07:35:18 +02:00
def _quote(self, s):
"""Quote s if it needs quoting for the commandline.
Note we don't use shlex.quote because that quotes a lot of shell
metachars we don't need to have quoted.
"""
if not s:
return "''"
elif any(c in s for c in ' \'\t\n\\'):
# use single quotes, and put single quotes into double quotes
# the string $'b is then quoted as '$'"'"'b'
return "'" + s.replace("'", "'\"'\"'") + "'"
else:
return s
2014-06-03 13:48:12 +02:00
def selection_changed(self, selected, _deselected):
2014-06-03 13:37:11 +02:00
"""Emit change_completed_part if a new item was selected.
Called from the views selectionChanged method.
Args:
selected: New selection.
2014-06-03 13:48:12 +02:00
_delected: Previous selection.
2014-06-03 13:37:11 +02:00
Emit:
change_completed_part: Emitted when there's data for the new item.
"""
indexes = selected.indexes()
if not indexes:
return
model = self._model()
2014-06-03 13:37:11 +02:00
data = model.data(indexes[0])
if data is None:
return
2014-09-08 07:35:18 +02:00
data = self._quote(data)
if model.count() == 1 and config.get('completion', 'quick-complete'):
2014-06-03 13:37:11 +02:00
# If we only have one item, we want to apply it immediately
# and go on to the next part.
self.change_completed_part.emit(data, True)
else:
self._ignore_change = True
2014-06-03 13:37:11 +02:00
self.change_completed_part.emit(data, False)
self._ignore_change = False
2014-06-03 13:37:11 +02:00
2014-06-03 12:59:50 +02:00
@pyqtSlot(str, list, int)
def on_update_completion(self, prefix, parts, cursor_part):
"""Check if completions are available and activate them.
Slot for the textChanged signal of the statusbar command widget.
Args:
text: The new text
cursor_part: The part the cursor is currently over.
"""
if self._ignore_change:
2014-08-26 20:15:41 +02:00
log.completion.debug("Ignoring completion update")
2014-06-03 12:59:50 +02:00
return
completion = objreg.get('completion')
2014-06-03 12:59:50 +02:00
if prefix != ':':
# This is a search or gibberish, so we don't need to complete
# anything (yet)
# FIXME complete searchs
completion.hide()
2014-06-03 12:59:50 +02:00
return
model = self._get_new_completion(parts, cursor_part)
if model != self._model():
if model is None:
completion.hide()
else:
completion.set_model(model)
if model is None:
2014-08-26 20:15:41 +02:00
log.completion.debug("No completion model for {}.".format(parts))
return
2014-06-03 12:59:50 +02:00
pattern = parts[cursor_part] if parts else ''
self._model().set_pattern(pattern)
2014-06-03 12:59:50 +02:00
2014-08-26 20:15:41 +02:00
log.completion.debug(
"New completion for {}: {}, with pattern '{}'".format(
parts, model.sourceModel().__class__.__name__, pattern))
2014-06-25 15:42:16 +02:00
if self._model().count() == 0:
completion.hide()
2014-06-03 12:59:50 +02:00
return
self._model().mark_all_items(pattern)
if completion.enabled:
completion.show()