forked from neomutt/neomutt
-
Notifications
You must be signed in to change notification settings - Fork 0
/
keymap.c
1922 lines (1720 loc) · 49.1 KB
/
keymap.c
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
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* @file
* Manage keymappings
*
* @authors
* Copyright (C) 1996-2000,2002,2010-2011 Michael R. Elkins <[email protected]>
*
* @copyright
* This program 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 2 of the License, or (at your option) any later
* version.
*
* This program 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
* this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @page neo_keymap Manage keymappings
*
* Manage keymappings
*/
#include "config.h"
#include <ctype.h>
#include <limits.h>
#include <stdbool.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <strings.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "mutt.h"
#include "keymap.h"
#include "color/lib.h"
#include "menu/lib.h"
#include "ncrypt/lib.h"
#include "pager/lib.h"
#include "parse/lib.h"
#include "functions.h"
#include "globals.h"
#include "mutt_logging.h"
#include "opcodes.h"
#ifdef USE_IMAP
#include "imap/lib.h"
#endif
#ifdef USE_INOTIFY
#include "monitor.h"
#endif
/**
* KeyNames - Key name lookup table
*/
static struct Mapping KeyNames[] = {
{ "<PageUp>", KEY_PPAGE },
{ "<PageDown>", KEY_NPAGE },
{ "<Up>", KEY_UP },
{ "<Down>", KEY_DOWN },
{ "<Right>", KEY_RIGHT },
{ "<Left>", KEY_LEFT },
{ "<Delete>", KEY_DC },
{ "<BackSpace>", KEY_BACKSPACE },
{ "<Insert>", KEY_IC },
{ "<Home>", KEY_HOME },
{ "<End>", KEY_END },
{ "<Enter>", '\n' },
{ "<Return>", '\r' },
#ifdef KEY_ENTER
{ "<KeypadEnter>", KEY_ENTER },
#else
{ "<KeypadEnter>", '\n' },
#endif
{ "<Esc>", '\033' }, // Escape
{ "<Tab>", '\t' },
{ "<Space>", ' ' },
#ifdef KEY_BTAB
{ "<BackTab>", KEY_BTAB },
#endif
#ifdef KEY_NEXT
{ "<Next>", KEY_NEXT },
#endif
/* extensions supported by ncurses. values are filled in during initialization */
/* CTRL+key */
{ "<C-Up>", -1 },
{ "<C-Down>", -1 },
{ "<C-Left>", -1 },
{ "<C-Right>", -1 },
{ "<C-Home>", -1 },
{ "<C-End>", -1 },
{ "<C-Next>", -1 },
{ "<C-Prev>", -1 },
/* SHIFT+key */
{ "<S-Up>", -1 },
{ "<S-Down>", -1 },
{ "<S-Left>", -1 },
{ "<S-Right>", -1 },
{ "<S-Home>", -1 },
{ "<S-End>", -1 },
{ "<S-Next>", -1 },
{ "<S-Prev>", -1 },
/* ALT+key */
{ "<A-Up>", -1 },
{ "<A-Down>", -1 },
{ "<A-Left>", -1 },
{ "<A-Right>", -1 },
{ "<A-Home>", -1 },
{ "<A-End>", -1 },
{ "<A-Next>", -1 },
{ "<A-Prev>", -1 },
{ NULL, 0 },
};
keycode_t AbortKey; ///< code of key to abort prompts, normally Ctrl-G
struct KeymapList Keymaps[MENU_MAX];
/**
* struct Extkey - Map key names from NeoMutt's style to Curses style
*/
struct Extkey
{
const char *name; ///< NeoMutt key name
const char *sym; ///< Curses key name
};
static const struct Extkey ExtKeys[] = {
{ "<c-up>", "kUP5" },
{ "<s-up>", "kUP" },
{ "<a-up>", "kUP3" },
{ "<s-down>", "kDN" },
{ "<a-down>", "kDN3" },
{ "<c-down>", "kDN5" },
{ "<c-right>", "kRIT5" },
{ "<s-right>", "kRIT" },
{ "<a-right>", "kRIT3" },
{ "<s-left>", "kLFT" },
{ "<a-left>", "kLFT3" },
{ "<c-left>", "kLFT5" },
{ "<s-home>", "kHOM" },
{ "<a-home>", "kHOM3" },
{ "<c-home>", "kHOM5" },
{ "<s-end>", "kEND" },
{ "<a-end>", "kEND3" },
{ "<c-end>", "kEND5" },
{ "<s-next>", "kNXT" },
{ "<a-next>", "kNXT3" },
{ "<c-next>", "kNXT5" },
{ "<s-prev>", "kPRV" },
{ "<a-prev>", "kPRV3" },
{ "<c-prev>", "kPRV5" },
{ 0, 0 },
};
/**
* mutt_keymap_free - Free a Keymap
* @param km Keymap to free
*/
static void mutt_keymap_free(struct Keymap **km)
{
if (!km || !*km)
return;
FREE(&(*km)->macro);
FREE(&(*km)->desc);
FREE(&(*km)->keys);
FREE(km);
}
/**
* mutt_keymaplist_free - Free a List of Keymaps
* @param km_list List of Keymaps to free
*/
static void mutt_keymaplist_free(struct KeymapList *km_list)
{
struct Keymap *np = NULL, *tmp = NULL;
STAILQ_FOREACH_SAFE(np, km_list, entries, tmp)
{
STAILQ_REMOVE(km_list, np, Keymap, entries);
mutt_keymap_free(&np);
}
}
/**
* alloc_keys - Allocate space for a sequence of keys
* @param len Number of keys
* @param keys Array of keys
* @retval ptr Sequence of keys
*/
static struct Keymap *alloc_keys(size_t len, keycode_t *keys)
{
struct Keymap *p = mutt_mem_calloc(1, sizeof(struct Keymap));
p->len = len;
p->keys = mutt_mem_calloc(len, sizeof(keycode_t));
memcpy(p->keys, keys, len * sizeof(keycode_t));
return p;
}
/**
* parse_fkey - Parse a function key string
* @param s String to parse
* @retval num Number of the key
*
* Given "<f8>", it will return 8.
*/
static int parse_fkey(char *s)
{
char *t = NULL;
int n = 0;
if ((s[0] != '<') || (tolower(s[1]) != 'f'))
return -1;
for (t = s + 2; *t && isdigit((unsigned char) *t); t++)
{
n *= 10;
n += *t - '0';
}
if (*t != '>')
return -1;
return n;
}
/**
* parse_keycode - Parse a numeric keycode
* @param s String to parse
* @retval num Number of the key
*
* This function parses the string `<NNN>` and uses the octal value as the key
* to bind.
*/
static int parse_keycode(const char *s)
{
char *end_char = NULL;
long int result = strtol(s + 1, &end_char, 8);
/* allow trailing whitespace, eg. < 1001 > */
while (IS_SPACE(*end_char))
end_char++;
/* negative keycodes don't make sense, also detect overflow */
if ((*end_char != '>') || (result < 0) || (result == LONG_MAX))
{
return -1;
}
return result;
}
/**
* parsekeys - Parse a key string into key codes
* @param str Key string
* @param d Array for key codes
* @param max Maximum length of key sequence
* @retval num Length of key sequence
*/
static size_t parsekeys(const char *str, keycode_t *d, size_t max)
{
int n;
size_t len = max;
char buf[128] = { 0 };
char c;
char *t = NULL;
mutt_str_copy(buf, str, sizeof(buf));
char *s = buf;
while (*s && len)
{
*d = '\0';
if ((*s == '<') && (t = strchr(s, '>')))
{
t++;
c = *t;
*t = '\0';
n = mutt_map_get_value(s, KeyNames);
if (n != -1)
{
s = t;
*d = n;
}
else if ((n = parse_fkey(s)) > 0)
{
s = t;
*d = KEY_F(n);
}
else if ((n = parse_keycode(s)) > 0)
{
s = t;
*d = n;
}
*t = c;
}
if (!*d)
{
*d = (unsigned char) *s;
s++;
}
d++;
len--;
}
return max - len;
}
/**
* km_compare_keys - Compare two keymaps' keyscodes and return the bigger one
* @param k1 first keymap to compare
* @param k2 second keymap to compare
* @param pos position where the two keycodes differ
* @retval ptr Keymap with a bigger ASCII keycode
*/
static struct Keymap *km_compare_keys(struct Keymap *k1, struct Keymap *k2, size_t *pos)
{
while (*pos < k1->len && *pos < k2->len)
{
if (k1->keys[*pos] < k2->keys[*pos])
return k2;
else if (k1->keys[*pos] > k2->keys[*pos])
return k1;
else
*pos = *pos + 1;
}
return NULL;
}
/**
* km_bind_err - Set up a key binding
* @param s Key string
* @param mtype Menu type, e.g. #MENU_EDITOR
* @param op Operation, e.g. OP_DELETE
* @param macro Macro string
* @param desc Description of macro (OPTIONAL)
* @param err Buffer for error message
* @retval #CommandResult Result e.g. #MUTT_CMD_SUCCESS
*
* Insert a key sequence into the specified map.
* The map is sorted by ASCII value (lowest to highest)
*/
static enum CommandResult km_bind_err(const char *s, enum MenuType mtype, int op,
char *macro, char *desc, struct Buffer *err)
{
enum CommandResult rc = MUTT_CMD_SUCCESS;
struct Keymap *last = NULL, *np = NULL, *compare = NULL;
keycode_t buf[MAX_SEQ];
size_t pos = 0, lastpos = 0;
size_t len = parsekeys(s, buf, MAX_SEQ);
struct Keymap *map = alloc_keys(len, buf);
map->op = op;
map->macro = mutt_str_dup(macro);
map->desc = mutt_str_dup(desc);
/* find position to place new keymap */
STAILQ_FOREACH(np, &Keymaps[mtype], entries)
{
compare = km_compare_keys(map, np, &pos);
if (compare == map) /* map's keycode is bigger */
{
last = np;
lastpos = pos;
if (pos > np->eq)
pos = np->eq;
}
else if (compare == np) /* np's keycode is bigger, found insert location */
{
map->eq = pos;
break;
}
else /* equal keycodes */
{
/* Don't warn on overwriting a 'noop' binding */
if ((np->len != len) && (np->op != OP_NULL))
{
/* Overwrite with the different lengths, warn */
/* TODO: MAX_SEQ here is wrong */
char old_binding[MAX_SEQ] = { 0 };
char new_binding[MAX_SEQ] = { 0 };
km_expand_key(old_binding, MAX_SEQ, map);
km_expand_key(new_binding, MAX_SEQ, np);
char *err_msg = _("Binding '%s' will alias '%s' Before, try: 'bind %s %s noop' https://neomutt.org/guide/configuration.html#bind-warnings");
if (err)
{
/* err was passed, put the string there */
mutt_buffer_printf(err, err_msg, old_binding, new_binding,
mutt_map_get_name(mtype, MenuNames), new_binding);
}
else
{
mutt_error(err_msg, old_binding, new_binding,
mutt_map_get_name(mtype, MenuNames), new_binding);
}
rc = MUTT_CMD_WARNING;
}
map->eq = np->eq;
STAILQ_REMOVE(&Keymaps[mtype], np, Keymap, entries);
mutt_keymap_free(&np);
break;
}
}
if (map->op == OP_NULL)
{
mutt_keymap_free(&map);
}
else
{
if (last) /* if queue has at least one entry */
{
if (STAILQ_NEXT(last, entries))
STAILQ_INSERT_AFTER(&Keymaps[mtype], last, map, entries);
else /* last entry in the queue */
STAILQ_INSERT_TAIL(&Keymaps[mtype], map, entries);
last->eq = lastpos;
}
else /* queue is empty, so insert from head */
{
STAILQ_INSERT_HEAD(&Keymaps[mtype], map, entries);
}
}
return rc;
}
/**
* km_bind - Bind a key to a macro
* @param s Key string
* @param mtype Menu type, e.g. #MENU_EDITOR
* @param op Operation, e.g. OP_DELETE
* @param macro Macro string
* @param desc Description of macro (OPTIONAL)
* @retval #CommandResult Result e.g. #MUTT_CMD_SUCCESS
*/
enum CommandResult km_bind(char *s, enum MenuType mtype, int op, char *macro, char *desc)
{
return km_bind_err(s, mtype, op, macro, desc, NULL);
}
/**
* km_bindkey_err - Bind a key in a Menu to an operation (with error message)
* @param s Key string
* @param mtype Menu type, e.g. #MENU_PAGER
* @param op Operation, e.g. OP_DELETE
* @param err Buffer for error message
* @retval #CommandResult Result e.g. #MUTT_CMD_SUCCESS
*/
static enum CommandResult km_bindkey_err(const char *s, enum MenuType mtype,
int op, struct Buffer *err)
{
return km_bind_err(s, mtype, op, NULL, NULL, err);
}
/**
* km_bindkey - Bind a key in a Menu to an operation
* @param s Key string
* @param mtype Menu type, e.g. #MENU_PAGER
* @param op Operation, e.g. OP_DELETE
* @retval #CommandResult Result e.g. #MUTT_CMD_SUCCESS
*/
static enum CommandResult km_bindkey(const char *s, enum MenuType mtype, int op)
{
return km_bindkey_err(s, mtype, op, NULL);
}
/**
* get_op - Get the function by its name
* @param funcs Functions table
* @param start Name of function to find
* @param len Length of string to match
* @retval num Operation, e.g. OP_DELETE
*/
static int get_op(const struct MenuFuncOp *funcs, const char *start, size_t len)
{
for (int i = 0; funcs[i].name; i++)
{
if (mutt_istrn_equal(start, funcs[i].name, len) && (mutt_str_len(funcs[i].name) == len))
{
return funcs[i].op;
}
}
return OP_NULL;
}
/**
* mutt_get_func - Get the name of a function
* @param funcs Functions table
* @param op Operation, e.g. OP_DELETE
* @retval ptr Name of function
* @retval NULL Operation not found
*
* @note This returns a static string.
*/
const char *mutt_get_func(const struct MenuFuncOp *funcs, int op)
{
for (int i = 0; funcs[i].name; i++)
{
if (funcs[i].op == op)
return funcs[i].name;
}
return NULL;
}
/**
* generic_tokenize_push_string - Parse and queue a 'push' command
* @param s String to push into the key queue
* @param generic_push Callback function to add events to macro queue
*
* Parses s for `<function>` syntax and adds the whole sequence to either the
* macro or unget buffer. This function is invoked by the next two defines
* below.
*/
static void generic_tokenize_push_string(char *s, void (*generic_push)(int, int))
{
char *pp = NULL;
char *p = s + mutt_str_len(s) - 1;
size_t l;
int i, op = OP_NULL;
while (p >= s)
{
/* if we see something like "<PageUp>", look to see if it is a real
* function name and return the corresponding value */
if (*p == '>')
{
for (pp = p - 1; pp >= s && *pp != '<'; pp--)
; // do nothing
if (pp >= s)
{
i = parse_fkey(pp);
if (i > 0)
{
generic_push(KEY_F(i), 0);
p = pp - 1;
continue;
}
l = p - pp + 1;
for (i = 0; KeyNames[i].name; i++)
{
if (mutt_istrn_equal(pp, KeyNames[i].name, l))
break;
}
if (KeyNames[i].name)
{
/* found a match */
generic_push(KeyNames[i].value, 0);
p = pp - 1;
continue;
}
/* See if it is a valid command
* skip the '<' and the '>' when comparing */
for (enum MenuType j = 0; MenuNames[j].name; j++)
{
const struct MenuFuncOp *funcs = km_get_table(MenuNames[j].value);
if (funcs)
{
op = get_op(funcs, pp + 1, l - 2);
if (op != OP_NULL)
break;
}
}
if (op != OP_NULL)
{
generic_push(0, op);
p = pp - 1;
continue;
}
}
}
generic_push((unsigned char) *p--, 0); /* independent 8 bits chars */
}
}
/**
* retry_generic - Try to find the key in the generic menu bindings
* @param mtype Menu type, e.g. #MENU_PAGER
* @param keys Array of keys to return to the input queue
* @param keyslen Number of keys in the array
* @param lastkey Last key pressed (to return to input queue)
* @retval num Operation, e.g. OP_DELETE
*/
static struct KeyEvent retry_generic(enum MenuType mtype, keycode_t *keys,
int keyslen, int lastkey)
{
if (lastkey)
mutt_unget_ch(lastkey);
for (; keyslen; keyslen--)
mutt_unget_ch(keys[keyslen - 1]);
if ((mtype != MENU_EDITOR) && (mtype != MENU_GENERIC) && (mtype != MENU_PAGER))
{
return km_dokey_event(MENU_GENERIC);
}
if ((mtype != MENU_EDITOR) && (mtype != MENU_GENERIC))
{
/* probably a good idea to flush input here so we can abort macros */
mutt_flushinp();
}
return (struct KeyEvent){ .ch = mutt_getch().ch, .op = OP_NULL };
}
/**
* km_dokey_event - Determine what a keypress should do
* @param mtype Menu type, e.g. #MENU_EDITOR
* @retval ptr Event
*/
struct KeyEvent km_dokey_event(enum MenuType mtype)
{
struct KeyEvent tmp = { OP_NULL, OP_NULL };
struct Keymap *map = STAILQ_FIRST(&Keymaps[mtype]);
int pos = 0;
int n = 0;
if (!map && (mtype != MENU_EDITOR))
return retry_generic(mtype, NULL, 0, 0);
#ifdef USE_IMAP
const short c_imap_keepalive = cs_subset_number(NeoMutt->sub, "imap_keepalive");
#endif
while (true)
{
const short c_timeout = cs_subset_number(NeoMutt->sub, "timeout");
int i = (c_timeout > 0) ? c_timeout : 60;
#ifdef USE_IMAP
/* keepalive may need to run more frequently than `$timeout` allows */
if (c_imap_keepalive)
{
if (c_imap_keepalive >= i)
{
imap_keepalive();
}
else
{
while (c_imap_keepalive && (c_imap_keepalive < i))
{
tmp = mutt_getch_timeout(c_imap_keepalive * 1000);
/* If a timeout was not received, or the window was resized, exit the
* loop now. Otherwise, continue to loop until reaching a total of
* $timeout seconds. */
if ((tmp.op != OP_TIMEOUT) || SigWinch)
goto gotkey;
#ifdef USE_INOTIFY
if (MonitorFilesChanged)
goto gotkey;
#endif
i -= c_imap_keepalive;
imap_keepalive();
}
}
}
#endif
tmp = mutt_getch_timeout(i * 1000);
#ifdef USE_IMAP
gotkey:
#endif
/* hide timeouts, but not window resizes, from the line editor. */
if ((mtype == MENU_EDITOR) && (tmp.op == OP_TIMEOUT) && !SigWinch)
continue;
if ((tmp.op == OP_TIMEOUT) || (tmp.op == OP_ABORT))
{
return tmp;
}
/* do we have an op already? */
if (tmp.op != OP_NULL)
{
const char *func = NULL;
const struct MenuFuncOp *funcs = NULL;
/* is this a valid op for this menu type? */
if ((funcs = km_get_table(mtype)) && (func = mutt_get_func(funcs, tmp.op)))
return tmp;
if ((mtype != MENU_EDITOR) && (mtype != MENU_PAGER) && (mtype != MENU_GENERIC))
{
/* check generic menu type */
funcs = OpGeneric;
func = mutt_get_func(funcs, tmp.op);
if (func)
return tmp;
}
/* Sigh. Valid function but not in this context.
* Find the literal string and push it back */
for (i = 0; MenuNames[i].name; i++)
{
funcs = km_get_table(MenuNames[i].value);
if (funcs)
{
func = mutt_get_func(funcs, tmp.op);
if (func)
{
mutt_unget_ch('>');
mutt_unget_string(func);
mutt_unget_ch('<');
break;
}
}
}
/* continue to chew */
if (func)
continue;
}
if (!map)
return tmp;
/* Nope. Business as usual */
while (tmp.ch > map->keys[pos])
{
if ((pos > map->eq) || !STAILQ_NEXT(map, entries))
return retry_generic(mtype, map->keys, pos, tmp.ch);
map = STAILQ_NEXT(map, entries);
}
if (tmp.ch != map->keys[pos])
return retry_generic(mtype, map->keys, pos, tmp.ch);
if (++pos == map->len)
{
if (map->op != OP_MACRO)
return (struct KeyEvent){ .ch = tmp.ch, .op = map->op };
/* OptIgnoreMacroEvents turns off processing the MacroEvents buffer
* in mutt_getch(). Generating new macro events during that time would
* result in undesired behavior once the option is turned off.
*
* Originally this returned -1, however that results in an unbuffered
* username or password prompt being aborted. Returning OP_NULL allows
* mutt_enter_string_full() to display the keybinding pressed instead.
*
* It may be unexpected for a macro's keybinding to be returned,
* but less so than aborting the prompt. */
if (OptIgnoreMacroEvents)
{
return (struct KeyEvent){ .ch = tmp.ch, .op = OP_NULL };
}
if (n++ == 10)
{
mutt_flushinp();
mutt_error(_("Macro loop detected"));
return (struct KeyEvent){ .ch = '\0', .op = -1 };
}
generic_tokenize_push_string(map->macro, mutt_push_macro_event);
map = STAILQ_FIRST(&Keymaps[mtype]);
pos = 0;
}
}
/* not reached */
}
/**
* km_dokey - Determine what a keypress should do
* @param mtype Menu type, e.g. #MENU_EDITOR
* @retval >0 Function to execute
* @retval OP_NULL No function bound to key sequence
* @retval -1 Error occurred while reading input
* @retval -2 A timeout or sigwinch occurred
*/
int km_dokey(enum MenuType mtype)
{
return km_dokey_event(mtype).op;
}
/**
* create_bindings - Attach a set of keybindings to a Menu
* @param map Key bindings
* @param mtype Menu type, e.g. #MENU_PAGER
*/
static void create_bindings(const struct MenuOpSeq *map, enum MenuType mtype)
{
STAILQ_INIT(&Keymaps[mtype]);
for (int i = 0; map[i].op != 0; i++)
if (map[i].seq)
km_bindkey(map[i].seq, mtype, map[i].op);
}
/**
* km_keyname - Get the human name for a key
* @param c Key code
* @retval ptr Name of the key
*
* @note This returns a pointer to a static buffer.
*/
static const char *km_keyname(int c)
{
static char buf[35];
const char *p = mutt_map_get_name(c, KeyNames);
if (p)
return p;
if ((c < 256) && (c > -128) && iscntrl((unsigned char) c))
{
if (c < 0)
c += 256;
if (c < 128)
{
buf[0] = '^';
buf[1] = (c + '@') & 0x7f;
buf[2] = '\0';
}
else
{
snprintf(buf, sizeof(buf), "\\%d%d%d", c >> 6, (c >> 3) & 7, c & 7);
}
}
else if ((c >= KEY_F0) && (c < KEY_F(256))) /* this maximum is just a guess */
sprintf(buf, "<F%d>", c - KEY_F0);
else if (IsPrint(c))
snprintf(buf, sizeof(buf), "%c", (unsigned char) c);
else
snprintf(buf, sizeof(buf), "\\x%hx", (unsigned short) c);
return buf;
}
/**
* mutt_init_abort_key - Parse the abort_key config string
*
* Parse the string into `$abort_key` and put the keycode into AbortKey.
*/
void mutt_init_abort_key(void)
{
keycode_t buf[2];
const char *const c_abort_key = cs_subset_string(NeoMutt->sub, "abort_key");
size_t len = parsekeys(c_abort_key, buf, mutt_array_size(buf));
if (len == 0)
{
mutt_error(_("Abort key is not set, defaulting to Ctrl-G"));
AbortKey = ctrl('G');
return;
}
if (len > 1)
{
mutt_warning(_("Specified abort key sequence (%s) will be truncated to first key"),
c_abort_key);
}
AbortKey = buf[0];
}
/**
* main_config_observer - Notification that a Config Variable has changed - Implements ::observer_t - @ingroup observer_api
*/
int main_config_observer(struct NotifyCallback *nc)
{
if (nc->event_type != NT_CONFIG)
return 0;
if (!nc->event_data)
return -1;
struct EventConfig *ev_c = nc->event_data;
if (!mutt_str_equal(ev_c->name, "abort_key"))
return 0;
mutt_init_abort_key();
mutt_debug(LL_DEBUG5, "config done\n");
return 0;
}
/**
* km_expand_key_string - Get a human-readable key string
* @param str Raw key string
* @param buf Buffer for the key string
* @param buflen Length of buffer
* @retval num Length of string
*/
static int km_expand_key_string(char *str, char *buf, size_t buflen)
{
size_t len = 0;
for (; *str; str++)
{
const char *key = km_keyname(*str);
size_t keylen = mutt_str_len(key);
mutt_str_copy(buf, key, buflen);
buf += keylen;
buflen -= keylen;
len += keylen;
}
return len;
}
/**
* km_expand_key - Get the key string bound to a Keymap
* @param s Buffer for the key string
* @param len Length of buffer
* @param map Keybinding map
* @retval 1 Success
* @retval 0 Error
*/
int km_expand_key(char *s, size_t len, struct Keymap *map)
{
if (!map)
return 0;
int p = 0;
while (true)
{
mutt_str_copy(s, km_keyname(map->keys[p]), len);
const size_t l = mutt_str_len(s);
len -= l;
if ((++p >= map->len) || !len)
return 1;
s += l;
}
/* not reached */
}
/**
* km_find_func - Find a function's mapping in a Menu
* @param mtype Menu type, e.g. #MENU_PAGER
* @param func Function, e.g. OP_DELETE
* @retval ptr Keymap for the function
*/
struct Keymap *km_find_func(enum MenuType mtype, int func)
{
struct Keymap *np = NULL;
STAILQ_FOREACH(np, &Keymaps[mtype], entries)
{
if (np->op == func)
break;
}
return np;
}
/**
* find_ext_name - Find the curses name for a key
* @param key Key name
* @retval ptr Curses name
*
* Look up NeoMutt's name for a key and find the ncurses extended name for it.
*
* @note This returns a static string.
*/
static const char *find_ext_name(const char *key)
{
for (int j = 0; ExtKeys[j].name; j++)
{
if (strcasecmp(key, ExtKeys[j].name) == 0)
return ExtKeys[j].sym;
}
return 0;
}
/**
* init_extended_keys - Initialise map of ncurses extended keys
*
* Determine the keycodes for ncurses extended keys and fill in the KeyNames array.
*
* This function must be called *after* initscr(), or tigetstr() returns -1.
* This creates a bit of a chicken-and-egg problem because km_init() is called
* prior to start_curses(). This means that the default keybindings can't
* include any of the extended keys because they won't be defined until later.
*/
void init_extended_keys(void)