forked from zulip/zulip-terminal
-
Notifications
You must be signed in to change notification settings - Fork 0
/
keys.py
467 lines (447 loc) · 13.4 KB
/
keys.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
from collections import OrderedDict
from typing import List
from typing_extensions import TypedDict
from urwid.command_map import (
CURSOR_DOWN,
CURSOR_LEFT,
CURSOR_MAX_RIGHT,
CURSOR_PAGE_DOWN,
CURSOR_PAGE_UP,
CURSOR_RIGHT,
CURSOR_UP,
command_map,
)
class KeyBinding(TypedDict, total=False):
keys: List[str]
help_text: str
excluded_from_random_tips: bool
key_category: str
# fmt: off
KEY_BINDINGS: 'OrderedDict[str, KeyBinding]' = OrderedDict([
# Key that is displayed in the UI is determined by the method
# primary_key_for_command. (Currently the first key in the list)
('HELP', {
'keys': ['?'],
'help_text': 'Show/hide help menu',
'excluded_from_random_tips': True,
'key_category': 'general',
}),
('MARKDOWN_HELP', {
'keys': ['meta m'],
'help_text': 'Show/hide markdown help menu',
'key_category': 'general',
}),
('ABOUT', {
'keys': ['meta ?'],
'help_text': 'Show/hide about menu',
'key_category': 'general',
}),
('GO_BACK', {
'keys': ['esc'],
'help_text': 'Go Back',
'excluded_from_random_tips': False,
'key_category': 'general',
}),
('OPEN_DRAFT', {
'keys': ['d'],
'help_text': 'Open draft message saved in this session',
'key_category': 'general',
}),
('GO_UP', {
'keys': ['up', 'k'],
'help_text': 'Go up / Previous message',
'key_category': 'navigation',
}),
('GO_DOWN', {
'keys': ['down', 'j'],
'help_text': 'Go down / Next message',
'key_category': 'navigation',
}),
('GO_LEFT', {
'keys': ['left', 'h'],
'help_text': 'Go left',
'key_category': 'navigation',
}),
('GO_RIGHT', {
'keys': ['right', 'l'],
'help_text': 'Go right',
'key_category': 'navigation',
}),
('SCROLL_UP', {
'keys': ['page up', 'K'],
'help_text': 'Scroll up',
'key_category': 'navigation',
}),
('SCROLL_DOWN', {
'keys': ['page down', 'J'],
'help_text': 'Scroll down',
'key_category': 'navigation',
}),
('GO_TO_BOTTOM', {
'keys': ['end', 'G'],
'help_text': 'Go to bottom / Last message',
'key_category': 'navigation',
}),
('REPLY_MESSAGE', {
'keys': ['r', 'enter'],
'help_text': 'Reply to the current message',
'key_category': 'msg_actions',
}),
('MENTION_REPLY', {
'keys': ['@'],
'help_text': 'Reply mentioning the sender of the current message',
'key_category': 'msg_actions',
}),
('QUOTE_REPLY', {
'keys': ['>'],
'help_text': 'Reply quoting the current message text',
'key_category': 'msg_actions',
}),
('REPLY_AUTHOR', {
'keys': ['R'],
'help_text': 'Reply privately to the sender of the current message',
'key_category': 'msg_actions',
}),
('EDIT_MESSAGE', {
'keys': ['e'],
'help_text': "Edit message's content or topic",
'key_category': 'msg_actions'
}),
('STREAM_MESSAGE', {
'keys': ['c'],
'help_text': 'New message to a stream',
'key_category': 'msg_actions',
}),
('PRIVATE_MESSAGE', {
'keys': ['x'],
'help_text': 'New message to a person or group of people',
'key_category': 'msg_actions',
}),
('CYCLE_COMPOSE_FOCUS', {
'keys': ['tab'],
'help_text': 'Cycle through recipient and content boxes',
'key_category': 'msg_compose',
}),
('SEND_MESSAGE', {
'keys': ['ctrl d', 'meta enter'],
'help_text': 'Send a message',
'key_category': 'msg_compose',
}),
('SAVE_AS_DRAFT', {
'keys': ['meta s'],
'help_text': 'Save current message as a draft',
'key_category': 'msg_compose',
}),
('AUTOCOMPLETE', {
'keys': ['ctrl f'],
'help_text': ('Autocomplete @mentions, #stream_names, :emoji:'
' and topics'),
'key_category': 'msg_compose',
}),
('AUTOCOMPLETE_REVERSE', {
'keys': ['ctrl r'],
'help_text': 'Cycle through autocomplete suggestions in reverse',
'key_category': 'msg_compose',
}),
('ADD_REACTION', {
'keys': [':'],
'help_text': 'Show/hide Emoji picker popup for current message',
'key_category': 'msg_actions',
}),
('STREAM_NARROW', {
'keys': ['s'],
'help_text': 'Narrow to the stream of the current message',
'key_category': 'msg_actions',
}),
('TOPIC_NARROW', {
'keys': ['S'],
'help_text': 'Narrow to the topic of the current message',
'key_category': 'msg_actions',
}),
('NARROW_MESSAGE_RECIPIENT', {
'keys': ['meta .'],
'help_text': 'Narrow to compose box message recipient',
'key_category': 'msg_compose',
}),
('TOGGLE_NARROW', {
'keys': ['z'],
'help_text':
'Narrow to a topic/private-chat, or stream/all-private-messages',
'key_category': 'msg_actions',
}),
('TOGGLE_TOPIC', {
'keys': ['t'],
'help_text': 'Toggle topics in a stream',
'key_category': 'stream_list',
}),
('ALL_MESSAGES', {
'keys': ['a', 'esc'],
'help_text': 'Narrow to all messages',
'key_category': 'navigation',
}),
('ALL_PM', {
'keys': ['P'],
'help_text': 'Narrow to all private messages',
'key_category': 'navigation',
}),
('ALL_STARRED', {
'keys': ['f'],
'help_text': 'Narrow to all starred messages',
'key_category': 'navigation',
}),
('ALL_MENTIONS', {
'keys': ['#'],
'help_text': "Narrow to messages in which you're mentioned",
'key_category': 'navigation',
}),
('NEXT_UNREAD_TOPIC', {
'keys': ['n'],
'help_text': 'Next unread topic',
'key_category': 'navigation',
}),
('NEXT_UNREAD_PM', {
'keys': ['p'],
'help_text': 'Next unread private message',
'key_category': 'navigation',
}),
('SEARCH_PEOPLE', {
'keys': ['w'],
'help_text': 'Search Users',
'key_category': 'searching',
}),
('SEARCH_MESSAGES', {
'keys': ['/'],
'help_text': 'Search Messages',
'key_category': 'searching',
}),
('SEARCH_STREAMS', {
'keys': ['q'],
'help_text': 'Search Streams',
'key_category': 'searching',
}),
('SEARCH_TOPICS', {
'keys': ['q'],
'help_text': 'Search topics in a stream',
'key_category': 'searching',
}),
('SEARCH_EMOJIS', {
'keys': ['p'],
'help_text': 'Search emojis from Emoji-picker popup',
'excluded_from_random_tips': True,
'key_category': 'searching',
}),
('TOGGLE_MUTE_STREAM', {
'keys': ['m'],
'help_text': 'Mute/unmute Streams',
'key_category': 'stream_list',
}),
('ENTER', {
'keys': ['enter'],
'help_text': 'Perform current action',
'key_category': 'navigation',
}),
('THUMBS_UP', {
'keys': ['+'],
'help_text': 'Add/remove thumbs-up reaction to the current message',
'key_category': 'msg_actions',
}),
('TOGGLE_STAR_STATUS', {
'keys': ['ctrl s', '*'],
'help_text': 'Add/remove star status of the current message',
'key_category': 'msg_actions',
}),
('MSG_INFO', {
'keys': ['i'],
'help_text': 'Show/hide message information',
'key_category': 'msg_actions',
}),
('EDIT_HISTORY', {
'keys': ['e'],
'help_text': 'Show/hide edit history (from message information)',
'excluded_from_random_tips': True,
'key_category': 'msg_actions',
}),
('VIEW_IN_BROWSER', {
'keys': ['v'],
'help_text':
'View current message in browser (from message information)',
'excluded_from_random_tips': True,
'key_category': 'msg_actions',
}),
('STREAM_DESC', {
'keys': ['i'],
'help_text': 'Show/hide stream information & modify settings',
'key_category': 'stream_list',
}),
('STREAM_MEMBERS', {
'keys': ['m'],
'help_text': 'Show/hide stream members (from stream information)',
'excluded_from_random_tips': True,
'key_category': 'stream_list',
}),
('COPY_STREAM_EMAIL', {
'keys': ['c'],
'help_text':
'Copy stream email to clipboard (from stream information)',
'excluded_from_random_tips': True,
'key_category': 'stream_list',
}),
('REDRAW', {
'keys': ['ctrl l'],
'help_text': 'Redraw screen',
'key_category': 'general',
}),
('QUIT', {
'keys': ['ctrl c'],
'help_text': 'Quit',
'key_category': 'general',
}),
('USER_INFO', {
'keys': ['i'],
'help_text': 'View user information (From Users list)',
'key_category': 'general',
}),
('BEGINNING_OF_LINE', {
'keys': ['ctrl a'],
'help_text': 'Jump to the beginning of line',
'key_category': 'msg_compose',
}),
('END_OF_LINE', {
'keys': ['ctrl e'],
'help_text': 'Jump to the end of line',
'key_category': 'msg_compose',
}),
('ONE_WORD_BACKWARD', {
'keys': ['meta b'],
'help_text': 'Jump backward one word',
'key_category': 'msg_compose',
}),
('ONE_WORD_FORWARD', {
'keys': ['meta f'],
'help_text': 'Jump forward one word',
'key_category': 'msg_compose',
}),
('DELETE_LAST_CHARACTER', {
'keys': ['ctrl h'],
'help_text': 'Delete previous character (to left)',
'key_category': 'msg_compose',
}),
('TRANSPOSE_CHARACTERS', {
'keys': ['ctrl t'],
'help_text': 'Transpose characters',
'key_category': 'msg_compose',
}),
('CUT_TO_END_OF_LINE', {
'keys': ['ctrl k'],
'help_text': 'Cut forwards to the end of the line',
'key_category': 'msg_compose',
}),
('CUT_TO_START_OF_LINE', {
'keys': ['ctrl u'],
'help_text': 'Cut backwards to the start of the line',
'key_category': 'msg_compose',
}),
('CUT_TO_END_OF_WORD', {
'keys': ['meta d'],
'help_text': 'Cut forwards to the end of the current word',
'key_category': 'msg_compose',
}),
('CUT_TO_START_OF_WORD', {
'keys': ['ctrl w'],
'help_text': 'Cut backwards to the start of the current word',
'key_category': 'msg_compose',
}),
('PASTE_LAST_CUT', {
'keys': ['ctrl y'],
'help_text': 'Paste last cut section',
'key_category': 'msg_compose',
}),
('UNDO_LAST_ACTION', {
'keys': ['ctrl _'],
'help_text': 'Undo last action',
'key_category': 'msg_compose',
}),
('PREV_LINE', {
'keys': ['up', 'ctrl p'],
'help_text': 'Jump to the previous line',
'key_category': 'msg_compose',
}),
('NEXT_LINE', {
'keys': ['down', 'ctrl n'],
'help_text': 'Jump to the next line',
'key_category': 'msg_compose',
}),
('CLEAR_MESSAGE', {
'keys': ['ctrl l'],
'help_text': 'Clear compose box',
'key_category': 'msg_compose',
}),
('FULL_RENDERED_MESSAGE', {
'keys': ['f'],
'help_text': 'Show/hide full rendered message (from message information)',
'key_category': 'msg_actions',
}),
('FULL_RAW_MESSAGE', {
'keys': ['r'],
'help_text': 'Show/hide full raw message (from message information)',
'key_category': 'msg_actions',
}),
])
# fmt: on
HELP_CATEGORIES = OrderedDict(
[
("general", "General"),
("navigation", "Navigation"),
("searching", "Searching"),
("msg_actions", "Message actions"),
("stream_list", "Stream list actions"),
("msg_compose", "Composing a Message"),
]
)
ZT_TO_URWID_CMD_MAPPING = {
"GO_UP": CURSOR_UP,
"GO_DOWN": CURSOR_DOWN,
"GO_LEFT": CURSOR_LEFT,
"GO_RIGHT": CURSOR_RIGHT,
"SCROLL_UP": CURSOR_PAGE_UP,
"SCROLL_DOWN": CURSOR_PAGE_DOWN,
"GO_TO_BOTTOM": CURSOR_MAX_RIGHT,
}
class InvalidCommand(Exception):
pass
def is_command_key(command: str, key: str) -> bool:
"""
Returns the mapped binding for a key if mapped
or the key otherwise.
"""
try:
return key in KEY_BINDINGS[command]["keys"]
except KeyError as exception:
raise InvalidCommand(command)
def keys_for_command(command: str) -> List[str]:
"""
Returns the actual keys for a given mapped command
"""
try:
return list(KEY_BINDINGS[command]["keys"])
except KeyError as exception:
raise InvalidCommand(command)
def primary_key_for_command(command: str) -> str:
"""
Primary Key is the key that will be displayed eg. in the UI
"""
return keys_for_command(command).pop(0)
def commands_for_random_tips() -> List[KeyBinding]:
"""
Return list of commands which may be displayed as a random tip
"""
return [
key_binding
for key_binding in KEY_BINDINGS.values()
if not key_binding.get("excluded_from_random_tips", False)
]
# Refer urwid/command_map.py
# Adds alternate keys for standard urwid navigational commands.
for zt_cmd, urwid_cmd in ZT_TO_URWID_CMD_MAPPING.items():
for key in keys_for_command(zt_cmd):
command_map[key] = urwid_cmd