Annotation of src/usr.bin/tmux/mode-key.c, Revision 1.17
1.17 ! nicm 1: /* $OpenBSD: mode-key.c,v 1.16 2009/08/18 07:23:43 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" },
1.16 nicm 50: { MODEKEYEDIT_DELETELINE, "delete-line" },
1.10 nicm 51: { MODEKEYEDIT_DELETETOENDOFLINE, "delete-end-of-line" },
52: { MODEKEYEDIT_ENDOFLINE, "end-of-line" },
53: { MODEKEYEDIT_ENTER, "enter" },
54: { MODEKEYEDIT_HISTORYDOWN, "history-down" },
55: { MODEKEYEDIT_HISTORYUP, "history-up" },
56: { MODEKEYEDIT_PASTE, "paste" },
57: { MODEKEYEDIT_STARTOFLINE, "start-of-line" },
58: { MODEKEYEDIT_SWITCHMODE, "switch-mode" },
59: { MODEKEYEDIT_SWITCHMODEAPPEND, "switch-mode-append" },
1.17 ! nicm 60: { MODEKEYEDIT_TRANSPOSECHARS, "transpose-chars" },
1.11 nicm 61:
62: { 0, NULL }
1.10 nicm 63: };
64:
65: /* Choice keys command strings. */
66: struct mode_key_cmdstr mode_key_cmdstr_choice[] = {
67: { MODEKEYCHOICE_CANCEL, "cancel" },
68: { MODEKEYCHOICE_CHOOSE, "choose" },
69: { MODEKEYCHOICE_DOWN, "down" },
70: { MODEKEYCHOICE_PAGEDOWN, "page-down" },
71: { MODEKEYCHOICE_PAGEUP, "page-up" },
72: { MODEKEYCHOICE_UP, "up" },
1.11 nicm 73:
74: { 0, NULL }
1.10 nicm 75: };
76:
77: /* Copy keys command strings. */
78: struct mode_key_cmdstr mode_key_cmdstr_copy[] = {
1.15 nicm 79: { MODEKEYCOPY_BACKTOINDENTATION, "back-to-indentation" },
1.10 nicm 80: { MODEKEYCOPY_CANCEL, "cancel" },
81: { MODEKEYCOPY_CLEARSELECTION, "clear-selection" },
82: { MODEKEYCOPY_COPYSELECTION, "copy-selection" },
83: { MODEKEYCOPY_DOWN, "cursor-down" },
84: { MODEKEYCOPY_ENDOFLINE, "end-of-line" },
1.15 nicm 85: { MODEKEYCOPY_GOTOLINE, "goto-line" },
1.10 nicm 86: { MODEKEYCOPY_LEFT, "cursor-left" },
87: { MODEKEYCOPY_NEXTPAGE, "page-down" },
88: { MODEKEYCOPY_NEXTWORD, "next-word" },
89: { MODEKEYCOPY_PREVIOUSPAGE, "page-up" },
90: { MODEKEYCOPY_PREVIOUSWORD, "previous-word" },
91: { MODEKEYCOPY_RIGHT, "cursor-right" },
1.15 nicm 92: { MODEKEYCOPY_SEARCHAGAIN, "search-again" },
93: { MODEKEYCOPY_SEARCHDOWN, "search-forward" },
94: { MODEKEYCOPY_SEARCHUP, "search-backward" },
1.10 nicm 95: { MODEKEYCOPY_STARTOFLINE, "start-of-line" },
96: { MODEKEYCOPY_STARTSELECTION, "begin-selection" },
97: { MODEKEYCOPY_UP, "cursor-up" },
1.11 nicm 98:
99: { 0, NULL }
1.10 nicm 100: };
101:
1.8 nicm 102: /* vi editing keys. */
103: const struct mode_key_entry mode_key_vi_edit[] = {
104: { '\003' /* C-c */, 0, MODEKEYEDIT_CANCEL },
105: { '\010' /* C-h */, 0, MODEKEYEDIT_BACKSPACE },
106: { '\011' /* Tab */, 0, MODEKEYEDIT_COMPLETE },
107: { '\033' /* Escape */, 0, MODEKEYEDIT_SWITCHMODE },
108: { '\r', 0, MODEKEYEDIT_ENTER },
109: { KEYC_BSPACE, 0, MODEKEYEDIT_BACKSPACE },
110: { KEYC_DC, 0, MODEKEYEDIT_DELETE },
111:
112: { '$', 1, MODEKEYEDIT_ENDOFLINE },
113: { '0', 1, MODEKEYEDIT_STARTOFLINE },
1.16 nicm 114: { 'd', 1, MODEKEYEDIT_DELETELINE },
1.8 nicm 115: { 'D', 1, MODEKEYEDIT_DELETETOENDOFLINE },
116: { '\003' /* C-c */, 1, MODEKEYEDIT_CANCEL },
117: { '\010' /* C-h */, 1, MODEKEYEDIT_BACKSPACE },
118: { '\r', 1, MODEKEYEDIT_ENTER },
119: { '^', 1, MODEKEYEDIT_STARTOFLINE },
120: { 'a', 1, MODEKEYEDIT_SWITCHMODEAPPEND },
121: { 'h', 1, MODEKEYEDIT_CURSORLEFT },
122: { 'i', 1, MODEKEYEDIT_SWITCHMODE },
123: { 'j', 1, MODEKEYEDIT_HISTORYDOWN },
124: { 'k', 1, MODEKEYEDIT_HISTORYUP },
125: { 'l', 1, MODEKEYEDIT_CURSORRIGHT },
126: { 'p', 1, MODEKEYEDIT_PASTE },
127: { KEYC_BSPACE, 1, MODEKEYEDIT_BACKSPACE },
128: { KEYC_DC, 1, MODEKEYEDIT_DELETE },
129: { KEYC_DOWN, 1, MODEKEYEDIT_HISTORYDOWN },
130: { KEYC_LEFT, 1, MODEKEYEDIT_CURSORLEFT },
131: { KEYC_RIGHT, 1, MODEKEYEDIT_CURSORRIGHT },
132: { KEYC_UP, 1, MODEKEYEDIT_HISTORYUP },
133:
134: { 0, -1, 0 }
135: };
1.10 nicm 136: struct mode_key_tree mode_key_tree_vi_edit;
1.8 nicm 137:
138: /* vi choice selection keys. */
139: const struct mode_key_entry mode_key_vi_choice[] = {
140: { '\003' /* C-c */, 0, MODEKEYCHOICE_CANCEL },
141: { '\r', 0, MODEKEYCHOICE_CHOOSE },
142: { 'j', 0, MODEKEYCHOICE_DOWN },
143: { 'k', 0, MODEKEYCHOICE_UP },
144: { 'q', 0, MODEKEYCHOICE_CANCEL },
145: { KEYC_DOWN, 0, MODEKEYCHOICE_DOWN },
146: { KEYC_NPAGE, 0, MODEKEYCHOICE_PAGEDOWN },
147: { KEYC_PPAGE, 0, MODEKEYCHOICE_PAGEUP },
148: { KEYC_UP, 0, MODEKEYCHOICE_UP },
149:
150: { 0, -1, 0 }
151: };
1.10 nicm 152: struct mode_key_tree mode_key_tree_vi_choice;
1.8 nicm 153:
154: /* vi copy mode keys. */
155: const struct mode_key_entry mode_key_vi_copy[] = {
156: { ' ', 0, MODEKEYCOPY_STARTSELECTION },
157: { '$', 0, MODEKEYCOPY_ENDOFLINE },
1.15 nicm 158: { '/', 0, MODEKEYCOPY_SEARCHUP },
1.8 nicm 159: { '0', 0, MODEKEYCOPY_STARTOFLINE },
1.15 nicm 160: { '?', 0, MODEKEYCOPY_SEARCHDOWN },
1.13 nicm 161: { '\002' /* C-b */, 0, MODEKEYCOPY_PREVIOUSPAGE },
1.9 nicm 162: { '\003' /* C-c */, 0, MODEKEYCOPY_CANCEL },
1.13 nicm 163: { '\004' /* C-d */, 0, MODEKEYCOPY_HALFPAGEDOWN },
1.8 nicm 164: { '\006' /* C-f */, 0, MODEKEYCOPY_NEXTPAGE },
165: { '\010' /* C-h */, 0, MODEKEYCOPY_LEFT },
1.13 nicm 166: { '\025' /* C-u */, 0, MODEKEYCOPY_HALFPAGEUP },
1.8 nicm 167: { '\033' /* Escape */, 0, MODEKEYCOPY_CLEARSELECTION },
168: { '\r', 0, MODEKEYCOPY_COPYSELECTION },
169: { '^', 0, MODEKEYCOPY_BACKTOINDENTATION },
170: { 'b', 0, MODEKEYCOPY_PREVIOUSWORD },
1.15 nicm 171: { 'g', 0, MODEKEYCOPY_GOTOLINE },
1.8 nicm 172: { 'h', 0, MODEKEYCOPY_LEFT },
173: { 'j', 0, MODEKEYCOPY_DOWN },
174: { 'k', 0, MODEKEYCOPY_UP },
175: { 'l', 0, MODEKEYCOPY_RIGHT },
1.15 nicm 176: { 'n', 0, MODEKEYCOPY_SEARCHAGAIN },
1.9 nicm 177: { 'q', 0, MODEKEYCOPY_CANCEL },
1.8 nicm 178: { 'w', 0, MODEKEYCOPY_NEXTWORD },
179: { KEYC_BSPACE, 0, MODEKEYCOPY_LEFT },
180: { KEYC_DOWN, 0, MODEKEYCOPY_DOWN },
181: { KEYC_LEFT, 0, MODEKEYCOPY_LEFT },
182: { KEYC_NPAGE, 0, MODEKEYCOPY_NEXTPAGE },
183: { KEYC_PPAGE, 0, MODEKEYCOPY_PREVIOUSPAGE },
184: { KEYC_RIGHT, 0, MODEKEYCOPY_RIGHT },
185: { KEYC_UP, 0, MODEKEYCOPY_UP },
186:
187: { 0, -1, 0 }
188: };
1.10 nicm 189: struct mode_key_tree mode_key_tree_vi_copy;
1.8 nicm 190:
191: /* emacs editing keys. */
192: const struct mode_key_entry mode_key_emacs_edit[] = {
193: { '\001' /* C-a */, 0, MODEKEYEDIT_STARTOFLINE },
194: { '\002' /* C-p */, 0, MODEKEYEDIT_CURSORLEFT },
1.14 nicm 195: { '\003' /* C-c */, 0, MODEKEYEDIT_CANCEL },
1.8 nicm 196: { '\004' /* C-d */, 0, MODEKEYEDIT_DELETE },
197: { '\005' /* C-e */, 0, MODEKEYEDIT_ENDOFLINE },
198: { '\006' /* C-f */, 0, MODEKEYEDIT_CURSORRIGHT },
199: { '\010' /* C-H */, 0, MODEKEYEDIT_BACKSPACE },
1.16 nicm 200: { '\011' /* Tab */, 0, MODEKEYEDIT_COMPLETE },
1.8 nicm 201: { '\013' /* C-k */, 0, MODEKEYEDIT_DELETETOENDOFLINE },
202: { '\016' /* C-n */, 0, MODEKEYEDIT_HISTORYDOWN },
203: { '\020' /* C-p */, 0, MODEKEYEDIT_HISTORYUP },
1.17 ! nicm 204: { '\024' /* C-t */, 0, MODEKEYEDIT_TRANSPOSECHARS },
1.16 nicm 205: { '\025' /* C-u */, 0, MODEKEYEDIT_DELETELINE },
1.8 nicm 206: { '\031' /* C-y */, 0, MODEKEYEDIT_PASTE },
1.14 nicm 207: { '\033' /* Escape */, 0, MODEKEYEDIT_CANCEL },
1.8 nicm 208: { '\r', 0, MODEKEYEDIT_ENTER },
209: { 'm' | KEYC_ESCAPE, 0, MODEKEYEDIT_STARTOFLINE },
210: { KEYC_BSPACE, 0, MODEKEYEDIT_BACKSPACE },
211: { KEYC_DC, 0, MODEKEYEDIT_DELETE },
212: { KEYC_DOWN, 0, MODEKEYEDIT_HISTORYDOWN },
213: { KEYC_LEFT, 0, MODEKEYEDIT_CURSORLEFT },
214: { KEYC_RIGHT, 0, MODEKEYEDIT_CURSORRIGHT },
215: { KEYC_UP, 0, MODEKEYEDIT_HISTORYUP },
216:
217: { 0, -1, 0 }
218: };
1.10 nicm 219: struct mode_key_tree mode_key_tree_emacs_edit;
1.8 nicm 220:
221: /* emacs choice selection keys. */
222: const struct mode_key_entry mode_key_emacs_choice[] = {
223: { '\003' /* C-c */, 0, MODEKEYCHOICE_CANCEL },
224: { '\033' /* Escape */, 0, MODEKEYCHOICE_CANCEL },
225: { '\r', 0, MODEKEYCHOICE_CHOOSE },
226: { 'q', 0, MODEKEYCHOICE_CANCEL },
227: { KEYC_DOWN, 0, MODEKEYCHOICE_DOWN },
228: { KEYC_NPAGE, 0, MODEKEYCHOICE_PAGEDOWN },
229: { KEYC_PPAGE, 0, MODEKEYCHOICE_PAGEUP },
230: { KEYC_UP, 0, MODEKEYCHOICE_UP },
231:
232: { 0, -1, 0 }
233: };
1.10 nicm 234: struct mode_key_tree mode_key_tree_emacs_choice;
1.8 nicm 235:
236: /* emacs copy mode keys. */
237: const struct mode_key_entry mode_key_emacs_copy[] = {
238: { ' ', 0, MODEKEYCOPY_NEXTPAGE },
239: { '\000' /* C-Space */, 0, MODEKEYCOPY_STARTSELECTION },
240: { '\001' /* C-a */, 0, MODEKEYCOPY_STARTOFLINE },
241: { '\002' /* C-b */, 0, MODEKEYCOPY_LEFT },
1.9 nicm 242: { '\003' /* C-c */, 0, MODEKEYCOPY_CANCEL },
1.8 nicm 243: { '\005' /* C-e */, 0, MODEKEYCOPY_ENDOFLINE },
244: { '\006' /* C-f */, 0, MODEKEYCOPY_RIGHT },
245: { '\007' /* C-g */, 0, MODEKEYCOPY_CLEARSELECTION },
246: { '\016' /* C-n */, 0, MODEKEYCOPY_DOWN },
247: { '\020' /* C-p */, 0, MODEKEYCOPY_UP },
1.15 nicm 248: { '\022' /* C-r */, 0, MODEKEYCOPY_SEARCHUP },
249: { '\023' /* C-s */, 0, MODEKEYCOPY_SEARCHDOWN },
1.8 nicm 250: { '\026' /* C-v */, 0, MODEKEYCOPY_NEXTPAGE },
251: { '\027' /* C-w */, 0, MODEKEYCOPY_COPYSELECTION },
1.9 nicm 252: { '\033' /* Escape */, 0, MODEKEYCOPY_CANCEL },
1.8 nicm 253: { 'b' | KEYC_ESCAPE, 0, MODEKEYCOPY_PREVIOUSWORD },
254: { 'f' | KEYC_ESCAPE, 0, MODEKEYCOPY_NEXTWORD },
1.15 nicm 255: { 'g', 0, MODEKEYCOPY_GOTOLINE },
1.8 nicm 256: { 'm' | KEYC_ESCAPE, 0, MODEKEYCOPY_BACKTOINDENTATION },
1.15 nicm 257: { 'n', 0, MODEKEYCOPY_SEARCHAGAIN },
1.9 nicm 258: { 'q', 0, MODEKEYCOPY_CANCEL },
1.8 nicm 259: { 'v' | KEYC_ESCAPE, 0, MODEKEYCOPY_PREVIOUSPAGE },
260: { 'w' | KEYC_ESCAPE, 0, MODEKEYCOPY_COPYSELECTION },
1.13 nicm 261: { KEYC_DOWN | KEYC_ESCAPE, 0, MODEKEYCOPY_HALFPAGEDOWN },
1.8 nicm 262: { KEYC_DOWN, 0, MODEKEYCOPY_DOWN },
263: { KEYC_LEFT, 0, MODEKEYCOPY_LEFT },
264: { KEYC_NPAGE, 0, MODEKEYCOPY_NEXTPAGE },
265: { KEYC_PPAGE, 0, MODEKEYCOPY_PREVIOUSPAGE },
266: { KEYC_RIGHT, 0, MODEKEYCOPY_RIGHT },
1.13 nicm 267: { KEYC_UP | KEYC_ESCAPE, 0, MODEKEYCOPY_HALFPAGEUP },
1.8 nicm 268: { KEYC_UP, 0, MODEKEYCOPY_UP },
269:
270: { 0, -1, 0 }
271: };
1.10 nicm 272: struct mode_key_tree mode_key_tree_emacs_copy;
273:
274: /* Table mapping key table names to default settings and trees. */
275: const struct mode_key_table mode_key_tables[] = {
276: { "vi-edit", mode_key_cmdstr_edit,
277: &mode_key_tree_vi_edit, mode_key_vi_edit },
278: { "vi-choice", mode_key_cmdstr_choice,
279: &mode_key_tree_vi_choice, mode_key_vi_choice },
280: { "vi-copy", mode_key_cmdstr_copy,
281: &mode_key_tree_vi_copy, mode_key_vi_copy },
282: { "emacs-edit", mode_key_cmdstr_edit,
283: &mode_key_tree_emacs_edit, mode_key_emacs_edit },
284: { "emacs-choice", mode_key_cmdstr_choice,
285: &mode_key_tree_emacs_choice, mode_key_emacs_choice },
286: { "emacs-copy", mode_key_cmdstr_copy,
287: &mode_key_tree_emacs_copy, mode_key_emacs_copy },
288:
289: { NULL, NULL, NULL, NULL }
290: };
291:
292: SPLAY_GENERATE(mode_key_tree, mode_key_binding, entry, mode_key_cmp);
293:
294: int
295: mode_key_cmp(struct mode_key_binding *mbind1, struct mode_key_binding *mbind2)
296: {
297: if (mbind1->mode != mbind2->mode)
298: return (mbind1->mode - mbind2->mode);
299: return (mbind1->key - mbind2->key);
300: }
301:
302: const char *
303: mode_key_tostring(struct mode_key_cmdstr *cmdstr, enum mode_key_cmd cmd)
304: {
305: for (; cmdstr->name != NULL; cmdstr++) {
306: if (cmdstr->cmd == cmd)
307: return (cmdstr->name);
1.11 nicm 308: }
309: return (NULL);
310: }
311:
312: enum mode_key_cmd
313: mode_key_fromstring(struct mode_key_cmdstr *cmdstr, const char *name)
314: {
315: for (; cmdstr->name != NULL; cmdstr++) {
316: if (strcasecmp(cmdstr->name, name) == 0)
317: return (cmdstr->cmd);
318: }
319: return (MODEKEY_NONE);
320: }
321:
322: const struct mode_key_table *
323: mode_key_findtable(const char *name)
324: {
325: const struct mode_key_table *mtab;
326:
327: for (mtab = mode_key_tables; mtab->name != NULL; mtab++) {
328: if (strcasecmp(name, mtab->name) == 0)
329: return (mtab);
1.10 nicm 330: }
331: return (NULL);
332: }
1.1 nicm 333:
334: void
1.10 nicm 335: mode_key_init_trees(void)
1.1 nicm 336: {
1.10 nicm 337: const struct mode_key_table *mtab;
338: const struct mode_key_entry *ment;
339: struct mode_key_binding *mbind;
340:
341: for (mtab = mode_key_tables; mtab->name != NULL; mtab++) {
342: SPLAY_INIT(mtab->tree);
343: for (ment = mtab->table; ment->mode != -1; ment++) {
344: mbind = xmalloc(sizeof *mbind);
345: mbind->key = ment->key;
346: mbind->mode = ment->mode;
347: mbind->cmd = ment->cmd;
348: SPLAY_INSERT(mode_key_tree, mtab->tree, mbind);
349: }
350: }
351: }
352:
353: void
354: mode_key_free_trees(void)
355: {
356: const struct mode_key_table *mtab;
357: struct mode_key_binding *mbind;
358:
359: for (mtab = mode_key_tables; mtab->name != NULL; mtab++) {
360: while (!SPLAY_EMPTY(mtab->tree)) {
361: mbind = SPLAY_ROOT(mtab->tree);
362: SPLAY_REMOVE(mode_key_tree, mtab->tree, mbind);
1.12 nicm 363: xfree(mbind);
1.10 nicm 364: }
365: }
366: }
367:
368: void
369: mode_key_init(struct mode_key_data *mdata, struct mode_key_tree *mtree)
370: {
371: mdata->tree = mtree;
1.8 nicm 372: mdata->mode = 0;
1.1 nicm 373: }
374:
375: enum mode_key_cmd
376: mode_key_lookup(struct mode_key_data *mdata, int key)
377: {
1.10 nicm 378: struct mode_key_binding *mbind, mtmp;
379:
380: mtmp.key = key;
381: mtmp.mode = mdata->mode;
382: if ((mbind = SPLAY_FIND(mode_key_tree, mdata->tree, &mtmp)) == NULL) {
383: if (mdata->mode != 0)
384: return (MODEKEY_NONE);
385: return (MODEKEY_OTHER);
386: }
1.1 nicm 387:
1.10 nicm 388: switch (mbind->cmd) {
389: case MODEKEYEDIT_SWITCHMODE:
390: case MODEKEYEDIT_SWITCHMODEAPPEND:
391: mdata->mode = 1 - mdata->mode;
392: /* FALLTHROUGH */
393: default:
394: return (mbind->cmd);
1.1 nicm 395: }
396: }
![[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