6815021f3f
Multiple keymaps may be added in either Gertty itself or in config files, individual keys may be overriden in the standard map, and the map can be selected via config file or command line option just as palettes are. Change the help text to be dynamically generated based on the current keymap. Change-Id: I5f8e63897fab3aa14493465256b5d4516cf47dcd
163 lines
4.5 KiB
Python
163 lines
4.5 KiB
Python
# Copyright 2014 OpenStack Foundation
|
|
# Copyright 2014 Hewlett-Packard Development Company, L.P.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
import re
|
|
import string
|
|
|
|
import urwid
|
|
|
|
# urwid command map:
|
|
REDRAW_SCREEN = urwid.REDRAW_SCREEN
|
|
CURSOR_UP = urwid.CURSOR_UP
|
|
CURSOR_DOWN = urwid.CURSOR_DOWN
|
|
CURSOR_LEFT = urwid.CURSOR_LEFT
|
|
CURSOR_RIGHT = urwid.CURSOR_RIGHT
|
|
CURSOR_PAGE_UP = urwid.CURSOR_PAGE_UP
|
|
CURSOR_PAGE_DOWN = urwid.CURSOR_PAGE_DOWN
|
|
CURSOR_MAX_LEFT = urwid.CURSOR_MAX_LEFT
|
|
CURSOR_MAX_RIGHT = urwid.CURSOR_MAX_RIGHT
|
|
ACTIVATE = urwid.ACTIVATE
|
|
# Global gertty commands:
|
|
PREV_SCREEN = 'previous screen'
|
|
HELP = 'help'
|
|
QUIT = 'quit'
|
|
CHANGE_SEARCH = 'change search'
|
|
# Change screen:
|
|
TOGGLE_REVIEWED = 'toggle reviewed'
|
|
TOGGLE_HIDDEN = 'toggle hidden'
|
|
REVIEW = 'review'
|
|
DIFF = 'diff'
|
|
CHECKOUT = 'checkout'
|
|
CHERRY_PICK = 'cherry pick'
|
|
SEARCH_RESULTS = 'search results'
|
|
NEXT_CHANGE = 'next change'
|
|
PREV_CHANGE = 'previous change'
|
|
TOGGLE_HIDDEN_COMMENTS = 'toggle hidden comments'
|
|
REFRESH = 'refresh'
|
|
# Project list screen:
|
|
TOGGLE_LIST_REVIEWED = 'toggle list reviewed'
|
|
TOGGLE_LIST_SUBSCRIBED = 'toggle list subscribed'
|
|
TOGGLE_SUBSCRIBED = 'toggle subscribed'
|
|
# Diff screens:
|
|
SELECT_PATCHSETS = 'select patchsets'
|
|
NEXT_SELECTABLE = 'next selectable'
|
|
PREV_SELECTABLE = 'prev selectable'
|
|
|
|
DEFAULT_KEYMAP = {
|
|
REDRAW_SCREEN: 'ctrl l',
|
|
CURSOR_UP: 'up',
|
|
CURSOR_DOWN: 'down',
|
|
CURSOR_LEFT: 'left',
|
|
CURSOR_RIGHT: 'right',
|
|
CURSOR_PAGE_UP: 'page up',
|
|
CURSOR_PAGE_DOWN: 'page down',
|
|
CURSOR_MAX_LEFT: 'home',
|
|
CURSOR_MAX_RIGHT: 'end',
|
|
ACTIVATE: 'enter',
|
|
|
|
PREV_SCREEN: 'esc',
|
|
HELP: ['f1', 'h'],
|
|
QUIT: 'ctrl q',
|
|
CHANGE_SEARCH: 'ctrl o',
|
|
|
|
TOGGLE_REVIEWED: 'v',
|
|
TOGGLE_HIDDEN: 'k',
|
|
REVIEW: 'r',
|
|
DIFF: 'd',
|
|
CHECKOUT: 'c',
|
|
CHERRY_PICK: 'x',
|
|
SEARCH_RESULTS: 'u',
|
|
NEXT_CHANGE: 'n',
|
|
PREV_CHANGE: 'p',
|
|
TOGGLE_HIDDEN_COMMENTS: 't',
|
|
REFRESH: 'ctrl r',
|
|
|
|
TOGGLE_LIST_REVIEWED: 'l',
|
|
TOGGLE_LIST_SUBSCRIBED: 'L',
|
|
TOGGLE_SUBSCRIBED: 's',
|
|
|
|
SELECT_PATCHSETS: 'p',
|
|
NEXT_SELECTABLE: 'tab',
|
|
PREV_SELECTABLE: 'shift tab',
|
|
}
|
|
|
|
URWID_COMMANDS = frozenset((
|
|
urwid.REDRAW_SCREEN,
|
|
urwid.CURSOR_UP,
|
|
urwid.CURSOR_DOWN,
|
|
urwid.CURSOR_LEFT,
|
|
urwid.CURSOR_RIGHT,
|
|
urwid.CURSOR_PAGE_UP,
|
|
urwid.CURSOR_PAGE_DOWN,
|
|
urwid.CURSOR_MAX_LEFT,
|
|
urwid.CURSOR_MAX_RIGHT,
|
|
urwid.ACTIVATE,
|
|
))
|
|
|
|
FORMAT_SUBS = (
|
|
(re.compile('ctrl '), 'CTRL-'),
|
|
(re.compile('meta '), 'META-'),
|
|
(re.compile('f(\d+)'), 'F\\1'),
|
|
(re.compile('([a-z][a-z]+)'), lambda x: string.upper(x.group(1))),
|
|
)
|
|
|
|
def formatKey(key):
|
|
for subre, repl in FORMAT_SUBS:
|
|
key = subre.sub(repl, key)
|
|
return key
|
|
|
|
class KeyMap(object):
|
|
def __init__(self, config):
|
|
# key -> [commands]
|
|
self.keymap = {}
|
|
self.commandmap = {}
|
|
self.update(DEFAULT_KEYMAP)
|
|
self.update(config)
|
|
|
|
def update(self, config):
|
|
# command -> [keys]
|
|
for command, keys in config.items():
|
|
if command == 'name':
|
|
continue
|
|
if type(keys) != type([]):
|
|
keys = [keys]
|
|
self.commandmap[command] = keys
|
|
self.keymap = {}
|
|
for command, keys in self.commandmap.items():
|
|
for key in keys:
|
|
if key in self.keymap:
|
|
self.keymap[key].append(command)
|
|
else:
|
|
self.keymap[key] = [command]
|
|
|
|
def getCommands(self, key):
|
|
return self.keymap.get(key, [])
|
|
|
|
def getKeys(self, command):
|
|
return self.commandmap.get(command, [])
|
|
|
|
def updateCommandMap(self):
|
|
"Update the urwid command map with this keymap"
|
|
for key, commands in self.keymap.items():
|
|
for command in commands:
|
|
command = command.replace('-', ' ')
|
|
if command in URWID_COMMANDS:
|
|
urwid.command_map[key]=command
|
|
|
|
def formatKeys(self, command):
|
|
keys = self.getKeys(command)
|
|
keys = [formatKey(k) for k in keys]
|
|
return ' or '.join(keys)
|