1 /* $OpenBSD$ */
2 
3 /*
4  * Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com>
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 
21 #include <ctype.h>
22 #include <stdlib.h>
23 #include <string.h>
24 
25 #include "tmux.h"
26 
27 #define DEFAULT_SESSION_MENU \
28 	" 'Next' 'n' {switch-client -n}" \
29 	" 'Previous' 'p' {switch-client -p}" \
30 	" ''" \
31 	" 'Renumber' 'N' {move-window -r}" \
32 	" 'Rename' 'n' {command-prompt -I \"#S\" \"rename-session -- '%%'\"}" \
33 	" ''" \
34 	" 'New Session' 's' {new-session}" \
35 	" 'New Window' 'w' {new-window}"
36 #define DEFAULT_WINDOW_MENU \
37 	" '#{?#{>:#{session_windows},1},,-}Swap Left' 'l' {swap-window -t:-1}" \
38 	" '#{?#{>:#{session_windows},1},,-}Swap Right' 'r' {swap-window -t:+1}" \
39 	" '#{?pane_marked_set,,-}Swap Marked' 's' {swap-window}" \
40 	" ''" \
41 	" 'Kill' 'X' {kill-window}" \
42 	" 'Respawn' 'R' {respawn-window -k}" \
43 	" '#{?pane_marked,Unmark,Mark}' 'm' {select-pane -m}" \
44 	" 'Rename' 'n' {command-prompt -I \"#W\" \"rename-window -- '%%'\"}" \
45 	" ''" \
46 	" 'New After' 'w' {new-window -a}" \
47 	" 'New At End' 'W' {new-window}"
48 #define DEFAULT_PANE_MENU \
49 	" '#{?#{m/r:(copy|view)-mode,#{pane_mode}},Go To Top,}' '<' {send -X history-top}" \
50 	" '#{?#{m/r:(copy|view)-mode,#{pane_mode}},Go To Bottom,}' '>' {send -X history-bottom}" \
51 	" ''" \
52 	" '#{?mouse_word,Search For #[underscore]#{=/9/...:mouse_word},}' 'C-r' {if -F '#{?#{m/r:(copy|view)-mode,#{pane_mode}},0,1}' 'copy-mode -t='; send -Xt= search-backward \"#{q:mouse_word}\"}" \
53 	" '#{?mouse_word,Type #[underscore]#{=/9/...:mouse_word},}' 'C-y' {copy-mode -q; send-keys -l -- \"#{q:mouse_word}\"}" \
54 	" '#{?mouse_word,Copy #[underscore]#{=/9/...:mouse_word},}' 'c' {copy-mode -q; set-buffer -- \"#{q:mouse_word}\"}" \
55 	" '#{?mouse_line,Copy Line,}' 'l' {copy-mode -q; set-buffer -- \"#{q:mouse_line}\"}" \
56 	" ''" \
57 	" 'Horizontal Split' 'h' {split-window -h}" \
58 	" 'Vertical Split' 'v' {split-window -v}" \
59 	" ''" \
60 	" '#{?#{>:#{window_panes},1},,-}Swap Up' 'u' {swap-pane -U}" \
61 	" '#{?#{>:#{window_panes},1},,-}Swap Down' 'd' {swap-pane -D}" \
62 	" '#{?pane_marked_set,,-}Swap Marked' 's' {swap-pane}" \
63 	" ''" \
64 	" 'Kill' 'X' {kill-pane}" \
65 	" 'Respawn' 'R' {respawn-pane -k}" \
66 	" '#{?pane_marked,Unmark,Mark}' 'm' {select-pane -m}" \
67 	" '#{?#{>:#{window_panes},1},,-}#{?window_zoomed_flag,Unzoom,Zoom}' 'z' {resize-pane -Z}"
68 
69 static int key_bindings_cmp(struct key_binding *, struct key_binding *);
70 RB_GENERATE_STATIC(key_bindings, key_binding, entry, key_bindings_cmp);
71 static int key_table_cmp(struct key_table *, struct key_table *);
72 RB_GENERATE_STATIC(key_tables, key_table, entry, key_table_cmp);
73 static struct key_tables key_tables = RB_INITIALIZER(&key_tables);
74 
75 static int
key_table_cmp(struct key_table * table1,struct key_table * table2)76 key_table_cmp(struct key_table *table1, struct key_table *table2)
77 {
78 	return (strcmp(table1->name, table2->name));
79 }
80 
81 static int
key_bindings_cmp(struct key_binding * bd1,struct key_binding * bd2)82 key_bindings_cmp(struct key_binding *bd1, struct key_binding *bd2)
83 {
84 	if (bd1->key < bd2->key)
85 		return (-1);
86 	if (bd1->key > bd2->key)
87 		return (1);
88 	return (0);
89 }
90 
91 static void
key_bindings_free(struct key_binding * bd)92 key_bindings_free(struct key_binding *bd)
93 {
94 	cmd_list_free(bd->cmdlist);
95 	free((void *)bd->note);
96 	free(bd);
97 }
98 
99 struct key_table *
key_bindings_get_table(const char * name,int create)100 key_bindings_get_table(const char *name, int create)
101 {
102 	struct key_table	table_find, *table;
103 
104 	table_find.name = name;
105 	table = RB_FIND(key_tables, &key_tables, &table_find);
106 	if (table != NULL || !create)
107 		return (table);
108 
109 	table = xmalloc(sizeof *table);
110 	table->name = xstrdup(name);
111 	RB_INIT(&table->key_bindings);
112 	RB_INIT(&table->default_key_bindings);
113 
114 	table->references = 1; /* one reference in key_tables */
115 	RB_INSERT(key_tables, &key_tables, table);
116 
117 	return (table);
118 }
119 
120 struct key_table *
key_bindings_first_table(void)121 key_bindings_first_table(void)
122 {
123 	return (RB_MIN(key_tables, &key_tables));
124 }
125 
126 struct key_table *
key_bindings_next_table(struct key_table * table)127 key_bindings_next_table(struct key_table *table)
128 {
129 	return (RB_NEXT(key_tables, &key_tables, table));
130 }
131 
132 void
key_bindings_unref_table(struct key_table * table)133 key_bindings_unref_table(struct key_table *table)
134 {
135 	struct key_binding	*bd;
136 	struct key_binding	*bd1;
137 
138 	if (--table->references != 0)
139 		return;
140 
141 	RB_FOREACH_SAFE(bd, key_bindings, &table->key_bindings, bd1) {
142 		RB_REMOVE(key_bindings, &table->key_bindings, bd);
143 		key_bindings_free(bd);
144 	}
145 	RB_FOREACH_SAFE(bd, key_bindings, &table->default_key_bindings, bd1) {
146 		RB_REMOVE(key_bindings, &table->default_key_bindings, bd);
147 		key_bindings_free(bd);
148 	}
149 
150 	free((void *)table->name);
151 	free(table);
152 }
153 
154 struct key_binding *
key_bindings_get(struct key_table * table,key_code key)155 key_bindings_get(struct key_table *table, key_code key)
156 {
157 	struct key_binding	bd;
158 
159 	bd.key = key;
160 	return (RB_FIND(key_bindings, &table->key_bindings, &bd));
161 }
162 
163 struct key_binding *
key_bindings_get_default(struct key_table * table,key_code key)164 key_bindings_get_default(struct key_table *table, key_code key)
165 {
166 	struct key_binding	bd;
167 
168 	bd.key = key;
169 	return (RB_FIND(key_bindings, &table->default_key_bindings, &bd));
170 }
171 
172 struct key_binding *
key_bindings_first(struct key_table * table)173 key_bindings_first(struct key_table *table)
174 {
175 	return (RB_MIN(key_bindings, &table->key_bindings));
176 }
177 
178 struct key_binding *
key_bindings_next(__unused struct key_table * table,struct key_binding * bd)179 key_bindings_next(__unused struct key_table *table, struct key_binding *bd)
180 {
181 	return (RB_NEXT(key_bindings, &table->key_bindings, bd));
182 }
183 
184 void
key_bindings_add(const char * name,key_code key,const char * note,int repeat,struct cmd_list * cmdlist)185 key_bindings_add(const char *name, key_code key, const char *note, int repeat,
186     struct cmd_list *cmdlist)
187 {
188 	struct key_table	*table;
189 	struct key_binding	*bd;
190 
191 	table = key_bindings_get_table(name, 1);
192 
193 	bd = key_bindings_get(table, key & ~KEYC_MASK_FLAGS);
194 	if (cmdlist == NULL) {
195 		if (bd != NULL) {
196 			free((void *)bd->note);
197 			if (note != NULL)
198 				bd->note = xstrdup(note);
199 			else
200 				bd->note = NULL;
201 		}
202 		return;
203 	}
204 	if (bd != NULL) {
205 		RB_REMOVE(key_bindings, &table->key_bindings, bd);
206 		key_bindings_free(bd);
207 	}
208 
209 	bd = xcalloc(1, sizeof *bd);
210 	bd->key = (key & ~KEYC_MASK_FLAGS);
211 	if (note != NULL)
212 		bd->note = xstrdup(note);
213 	RB_INSERT(key_bindings, &table->key_bindings, bd);
214 
215 	if (repeat)
216 		bd->flags |= KEY_BINDING_REPEAT;
217 	bd->cmdlist = cmdlist;
218 
219 	log_debug("%s: %#llx %s = %s", __func__, bd->key,
220 	    key_string_lookup_key(bd->key, 1), cmd_list_print(bd->cmdlist, 0));
221 }
222 
223 void
key_bindings_remove(const char * name,key_code key)224 key_bindings_remove(const char *name, key_code key)
225 {
226 	struct key_table	*table;
227 	struct key_binding	*bd;
228 
229 	table = key_bindings_get_table(name, 0);
230 	if (table == NULL)
231 		return;
232 
233 	bd = key_bindings_get(table, key & ~KEYC_MASK_FLAGS);
234 	if (bd == NULL)
235 		return;
236 
237 	log_debug("%s: %#llx %s", __func__, bd->key,
238 	    key_string_lookup_key(bd->key, 1));
239 
240 	RB_REMOVE(key_bindings, &table->key_bindings, bd);
241 	key_bindings_free(bd);
242 
243 	if (RB_EMPTY(&table->key_bindings) &&
244 	    RB_EMPTY(&table->default_key_bindings)) {
245 		RB_REMOVE(key_tables, &key_tables, table);
246 		key_bindings_unref_table(table);
247 	}
248 }
249 
250 void
key_bindings_reset(const char * name,key_code key)251 key_bindings_reset(const char *name, key_code key)
252 {
253 	struct key_table	*table;
254 	struct key_binding	*bd, *dd;
255 
256 	table = key_bindings_get_table(name, 0);
257 	if (table == NULL)
258 		return;
259 
260 	bd = key_bindings_get(table, key & ~KEYC_MASK_FLAGS);
261 	if (bd == NULL)
262 		return;
263 
264 	dd = key_bindings_get_default(table, bd->key);
265 	if (dd == NULL) {
266 		key_bindings_remove(name, bd->key);
267 		return;
268 	}
269 
270 	cmd_list_free(bd->cmdlist);
271 	bd->cmdlist = dd->cmdlist;
272 	bd->cmdlist->references++;
273 
274 	free((void *)bd->note);
275 	if (dd->note != NULL)
276 		bd->note = xstrdup(dd->note);
277 	else
278 		bd->note = NULL;
279 	bd->flags = dd->flags;
280 }
281 
282 void
key_bindings_remove_table(const char * name)283 key_bindings_remove_table(const char *name)
284 {
285 	struct key_table	*table;
286 	struct client		*c;
287 
288 	table = key_bindings_get_table(name, 0);
289 	if (table != NULL) {
290 		RB_REMOVE(key_tables, &key_tables, table);
291 		key_bindings_unref_table(table);
292 	}
293 	TAILQ_FOREACH(c, &clients, entry) {
294 		if (c->keytable == table)
295 			server_client_set_key_table(c, NULL);
296 	}
297 }
298 
299 void
key_bindings_reset_table(const char * name)300 key_bindings_reset_table(const char *name)
301 {
302 	struct key_table	*table;
303 	struct key_binding	*bd, *bd1;
304 
305 	table = key_bindings_get_table(name, 0);
306 	if (table == NULL)
307 		return;
308 	if (RB_EMPTY(&table->default_key_bindings)) {
309 		key_bindings_remove_table(name);
310 		return;
311 	}
312 	RB_FOREACH_SAFE(bd, key_bindings, &table->key_bindings, bd1)
313 		key_bindings_reset(name, bd->key);
314 }
315 
316 static enum cmd_retval
key_bindings_init_done(__unused struct cmdq_item * item,__unused void * data)317 key_bindings_init_done(__unused struct cmdq_item *item, __unused void *data)
318 {
319 	struct key_table	*table;
320 	struct key_binding	*bd, *new_bd;
321 
322 	RB_FOREACH(table, key_tables, &key_tables) {
323 		RB_FOREACH(bd, key_bindings, &table->key_bindings) {
324 			new_bd = xcalloc(1, sizeof *bd);
325 			new_bd->key = bd->key;
326 			if (bd->note != NULL)
327 				new_bd->note = xstrdup(bd->note);
328 			new_bd->flags = bd->flags;
329 			new_bd->cmdlist = bd->cmdlist;
330 			new_bd->cmdlist->references++;
331 			RB_INSERT(key_bindings, &table->default_key_bindings,
332 			    new_bd);
333 		}
334 	}
335 	return (CMD_RETURN_NORMAL);
336 }
337 
338 void
key_bindings_init(void)339 key_bindings_init(void)
340 {
341 	static const char *defaults[] = {
342 		/* Prefix keys. */
343 		"bind -N 'Send the prefix key' C-b send-prefix",
344 		"bind -N 'Rotate through the panes' C-o rotate-window",
345 		"bind -N 'Suspend the current client' C-z suspend-client",
346 		"bind -N 'Select next layout' Space next-layout",
347 		"bind -N 'Break pane to a new window' ! break-pane",
348 		"bind -N 'Split window vertically' '\"' split-window",
349 		"bind -N 'List all paste buffers' '#' list-buffers",
350 		"bind -N 'Rename current session' '$' command-prompt -I'#S' \"rename-session -- '%%'\"",
351 		"bind -N 'Split window horizontally' % split-window -h",
352 		"bind -N 'Kill current window' & confirm-before -p\"kill-window #W? (y/n)\" kill-window",
353 		"bind -N 'Prompt for window index to select' \"'\" command-prompt -Wpindex \"select-window -t ':%%'\"",
354 		"bind -N 'Switch to previous client' ( switch-client -p",
355 		"bind -N 'Switch to next client' ) switch-client -n",
356 		"bind -N 'Rename current window' , command-prompt -I'#W' \"rename-window -- '%%'\"",
357 		"bind -N 'Delete the most recent paste buffer' - delete-buffer",
358 		"bind -N 'Move the current window' . command-prompt -T \"move-window -t '%%'\"",
359 		"bind -N 'Describe key binding' '/' command-prompt -kpkey 'list-keys -1N \"%%%\"'",
360 		"bind -N 'Select window 0' 0 select-window -t:=0",
361 		"bind -N 'Select window 1' 1 select-window -t:=1",
362 		"bind -N 'Select window 2' 2 select-window -t:=2",
363 		"bind -N 'Select window 3' 3 select-window -t:=3",
364 		"bind -N 'Select window 4' 4 select-window -t:=4",
365 		"bind -N 'Select window 5' 5 select-window -t:=5",
366 		"bind -N 'Select window 6' 6 select-window -t:=6",
367 		"bind -N 'Select window 7' 7 select-window -t:=7",
368 		"bind -N 'Select window 8' 8 select-window -t:=8",
369 		"bind -N 'Select window 9' 9 select-window -t:=9",
370 		"bind -N 'Prompt for a command' : command-prompt",
371 		"bind -N 'Move to the previously active pane' \\; last-pane",
372 		"bind -N 'Choose a paste buffer from a list' = choose-buffer -Z",
373 		"bind -N 'List key bindings' ? list-keys -N",
374 		"bind -N 'Choose a client from a list' D choose-client -Z",
375 		"bind -N 'Spread panes out evenly' E select-layout -E",
376 		"bind -N 'Switch to the last client' L switch-client -l",
377 		"bind -N 'Clear the marked pane' M select-pane -M",
378 		"bind -N 'Enter copy mode' [ copy-mode",
379 		"bind -N 'Paste the most recent paste buffer' ] paste-buffer -p",
380 		"bind -N 'Create a new window' c new-window",
381 		"bind -N 'Detach the current client' d detach-client",
382 		"bind -N 'Search for a pane' f command-prompt \"find-window -Z -- '%%'\"",
383 		"bind -N 'Display window information' i display-message",
384 		"bind -N 'Select the previously current window' l last-window",
385 		"bind -N 'Toggle the marked pane' m select-pane -m",
386 		"bind -N 'Select the next window' n next-window",
387 		"bind -N 'Select the next pane' o select-pane -t:.+",
388 		"bind -N 'Customize options' C customize-mode -Z",
389 		"bind -N 'Select the previous window' p previous-window",
390 		"bind -N 'Display pane numbers' q display-panes",
391 		"bind -N 'Redraw the current client' r refresh-client",
392 		"bind -N 'Choose a session from a list' s choose-tree -Zs",
393 		"bind -N 'Show a clock' t clock-mode",
394 		"bind -N 'Choose a window from a list' w choose-tree -Zw",
395 		"bind -N 'Kill the active pane' x confirm-before -p\"kill-pane #P? (y/n)\" kill-pane",
396 		"bind -N 'Zoom the active pane' z resize-pane -Z",
397 		"bind -N 'Swap the active pane with the pane above' '{' swap-pane -U",
398 		"bind -N 'Swap the active pane with the pane below' '}' swap-pane -D",
399 		"bind -N 'Show messages' '~' show-messages",
400 		"bind -N 'Enter copy mode and scroll up' PPage copy-mode -u",
401 		"bind -N 'Select the pane above the active pane' -r Up select-pane -U",
402 		"bind -N 'Select the pane below the active pane' -r Down select-pane -D",
403 		"bind -N 'Select the pane to the left of the active pane' -r Left select-pane -L",
404 		"bind -N 'Select the pane to the right of the active pane' -r Right select-pane -R",
405 		"bind -N 'Set the even-horizontal layout' M-1 select-layout even-horizontal",
406 		"bind -N 'Set the even-vertical layout' M-2 select-layout even-vertical",
407 		"bind -N 'Set the main-horizontal layout' M-3 select-layout main-horizontal",
408 		"bind -N 'Set the main-vertical layout' M-4 select-layout main-vertical",
409 		"bind -N 'Select the tiled layout' M-5 select-layout tiled",
410 		"bind -N 'Select the next window with an alert' M-n next-window -a",
411 		"bind -N 'Rotate through the panes in reverse' M-o rotate-window -D",
412 		"bind -N 'Select the previous window with an alert' M-p previous-window -a",
413 		"bind -N 'Move the visible part of the window up' -r S-Up refresh-client -U 10",
414 		"bind -N 'Move the visible part of the window down' -r S-Down refresh-client -D 10",
415 		"bind -N 'Move the visible part of the window left' -r S-Left refresh-client -L 10",
416 		"bind -N 'Move the visible part of the window right' -r S-Right refresh-client -R 10",
417 		"bind -N 'Reset so the visible part of the window follows the cursor' -r DC refresh-client -c",
418 		"bind -N 'Resize the pane up by 5' -r M-Up resize-pane -U 5",
419 		"bind -N 'Resize the pane down by 5' -r M-Down resize-pane -D 5",
420 		"bind -N 'Resize the pane left by 5' -r M-Left resize-pane -L 5",
421 		"bind -N 'Resize the pane right by 5' -r M-Right resize-pane -R 5",
422 		"bind -N 'Resize the pane up' -r C-Up resize-pane -U",
423 		"bind -N 'Resize the pane down' -r C-Down resize-pane -D",
424 		"bind -N 'Resize the pane left' -r C-Left resize-pane -L",
425 		"bind -N 'Resize the pane right' -r C-Right resize-pane -R",
426 
427 		/* Menu keys */
428 		"bind < display-menu -xW -yW -T '#[align=centre]#{window_index}:#{window_name}' " DEFAULT_WINDOW_MENU,
429 		"bind > display-menu -xP -yP -T '#[align=centre]#{pane_index} (#{pane_id})' " DEFAULT_PANE_MENU,
430 
431 		/* Mouse button 1 down on pane. */
432 		"bind -n MouseDown1Pane select-pane -t=\\; send -M",
433 
434 		/* Mouse button 1 drag on pane. */
435 		"bind -n MouseDrag1Pane if -F '#{||:#{pane_in_mode},#{mouse_any_flag}}' { send -M } { copy-mode -M }",
436 
437 		/* Mouse wheel up on pane. */
438 		"bind -n WheelUpPane if -F '#{||:#{pane_in_mode},#{mouse_any_flag}}' { send -M } { copy-mode -e }",
439 
440 		/* Mouse button 2 down on pane. */
441 		"bind -n MouseDown2Pane select-pane -t=\\; if -F '#{||:#{pane_in_mode},#{mouse_any_flag}}' { send -M } { paste -p }",
442 
443 		/* Mouse button 1 double click on pane. */
444 		"bind -n DoubleClick1Pane select-pane -t=\\; if -F '#{||:#{pane_in_mode},#{mouse_any_flag}}' { send -M } { copy-mode -H; send -X select-word; run -d0.3; send -X copy-pipe-and-cancel }",
445 
446 		/* Mouse button 1 triple click on pane. */
447 		"bind -n TripleClick1Pane select-pane -t=\\; if -F '#{||:#{pane_in_mode},#{mouse_any_flag}}' { send -M } { copy-mode -H; send -X select-line; run -d0.3; send -X copy-pipe-and-cancel }",
448 
449 		/* Mouse button 1 drag on border. */
450 		"bind -n MouseDrag1Border resize-pane -M",
451 
452 		/* Mouse button 1 down on status line. */
453 		"bind -n MouseDown1Status select-window -t=",
454 
455 		/* Mouse wheel down on status line. */
456 		"bind -n WheelDownStatus next-window",
457 
458 		/* Mouse wheel up on status line. */
459 		"bind -n WheelUpStatus previous-window",
460 
461 		/* Mouse button 3 down on status left. */
462 		"bind -n MouseDown3StatusLeft display-menu -t= -xM -yW -T '#[align=centre]#{session_name}' " DEFAULT_SESSION_MENU,
463 
464 		/* Mouse button 3 down on status line. */
465 		"bind -n MouseDown3Status display-menu -t= -xW -yW -T '#[align=centre]#{window_index}:#{window_name}' " DEFAULT_WINDOW_MENU,
466 
467 		/* Mouse button 3 down on pane. */
468 		"bind -n MouseDown3Pane if -Ft= '#{||:#{mouse_any_flag},#{&&:#{pane_in_mode},#{?#{m/r:(copy|view)-mode,#{pane_mode}},0,1}}}' { select-pane -t=; send -M } { display-menu -t= -xM -yM -T '#[align=centre]#{pane_index} (#{pane_id})' " DEFAULT_PANE_MENU " }",
469 		"bind -n M-MouseDown3Pane display-menu -t= -xM -yM -T '#[align=centre]#{pane_index} (#{pane_id})' " DEFAULT_PANE_MENU,
470 
471 		/* Copy mode (emacs) keys. */
472 		"bind -Tcopy-mode C-Space send -X begin-selection",
473 		"bind -Tcopy-mode C-a send -X start-of-line",
474 		"bind -Tcopy-mode C-c send -X cancel",
475 		"bind -Tcopy-mode C-e send -X end-of-line",
476 		"bind -Tcopy-mode C-f send -X cursor-right",
477 		"bind -Tcopy-mode C-b send -X cursor-left",
478 		"bind -Tcopy-mode C-g send -X clear-selection",
479 		"bind -Tcopy-mode C-k send -X copy-end-of-line",
480 		"bind -Tcopy-mode C-n send -X cursor-down",
481 		"bind -Tcopy-mode C-p send -X cursor-up",
482 		"bind -Tcopy-mode C-r command-prompt -ip'(search up)' -I'#{pane_search_string}' 'send -X search-backward-incremental \"%%%\"'",
483 		"bind -Tcopy-mode C-s command-prompt -ip'(search down)' -I'#{pane_search_string}' 'send -X search-forward-incremental \"%%%\"'",
484 		"bind -Tcopy-mode C-v send -X page-down",
485 		"bind -Tcopy-mode C-w send -X copy-pipe-and-cancel",
486 		"bind -Tcopy-mode Escape send -X cancel",
487 		"bind -Tcopy-mode Space send -X page-down",
488 		"bind -Tcopy-mode , send -X jump-reverse",
489 		"bind -Tcopy-mode \\; send -X jump-again",
490 		"bind -Tcopy-mode F command-prompt -1p'(jump backward)' 'send -X jump-backward \"%%%\"'",
491 		"bind -Tcopy-mode N send -X search-reverse",
492 		"bind -Tcopy-mode R send -X rectangle-toggle",
493 		"bind -Tcopy-mode T command-prompt -1p'(jump to backward)' 'send -X jump-to-backward \"%%%\"'",
494 		"bind -Tcopy-mode X send -X set-mark",
495 		"bind -Tcopy-mode f command-prompt -1p'(jump forward)' 'send -X jump-forward \"%%%\"'",
496 		"bind -Tcopy-mode g command-prompt -p'(goto line)' 'send -X goto-line \"%%%\"'",
497 		"bind -Tcopy-mode n send -X search-again",
498 		"bind -Tcopy-mode q send -X cancel",
499 		"bind -Tcopy-mode r send -X refresh-from-pane",
500 		"bind -Tcopy-mode t command-prompt -1p'(jump to forward)' 'send -X jump-to-forward \"%%%\"'",
501 		"bind -Tcopy-mode Home send -X start-of-line",
502 		"bind -Tcopy-mode End send -X end-of-line",
503 		"bind -Tcopy-mode MouseDown1Pane select-pane",
504 		"bind -Tcopy-mode MouseDrag1Pane select-pane\\; send -X begin-selection",
505 		"bind -Tcopy-mode MouseDragEnd1Pane send -X copy-pipe-and-cancel",
506 		"bind -Tcopy-mode WheelUpPane select-pane\\; send -N5 -X scroll-up",
507 		"bind -Tcopy-mode WheelDownPane select-pane\\; send -N5 -X scroll-down",
508 		"bind -Tcopy-mode DoubleClick1Pane select-pane\\; send -X select-word\\; run -d0.3\\; send -X copy-pipe-and-cancel",
509 		"bind -Tcopy-mode TripleClick1Pane select-pane\\; send -X select-line\\; run -d0.3\\; send -X copy-pipe-and-cancel",
510 		"bind -Tcopy-mode NPage send -X page-down",
511 		"bind -Tcopy-mode PPage send -X page-up",
512 		"bind -Tcopy-mode Up send -X cursor-up",
513 		"bind -Tcopy-mode Down send -X cursor-down",
514 		"bind -Tcopy-mode Left send -X cursor-left",
515 		"bind -Tcopy-mode Right send -X cursor-right",
516 		"bind -Tcopy-mode M-1 command-prompt -Np'(repeat)' -I1 'send -N \"%%%\"'",
517 		"bind -Tcopy-mode M-2 command-prompt -Np'(repeat)' -I2 'send -N \"%%%\"'",
518 		"bind -Tcopy-mode M-3 command-prompt -Np'(repeat)' -I3 'send -N \"%%%\"'",
519 		"bind -Tcopy-mode M-4 command-prompt -Np'(repeat)' -I4 'send -N \"%%%\"'",
520 		"bind -Tcopy-mode M-5 command-prompt -Np'(repeat)' -I5 'send -N \"%%%\"'",
521 		"bind -Tcopy-mode M-6 command-prompt -Np'(repeat)' -I6 'send -N \"%%%\"'",
522 		"bind -Tcopy-mode M-7 command-prompt -Np'(repeat)' -I7 'send -N \"%%%\"'",
523 		"bind -Tcopy-mode M-8 command-prompt -Np'(repeat)' -I8 'send -N \"%%%\"'",
524 		"bind -Tcopy-mode M-9 command-prompt -Np'(repeat)' -I9 'send -N \"%%%\"'",
525 		"bind -Tcopy-mode M-< send -X history-top",
526 		"bind -Tcopy-mode M-> send -X history-bottom",
527 		"bind -Tcopy-mode M-R send -X top-line",
528 		"bind -Tcopy-mode M-b send -X previous-word",
529 		"bind -Tcopy-mode C-M-b send -X previous-matching-bracket",
530 		"bind -Tcopy-mode M-f send -X next-word-end",
531 		"bind -Tcopy-mode C-M-f send -X next-matching-bracket",
532 		"bind -Tcopy-mode M-m send -X back-to-indentation",
533 		"bind -Tcopy-mode M-r send -X middle-line",
534 		"bind -Tcopy-mode M-v send -X page-up",
535 		"bind -Tcopy-mode M-w send -X copy-pipe-and-cancel",
536 		"bind -Tcopy-mode M-x send -X jump-to-mark",
537 		"bind -Tcopy-mode 'M-{' send -X previous-paragraph",
538 		"bind -Tcopy-mode 'M-}' send -X next-paragraph",
539 		"bind -Tcopy-mode M-Up send -X halfpage-up",
540 		"bind -Tcopy-mode M-Down send -X halfpage-down",
541 		"bind -Tcopy-mode C-Up send -X scroll-up",
542 		"bind -Tcopy-mode C-Down send -X scroll-down",
543 
544 		/* Copy mode (vi) keys. */
545 		"bind -Tcopy-mode-vi '#' send -FX search-backward '#{copy_cursor_word}'",
546 		"bind -Tcopy-mode-vi * send -FX search-forward '#{copy_cursor_word}'",
547 		"bind -Tcopy-mode-vi C-c send -X cancel",
548 		"bind -Tcopy-mode-vi C-d send -X halfpage-down",
549 		"bind -Tcopy-mode-vi C-e send -X scroll-down",
550 		"bind -Tcopy-mode-vi C-b send -X page-up",
551 		"bind -Tcopy-mode-vi C-f send -X page-down",
552 		"bind -Tcopy-mode-vi C-h send -X cursor-left",
553 		"bind -Tcopy-mode-vi C-j send -X copy-pipe-and-cancel",
554 		"bind -Tcopy-mode-vi Enter send -X copy-pipe-and-cancel",
555 		"bind -Tcopy-mode-vi C-u send -X halfpage-up",
556 		"bind -Tcopy-mode-vi C-v send -X rectangle-toggle",
557 		"bind -Tcopy-mode-vi C-y send -X scroll-up",
558 		"bind -Tcopy-mode-vi Escape send -X clear-selection",
559 		"bind -Tcopy-mode-vi Space send -X begin-selection",
560 		"bind -Tcopy-mode-vi '$' send -X end-of-line",
561 		"bind -Tcopy-mode-vi , send -X jump-reverse",
562 		"bind -Tcopy-mode-vi / command-prompt -p'(search down)' 'send -X search-forward \"%%%\"'",
563 		"bind -Tcopy-mode-vi 0 send -X start-of-line",
564 		"bind -Tcopy-mode-vi 1 command-prompt -Np'(repeat)' -I1 'send -N \"%%%\"'",
565 		"bind -Tcopy-mode-vi 2 command-prompt -Np'(repeat)' -I2 'send -N \"%%%\"'",
566 		"bind -Tcopy-mode-vi 3 command-prompt -Np'(repeat)' -I3 'send -N \"%%%\"'",
567 		"bind -Tcopy-mode-vi 4 command-prompt -Np'(repeat)' -I4 'send -N \"%%%\"'",
568 		"bind -Tcopy-mode-vi 5 command-prompt -Np'(repeat)' -I5 'send -N \"%%%\"'",
569 		"bind -Tcopy-mode-vi 6 command-prompt -Np'(repeat)' -I6 'send -N \"%%%\"'",
570 		"bind -Tcopy-mode-vi 7 command-prompt -Np'(repeat)' -I7 'send -N \"%%%\"'",
571 		"bind -Tcopy-mode-vi 8 command-prompt -Np'(repeat)' -I8 'send -N \"%%%\"'",
572 		"bind -Tcopy-mode-vi 9 command-prompt -Np'(repeat)' -I9 'send -N \"%%%\"'",
573 		"bind -Tcopy-mode-vi : command-prompt -p'(goto line)' 'send -X goto-line \"%%%\"'",
574 		"bind -Tcopy-mode-vi \\; send -X jump-again",
575 		"bind -Tcopy-mode-vi ? command-prompt -p'(search up)' 'send -X search-backward \"%%%\"'",
576 		"bind -Tcopy-mode-vi A send -X append-selection-and-cancel",
577 		"bind -Tcopy-mode-vi B send -X previous-space",
578 		"bind -Tcopy-mode-vi D send -X copy-end-of-line",
579 		"bind -Tcopy-mode-vi E send -X next-space-end",
580 		"bind -Tcopy-mode-vi F command-prompt -1p'(jump backward)' 'send -X jump-backward \"%%%\"'",
581 		"bind -Tcopy-mode-vi G send -X history-bottom",
582 		"bind -Tcopy-mode-vi H send -X top-line",
583 		"bind -Tcopy-mode-vi J send -X scroll-down",
584 		"bind -Tcopy-mode-vi K send -X scroll-up",
585 		"bind -Tcopy-mode-vi L send -X bottom-line",
586 		"bind -Tcopy-mode-vi M send -X middle-line",
587 		"bind -Tcopy-mode-vi N send -X search-reverse",
588 		"bind -Tcopy-mode-vi T command-prompt -1p'(jump to backward)' 'send -X jump-to-backward \"%%%\"'",
589 		"bind -Tcopy-mode-vi V send -X select-line",
590 		"bind -Tcopy-mode-vi W send -X next-space",
591 		"bind -Tcopy-mode-vi X send -X set-mark",
592 		"bind -Tcopy-mode-vi ^ send -X back-to-indentation",
593 		"bind -Tcopy-mode-vi b send -X previous-word",
594 		"bind -Tcopy-mode-vi e send -X next-word-end",
595 		"bind -Tcopy-mode-vi f command-prompt -1p'(jump forward)' 'send -X jump-forward \"%%%\"'",
596 		"bind -Tcopy-mode-vi g send -X history-top",
597 		"bind -Tcopy-mode-vi h send -X cursor-left",
598 		"bind -Tcopy-mode-vi j send -X cursor-down",
599 		"bind -Tcopy-mode-vi k send -X cursor-up",
600 		"bind -Tcopy-mode-vi l send -X cursor-right",
601 		"bind -Tcopy-mode-vi n send -X search-again",
602 		"bind -Tcopy-mode-vi o send -X other-end",
603 		"bind -Tcopy-mode-vi q send -X cancel",
604 		"bind -Tcopy-mode-vi r send -X refresh-from-pane",
605 		"bind -Tcopy-mode-vi t command-prompt -1p'(jump to forward)' 'send -X jump-to-forward \"%%%\"'",
606 		"bind -Tcopy-mode-vi v send -X rectangle-toggle",
607 		"bind -Tcopy-mode-vi w send -X next-word",
608 		"bind -Tcopy-mode-vi '{' send -X previous-paragraph",
609 		"bind -Tcopy-mode-vi '}' send -X next-paragraph",
610 		"bind -Tcopy-mode-vi % send -X next-matching-bracket",
611 		"bind -Tcopy-mode-vi MouseDown1Pane select-pane",
612 		"bind -Tcopy-mode-vi MouseDrag1Pane select-pane\\; send -X begin-selection",
613 		"bind -Tcopy-mode-vi MouseDragEnd1Pane send -X copy-pipe-and-cancel",
614 		"bind -Tcopy-mode-vi WheelUpPane select-pane\\; send -N5 -X scroll-up",
615 		"bind -Tcopy-mode-vi WheelDownPane select-pane\\; send -N5 -X scroll-down",
616 		"bind -Tcopy-mode-vi DoubleClick1Pane select-pane\\; send -X select-word\\; run -d0.3\\; send -X copy-pipe-and-cancel",
617 		"bind -Tcopy-mode-vi TripleClick1Pane select-pane\\; send -X select-line\\; run -d0.3\\; send -X copy-pipe-and-cancel",
618 		"bind -Tcopy-mode-vi BSpace send -X cursor-left",
619 		"bind -Tcopy-mode-vi NPage send -X page-down",
620 		"bind -Tcopy-mode-vi PPage send -X page-up",
621 		"bind -Tcopy-mode-vi Up send -X cursor-up",
622 		"bind -Tcopy-mode-vi Down send -X cursor-down",
623 		"bind -Tcopy-mode-vi Left send -X cursor-left",
624 		"bind -Tcopy-mode-vi Right send -X cursor-right",
625 		"bind -Tcopy-mode-vi M-x send -X jump-to-mark",
626 		"bind -Tcopy-mode-vi C-Up send -X scroll-up",
627 		"bind -Tcopy-mode-vi C-Down send -X scroll-down",
628 	};
629 	u_int			 i;
630 	struct cmd_parse_result	*pr;
631 
632 	for (i = 0; i < nitems(defaults); i++) {
633 		pr = cmd_parse_from_string(defaults[i], NULL);
634 		if (pr->status != CMD_PARSE_SUCCESS)
635 			fatalx("bad default key: %s", defaults[i]);
636 		cmdq_append(NULL, cmdq_get_command(pr->cmdlist, NULL));
637 		cmd_list_free(pr->cmdlist);
638 	}
639 	cmdq_append(NULL, cmdq_get_callback(key_bindings_init_done, NULL));
640 }
641 
642 static enum cmd_retval
key_bindings_read_only(struct cmdq_item * item,__unused void * data)643 key_bindings_read_only(struct cmdq_item *item, __unused void *data)
644 {
645 	cmdq_error(item, "client is read-only");
646 	return (CMD_RETURN_ERROR);
647 }
648 
649 struct cmdq_item *
key_bindings_dispatch(struct key_binding * bd,struct cmdq_item * item,struct client * c,struct key_event * event,struct cmd_find_state * fs)650 key_bindings_dispatch(struct key_binding *bd, struct cmdq_item *item,
651     struct client *c, struct key_event *event, struct cmd_find_state *fs)
652 {
653 	struct cmdq_item	*new_item;
654 	struct cmdq_state	*new_state;
655 	int			 readonly, flags = 0;
656 
657 	if (c == NULL || (~c->flags & CLIENT_READONLY))
658 		readonly = 1;
659 	else
660 		readonly = cmd_list_all_have(bd->cmdlist, CMD_READONLY);
661 	if (!readonly)
662 		new_item = cmdq_get_callback(key_bindings_read_only, NULL);
663 	else {
664 		if (bd->flags & KEY_BINDING_REPEAT)
665 			flags |= CMDQ_STATE_REPEAT;
666 		new_state = cmdq_new_state(fs, event, flags);
667 		new_item = cmdq_get_command(bd->cmdlist, new_state);
668 		cmdq_free_state(new_state);
669 	}
670 	if (item != NULL)
671 		new_item = cmdq_insert_after(item, new_item);
672 	else
673 		new_item = cmdq_append(c, new_item);
674 	return (new_item);
675 }
676