Annotation of src/usr.bin/tmux/mode-key.c, Revision 1.15
1.15 ! nicm 1: /* $OpenBSD: mode-key.c,v 1.14 2009/08/13 23:44:18 nicm Exp $ */
1.1 nicm 2:
3: /*
4: * Copyright (c) 2008 Nicholas Marriott <nicm@users.sourceforge.net>
5: *
6: * Permission to use, copy, modify, and distribute this software for any
7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
9: *
10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
15: * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
16: * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17: */
18:
19: #include <sys/types.h>
20:
1.11 nicm 21: #include <string.h>
22:
1.1 nicm 23: #include "tmux.h"
24:
1.10 nicm 25: /*
26: * Mode keys. These are the key bindings used when editing (status prompt), and
27: * in the modes. They are split into two sets of three tables, one set of three
28: * for vi and the other for emacs key bindings. The three tables are for
29: * editing, for menu-like modes (choice, more), and for copy modes (copy,
30: * scroll).
31: *
32: * The fixed tables of struct mode_key_entry below are the defaults: they are
33: * built into a tree of struct mode_key_binding by mode_key_init_trees, which
34: * can then be modified.
35: *
36: * vi command mode is handled by having a mode flag in the struct which allows
37: * two sets of bindings to be swapped between. A couple of editing commands
38: * (MODEKEYEDIT_SWITCHMODE and MODEKEYEDIT_SWITCHMODEAPPEND) are special-cased
39: * to do this.
40: */
41:
42: /* Edit keys command strings. */
43: struct mode_key_cmdstr mode_key_cmdstr_edit[] = {
44: { MODEKEYEDIT_BACKSPACE, "backspace" },
45: { MODEKEYEDIT_CANCEL, "cancel" },
46: { MODEKEYEDIT_COMPLETE, "complete" },
47: { MODEKEYEDIT_CURSORLEFT, "cursor-left" },
48: { MODEKEYEDIT_CURSORRIGHT, "cursor-right" },
49: { MODEKEYEDIT_DELETE, "delete" },
50: { MODEKEYEDIT_DELETETOENDOFLINE, "delete-end-of-line" },
51: { MODEKEYEDIT_ENDOFLINE, "end-of-line" },
52: { MODEKEYEDIT_ENTER, "enter" },
53: { MODEKEYEDIT_HISTORYDOWN, "history-down" },
54: { MODEKEYEDIT_HISTORYUP, "history-up" },
55: { MODEKEYEDIT_PASTE, "paste" },
56: { MODEKEYEDIT_STARTOFLINE, "start-of-line" },
57: { MODEKEYEDIT_SWITCHMODE, "switch-mode" },
58: { MODEKEYEDIT_SWITCHMODEAPPEND, "switch-mode-append" },
1.11 nicm 59:
60: { 0, NULL }
1.10 nicm 61: };
62:
63: /* Choice keys command strings. */
64: struct mode_key_cmdstr mode_key_cmdstr_choice[] = {
65: { MODEKEYCHOICE_CANCEL, "cancel" },
66: { MODEKEYCHOICE_CHOOSE, "choose" },
67: { MODEKEYCHOICE_DOWN, "down" },
68: { MODEKEYCHOICE_PAGEDOWN, "page-down" },
69: { MODEKEYCHOICE_PAGEUP, "page-up" },
70: { MODEKEYCHOICE_UP, "up" },
1.11 nicm 71:
72: { 0, NULL }
1.10 nicm 73: };
74:
75: /* Copy keys command strings. */
76: struct mode_key_cmdstr mode_key_cmdstr_copy[] = {
1.15 ! nicm 77: { MODEKEYCOPY_BACKTOINDENTATION, "back-to-indentation" },
1.10 nicm 78: { MODEKEYCOPY_CANCEL, "cancel" },
79: { MODEKEYCOPY_CLEARSELECTION, "clear-selection" },
80: { MODEKEYCOPY_COPYSELECTION, "copy-selection" },
81: { MODEKEYCOPY_DOWN, "cursor-down" },
82: { MODEKEYCOPY_ENDOFLINE, "end-of-line" },
1.15 ! nicm 83: { MODEKEYCOPY_GOTOLINE, "goto-line" },
1.10 nicm 84: { MODEKEYCOPY_LEFT, "cursor-left" },
85: { MODEKEYCOPY_NEXTPAGE, "page-down" },
86: { MODEKEYCOPY_NEXTWORD, "next-word" },
87: { MODEKEYCOPY_PREVIOUSPAGE, "page-up" },
88: { MODEKEYCOPY_PREVIOUSWORD, "previous-word" },
89: { MODEKEYCOPY_RIGHT, "cursor-right" },
1.15 ! nicm 90: { MODEKEYCOPY_SEARCHAGAIN, "search-again" },
! 91: { MODEKEYCOPY_SEARCHDOWN, "search-forward" },
! 92: { MODEKEYCOPY_SEARCHUP, "search-backward" },
1.10 nicm 93: { MODEKEYCOPY_STARTOFLINE, "start-of-line" },
94: { MODEKEYCOPY_STARTSELECTION, "begin-selection" },
95: { MODEKEYCOPY_UP, "cursor-up" },
1.11 nicm 96:
97: { 0, NULL }
1.10 nicm 98: };
99:
1.8 nicm 100: /* vi editing keys. */
101: const struct mode_key_entry mode_key_vi_edit[] = {
102: { '\003' /* C-c */, 0, MODEKEYEDIT_CANCEL },
103: { '\010' /* C-h */, 0, MODEKEYEDIT_BACKSPACE },
104: { '\011' /* Tab */, 0, MODEKEYEDIT_COMPLETE },
105: { '\033' /* Escape */, 0, MODEKEYEDIT_SWITCHMODE },
106: { '\r', 0, MODEKEYEDIT_ENTER },
107: { KEYC_BSPACE, 0, MODEKEYEDIT_BACKSPACE },
108: { KEYC_DC, 0, MODEKEYEDIT_DELETE },
109:
110: { '$', 1, MODEKEYEDIT_ENDOFLINE },
111: { '0', 1, MODEKEYEDIT_STARTOFLINE },
112: { 'D', 1, MODEKEYEDIT_DELETETOENDOFLINE },
113: { '\003' /* C-c */, 1, MODEKEYEDIT_CANCEL },
114: { '\010' /* C-h */, 1, MODEKEYEDIT_BACKSPACE },
115: { '\r', 1, MODEKEYEDIT_ENTER },
116: { '^', 1, MODEKEYEDIT_STARTOFLINE },
117: { 'a', 1, MODEKEYEDIT_SWITCHMODEAPPEND },
118: { 'h', 1, MODEKEYEDIT_CURSORLEFT },
119: { 'i', 1, MODEKEYEDIT_SWITCHMODE },
120: { 'j', 1, MODEKEYEDIT_HISTORYDOWN },
121: { 'k', 1, MODEKEYEDIT_HISTORYUP },
122: { 'l', 1, MODEKEYEDIT_CURSORRIGHT },
123: { 'p', 1, MODEKEYEDIT_PASTE },
124: { KEYC_BSPACE, 1, MODEKEYEDIT_BACKSPACE },
125: { KEYC_DC, 1, MODEKEYEDIT_DELETE },
126: { KEYC_DOWN, 1, MODEKEYEDIT_HISTORYDOWN },
127: { KEYC_LEFT, 1, MODEKEYEDIT_CURSORLEFT },
128: { KEYC_RIGHT, 1, MODEKEYEDIT_CURSORRIGHT },
129: { KEYC_UP, 1, MODEKEYEDIT_HISTORYUP },
130:
131: { 0, -1, 0 }
132: };
1.10 nicm 133: struct mode_key_tree mode_key_tree_vi_edit;
1.8 nicm 134:
135: /* vi choice selection keys. */
136: const struct mode_key_entry mode_key_vi_choice[] = {
137: { '\003' /* C-c */, 0, MODEKEYCHOICE_CANCEL },
138: { '\r', 0, MODEKEYCHOICE_CHOOSE },
139: { 'j', 0, MODEKEYCHOICE_DOWN },
140: { 'k', 0, MODEKEYCHOICE_UP },
141: { 'q', 0, MODEKEYCHOICE_CANCEL },
142: { KEYC_DOWN, 0, MODEKEYCHOICE_DOWN },
143: { KEYC_NPAGE, 0, MODEKEYCHOICE_PAGEDOWN },
144: { KEYC_PPAGE, 0, MODEKEYCHOICE_PAGEUP },
145: { KEYC_UP, 0, MODEKEYCHOICE_UP },
146:
147: { 0, -1, 0 }
148: };
1.10 nicm 149: struct mode_key_tree mode_key_tree_vi_choice;
1.8 nicm 150:
151: /* vi copy mode keys. */
152: const struct mode_key_entry mode_key_vi_copy[] = {
153: { ' ', 0, MODEKEYCOPY_STARTSELECTION },
154: { '$', 0, MODEKEYCOPY_ENDOFLINE },
1.15 ! nicm 155: { '/', 0, MODEKEYCOPY_SEARCHUP },
1.8 nicm 156: { '0', 0, MODEKEYCOPY_STARTOFLINE },
1.15 ! nicm 157: { '?', 0, MODEKEYCOPY_SEARCHDOWN },
1.13 nicm 158: { '\002' /* C-b */, 0, MODEKEYCOPY_PREVIOUSPAGE },
1.9 nicm 159: { '\003' /* C-c */, 0, MODEKEYCOPY_CANCEL },
1.13 nicm 160: { '\004' /* C-d */, 0, MODEKEYCOPY_HALFPAGEDOWN },
1.8 nicm 161: { '\006' /* C-f */, 0, MODEKEYCOPY_NEXTPAGE },
162: { '\010' /* C-h */, 0, MODEKEYCOPY_LEFT },
1.13 nicm 163: { '\025' /* C-u */, 0, MODEKEYCOPY_HALFPAGEUP },
1.8 nicm 164: { '\033' /* Escape */, 0, MODEKEYCOPY_CLEARSELECTION },
165: { '\r', 0, MODEKEYCOPY_COPYSELECTION },
166: { '^', 0, MODEKEYCOPY_BACKTOINDENTATION },
167: { 'b', 0, MODEKEYCOPY_PREVIOUSWORD },
1.15 ! nicm 168: { 'g', 0, MODEKEYCOPY_GOTOLINE },
1.8 nicm 169: { 'h', 0, MODEKEYCOPY_LEFT },
170: { 'j', 0, MODEKEYCOPY_DOWN },
171: { 'k', 0, MODEKEYCOPY_UP },
172: { 'l', 0, MODEKEYCOPY_RIGHT },
1.15 ! nicm 173: { 'n', 0, MODEKEYCOPY_SEARCHAGAIN },
1.9 nicm 174: { 'q', 0, MODEKEYCOPY_CANCEL },
1.8 nicm 175: { 'w', 0, MODEKEYCOPY_NEXTWORD },
176: { KEYC_BSPACE, 0, MODEKEYCOPY_LEFT },
177: { KEYC_DOWN, 0, MODEKEYCOPY_DOWN },
178: { KEYC_LEFT, 0, MODEKEYCOPY_LEFT },
179: { KEYC_NPAGE, 0, MODEKEYCOPY_NEXTPAGE },
180: { KEYC_PPAGE, 0, MODEKEYCOPY_PREVIOUSPAGE },
181: { KEYC_RIGHT, 0, MODEKEYCOPY_RIGHT },
182: { KEYC_UP, 0, MODEKEYCOPY_UP },
183:
184: { 0, -1, 0 }
185: };
1.10 nicm 186: struct mode_key_tree mode_key_tree_vi_copy;
1.8 nicm 187:
188: /* emacs editing keys. */
189: const struct mode_key_entry mode_key_emacs_edit[] = {
190: { '\001' /* C-a */, 0, MODEKEYEDIT_STARTOFLINE },
191: { '\002' /* C-p */, 0, MODEKEYEDIT_CURSORLEFT },
1.14 nicm 192: { '\003' /* C-c */, 0, MODEKEYEDIT_CANCEL },
1.8 nicm 193: { '\004' /* C-d */, 0, MODEKEYEDIT_DELETE },
194: { '\005' /* C-e */, 0, MODEKEYEDIT_ENDOFLINE },
195: { '\006' /* C-f */, 0, MODEKEYEDIT_CURSORRIGHT },
196: { '\010' /* C-H */, 0, MODEKEYEDIT_BACKSPACE },
197: { '\011' /* Tab */, 0, MODEKEYEDIT_COMPLETE },
198: { '\013' /* C-k */, 0, MODEKEYEDIT_DELETETOENDOFLINE },
199: { '\016' /* C-n */, 0, MODEKEYEDIT_HISTORYDOWN },
200: { '\020' /* C-p */, 0, MODEKEYEDIT_HISTORYUP },
201: { '\031' /* C-y */, 0, MODEKEYEDIT_PASTE },
1.14 nicm 202: { '\033' /* Escape */, 0, MODEKEYEDIT_CANCEL },
1.8 nicm 203: { '\r', 0, MODEKEYEDIT_ENTER },
204: { 'm' | KEYC_ESCAPE, 0, MODEKEYEDIT_STARTOFLINE },
205: { KEYC_BSPACE, 0, MODEKEYEDIT_BACKSPACE },
206: { KEYC_DC, 0, MODEKEYEDIT_DELETE },
207: { KEYC_DOWN, 0, MODEKEYEDIT_HISTORYDOWN },
208: { KEYC_LEFT, 0, MODEKEYEDIT_CURSORLEFT },
209: { KEYC_RIGHT, 0, MODEKEYEDIT_CURSORRIGHT },
210: { KEYC_UP, 0, MODEKEYEDIT_HISTORYUP },
211:
212: { 0, -1, 0 }
213: };
1.10 nicm 214: struct mode_key_tree mode_key_tree_emacs_edit;
1.8 nicm 215:
216: /* emacs choice selection keys. */
217: const struct mode_key_entry mode_key_emacs_choice[] = {
218: { '\003' /* C-c */, 0, MODEKEYCHOICE_CANCEL },
219: { '\033' /* Escape */, 0, MODEKEYCHOICE_CANCEL },
220: { '\r', 0, MODEKEYCHOICE_CHOOSE },
221: { 'q', 0, MODEKEYCHOICE_CANCEL },
222: { KEYC_DOWN, 0, MODEKEYCHOICE_DOWN },
223: { KEYC_NPAGE, 0, MODEKEYCHOICE_PAGEDOWN },
224: { KEYC_PPAGE, 0, MODEKEYCHOICE_PAGEUP },
225: { KEYC_UP, 0, MODEKEYCHOICE_UP },
226:
227: { 0, -1, 0 }
228: };
1.10 nicm 229: struct mode_key_tree mode_key_tree_emacs_choice;
1.8 nicm 230:
231: /* emacs copy mode keys. */
232: const struct mode_key_entry mode_key_emacs_copy[] = {
233: { ' ', 0, MODEKEYCOPY_NEXTPAGE },
234: { '\000' /* C-Space */, 0, MODEKEYCOPY_STARTSELECTION },
235: { '\001' /* C-a */, 0, MODEKEYCOPY_STARTOFLINE },
236: { '\002' /* C-b */, 0, MODEKEYCOPY_LEFT },
1.9 nicm 237: { '\003' /* C-c */, 0, MODEKEYCOPY_CANCEL },
1.8 nicm 238: { '\005' /* C-e */, 0, MODEKEYCOPY_ENDOFLINE },
239: { '\006' /* C-f */, 0, MODEKEYCOPY_RIGHT },
240: { '\007' /* C-g */, 0, MODEKEYCOPY_CLEARSELECTION },
241: { '\016' /* C-n */, 0, MODEKEYCOPY_DOWN },
242: { '\020' /* C-p */, 0, MODEKEYCOPY_UP },
1.15 ! nicm 243: { '\022' /* C-r */, 0, MODEKEYCOPY_SEARCHUP },
! 244: { '\023' /* C-s */, 0, MODEKEYCOPY_SEARCHDOWN },
1.8 nicm 245: { '\026' /* C-v */, 0, MODEKEYCOPY_NEXTPAGE },
246: { '\027' /* C-w */, 0, MODEKEYCOPY_COPYSELECTION },
1.9 nicm 247: { '\033' /* Escape */, 0, MODEKEYCOPY_CANCEL },
1.8 nicm 248: { 'b' | KEYC_ESCAPE, 0, MODEKEYCOPY_PREVIOUSWORD },
249: { 'f' | KEYC_ESCAPE, 0, MODEKEYCOPY_NEXTWORD },
1.15 ! nicm 250: { 'g', 0, MODEKEYCOPY_GOTOLINE },
1.8 nicm 251: { 'm' | KEYC_ESCAPE, 0, MODEKEYCOPY_BACKTOINDENTATION },
1.15 ! nicm 252: { 'n', 0, MODEKEYCOPY_SEARCHAGAIN },
1.9 nicm 253: { 'q', 0, MODEKEYCOPY_CANCEL },
1.8 nicm 254: { 'v' | KEYC_ESCAPE, 0, MODEKEYCOPY_PREVIOUSPAGE },
255: { 'w' | KEYC_ESCAPE, 0, MODEKEYCOPY_COPYSELECTION },
1.13 nicm 256: { KEYC_DOWN | KEYC_ESCAPE, 0, MODEKEYCOPY_HALFPAGEDOWN },
1.8 nicm 257: { KEYC_DOWN, 0, MODEKEYCOPY_DOWN },
258: { KEYC_LEFT, 0, MODEKEYCOPY_LEFT },
259: { KEYC_NPAGE, 0, MODEKEYCOPY_NEXTPAGE },
260: { KEYC_PPAGE, 0, MODEKEYCOPY_PREVIOUSPAGE },
261: { KEYC_RIGHT, 0, MODEKEYCOPY_RIGHT },
1.13 nicm 262: { KEYC_UP | KEYC_ESCAPE, 0, MODEKEYCOPY_HALFPAGEUP },
1.8 nicm 263: { KEYC_UP, 0, MODEKEYCOPY_UP },
264:
265: { 0, -1, 0 }
266: };
1.10 nicm 267: struct mode_key_tree mode_key_tree_emacs_copy;
268:
269: /* Table mapping key table names to default settings and trees. */
270: const struct mode_key_table mode_key_tables[] = {
271: { "vi-edit", mode_key_cmdstr_edit,
272: &mode_key_tree_vi_edit, mode_key_vi_edit },
273: { "vi-choice", mode_key_cmdstr_choice,
274: &mode_key_tree_vi_choice, mode_key_vi_choice },
275: { "vi-copy", mode_key_cmdstr_copy,
276: &mode_key_tree_vi_copy, mode_key_vi_copy },
277: { "emacs-edit", mode_key_cmdstr_edit,
278: &mode_key_tree_emacs_edit, mode_key_emacs_edit },
279: { "emacs-choice", mode_key_cmdstr_choice,
280: &mode_key_tree_emacs_choice, mode_key_emacs_choice },
281: { "emacs-copy", mode_key_cmdstr_copy,
282: &mode_key_tree_emacs_copy, mode_key_emacs_copy },
283:
284: { NULL, NULL, NULL, NULL }
285: };
286:
287: SPLAY_GENERATE(mode_key_tree, mode_key_binding, entry, mode_key_cmp);
288:
289: int
290: mode_key_cmp(struct mode_key_binding *mbind1, struct mode_key_binding *mbind2)
291: {
292: if (mbind1->mode != mbind2->mode)
293: return (mbind1->mode - mbind2->mode);
294: return (mbind1->key - mbind2->key);
295: }
296:
297: const char *
298: mode_key_tostring(struct mode_key_cmdstr *cmdstr, enum mode_key_cmd cmd)
299: {
300: for (; cmdstr->name != NULL; cmdstr++) {
301: if (cmdstr->cmd == cmd)
302: return (cmdstr->name);
1.11 nicm 303: }
304: return (NULL);
305: }
306:
307: enum mode_key_cmd
308: mode_key_fromstring(struct mode_key_cmdstr *cmdstr, const char *name)
309: {
310: for (; cmdstr->name != NULL; cmdstr++) {
311: if (strcasecmp(cmdstr->name, name) == 0)
312: return (cmdstr->cmd);
313: }
314: return (MODEKEY_NONE);
315: }
316:
317: const struct mode_key_table *
318: mode_key_findtable(const char *name)
319: {
320: const struct mode_key_table *mtab;
321:
322: for (mtab = mode_key_tables; mtab->name != NULL; mtab++) {
323: if (strcasecmp(name, mtab->name) == 0)
324: return (mtab);
1.10 nicm 325: }
326: return (NULL);
327: }
1.1 nicm 328:
329: void
1.10 nicm 330: mode_key_init_trees(void)
1.1 nicm 331: {
1.10 nicm 332: const struct mode_key_table *mtab;
333: const struct mode_key_entry *ment;
334: struct mode_key_binding *mbind;
335:
336: for (mtab = mode_key_tables; mtab->name != NULL; mtab++) {
337: SPLAY_INIT(mtab->tree);
338: for (ment = mtab->table; ment->mode != -1; ment++) {
339: mbind = xmalloc(sizeof *mbind);
340: mbind->key = ment->key;
341: mbind->mode = ment->mode;
342: mbind->cmd = ment->cmd;
343: SPLAY_INSERT(mode_key_tree, mtab->tree, mbind);
344: }
345: }
346: }
347:
348: void
349: mode_key_free_trees(void)
350: {
351: const struct mode_key_table *mtab;
352: struct mode_key_binding *mbind;
353:
354: for (mtab = mode_key_tables; mtab->name != NULL; mtab++) {
355: while (!SPLAY_EMPTY(mtab->tree)) {
356: mbind = SPLAY_ROOT(mtab->tree);
357: SPLAY_REMOVE(mode_key_tree, mtab->tree, mbind);
1.12 nicm 358: xfree(mbind);
1.10 nicm 359: }
360: }
361: }
362:
363: void
364: mode_key_init(struct mode_key_data *mdata, struct mode_key_tree *mtree)
365: {
366: mdata->tree = mtree;
1.8 nicm 367: mdata->mode = 0;
1.1 nicm 368: }
369:
370: enum mode_key_cmd
371: mode_key_lookup(struct mode_key_data *mdata, int key)
372: {
1.10 nicm 373: struct mode_key_binding *mbind, mtmp;
374:
375: mtmp.key = key;
376: mtmp.mode = mdata->mode;
377: if ((mbind = SPLAY_FIND(mode_key_tree, mdata->tree, &mtmp)) == NULL) {
378: if (mdata->mode != 0)
379: return (MODEKEY_NONE);
380: return (MODEKEY_OTHER);
381: }
1.1 nicm 382:
1.10 nicm 383: switch (mbind->cmd) {
384: case MODEKEYEDIT_SWITCHMODE:
385: case MODEKEYEDIT_SWITCHMODEAPPEND:
386: mdata->mode = 1 - mdata->mode;
387: /* FALLTHROUGH */
388: default:
389: return (mbind->cmd);
1.1 nicm 390: }
391: }
![[BACK]](/icons/back.gif){kind=icon}
Return to mode-key.c CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / tmux