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