xref: /openbsd-src/usr.bin/tmux/key-bindings.c (revision 4e1ee0786f11cc571bd0be17d38e46f635c719fc)
1 /* $OpenBSD: key-bindings.c,v 1.141 2021/08/27 17:25:55 nicm Exp $ */
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 -FI \"#W\" {rename-window -t '#{window_id}' -- '%%'}}" \
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
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
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
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 *
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 *
121 key_bindings_first_table(void)
122 {
123 	return (RB_MIN(key_tables, &key_tables));
124 }
125 
126 struct key_table *
127 key_bindings_next_table(struct key_table *table)
128 {
129 	return (RB_NEXT(key_tables, &key_tables, table));
130 }
131 
132 void
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 *
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 *
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 *
173 key_bindings_first(struct key_table *table)
174 {
175 	return (RB_MIN(key_bindings, &table->key_bindings));
176 }
177 
178 struct key_binding *
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
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 	char			*s;
191 
192 	table = key_bindings_get_table(name, 1);
193 
194 	bd = key_bindings_get(table, key & ~KEYC_MASK_FLAGS);
195 	if (cmdlist == NULL) {
196 		if (bd != NULL) {
197 			free((void *)bd->note);
198 			if (note != NULL)
199 				bd->note = xstrdup(note);
200 			else
201 				bd->note = NULL;
202 		}
203 		return;
204 	}
205 	if (bd != NULL) {
206 		RB_REMOVE(key_bindings, &table->key_bindings, bd);
207 		key_bindings_free(bd);
208 	}
209 
210 	bd = xcalloc(1, sizeof *bd);
211 	bd->key = (key & ~KEYC_MASK_FLAGS);
212 	if (note != NULL)
213 		bd->note = xstrdup(note);
214 	RB_INSERT(key_bindings, &table->key_bindings, bd);
215 
216 	if (repeat)
217 		bd->flags |= KEY_BINDING_REPEAT;
218 	bd->cmdlist = cmdlist;
219 
220 	s = cmd_list_print(bd->cmdlist, 0);
221 	log_debug("%s: %#llx %s = %s", __func__, bd->key,
222 	    key_string_lookup_key(bd->key, 1), s);
223 	free(s);
224 }
225 
226 void
227 key_bindings_remove(const char *name, key_code key)
228 {
229 	struct key_table	*table;
230 	struct key_binding	*bd;
231 
232 	table = key_bindings_get_table(name, 0);
233 	if (table == NULL)
234 		return;
235 
236 	bd = key_bindings_get(table, key & ~KEYC_MASK_FLAGS);
237 	if (bd == NULL)
238 		return;
239 
240 	log_debug("%s: %#llx %s", __func__, bd->key,
241 	    key_string_lookup_key(bd->key, 1));
242 
243 	RB_REMOVE(key_bindings, &table->key_bindings, bd);
244 	key_bindings_free(bd);
245 
246 	if (RB_EMPTY(&table->key_bindings) &&
247 	    RB_EMPTY(&table->default_key_bindings)) {
248 		RB_REMOVE(key_tables, &key_tables, table);
249 		key_bindings_unref_table(table);
250 	}
251 }
252 
253 void
254 key_bindings_reset(const char *name, key_code key)
255 {
256 	struct key_table	*table;
257 	struct key_binding	*bd, *dd;
258 
259 	table = key_bindings_get_table(name, 0);
260 	if (table == NULL)
261 		return;
262 
263 	bd = key_bindings_get(table, key & ~KEYC_MASK_FLAGS);
264 	if (bd == NULL)
265 		return;
266 
267 	dd = key_bindings_get_default(table, bd->key);
268 	if (dd == NULL) {
269 		key_bindings_remove(name, bd->key);
270 		return;
271 	}
272 
273 	cmd_list_free(bd->cmdlist);
274 	bd->cmdlist = dd->cmdlist;
275 	bd->cmdlist->references++;
276 
277 	free((void *)bd->note);
278 	if (dd->note != NULL)
279 		bd->note = xstrdup(dd->note);
280 	else
281 		bd->note = NULL;
282 	bd->flags = dd->flags;
283 }
284 
285 void
286 key_bindings_remove_table(const char *name)
287 {
288 	struct key_table	*table;
289 	struct client		*c;
290 
291 	table = key_bindings_get_table(name, 0);
292 	if (table != NULL) {
293 		RB_REMOVE(key_tables, &key_tables, table);
294 		key_bindings_unref_table(table);
295 	}
296 	TAILQ_FOREACH(c, &clients, entry) {
297 		if (c->keytable == table)
298 			server_client_set_key_table(c, NULL);
299 	}
300 }
301 
302 void
303 key_bindings_reset_table(const char *name)
304 {
305 	struct key_table	*table;
306 	struct key_binding	*bd, *bd1;
307 
308 	table = key_bindings_get_table(name, 0);
309 	if (table == NULL)
310 		return;
311 	if (RB_EMPTY(&table->default_key_bindings)) {
312 		key_bindings_remove_table(name);
313 		return;
314 	}
315 	RB_FOREACH_SAFE(bd, key_bindings, &table->key_bindings, bd1)
316 		key_bindings_reset(name, bd->key);
317 }
318 
319 static enum cmd_retval
320 key_bindings_init_done(__unused struct cmdq_item *item, __unused void *data)
321 {
322 	struct key_table	*table;
323 	struct key_binding	*bd, *new_bd;
324 
325 	RB_FOREACH(table, key_tables, &key_tables) {
326 		RB_FOREACH(bd, key_bindings, &table->key_bindings) {
327 			new_bd = xcalloc(1, sizeof *bd);
328 			new_bd->key = bd->key;
329 			if (bd->note != NULL)
330 				new_bd->note = xstrdup(bd->note);
331 			new_bd->flags = bd->flags;
332 			new_bd->cmdlist = bd->cmdlist;
333 			new_bd->cmdlist->references++;
334 			RB_INSERT(key_bindings, &table->default_key_bindings,
335 			    new_bd);
336 		}
337 	}
338 	return (CMD_RETURN_NORMAL);
339 }
340 
341 void
342 key_bindings_init(void)
343 {
344 	static const char *defaults[] = {
345 		/* Prefix keys. */
346 		"bind -N 'Send the prefix key' C-b { send-prefix }",
347 		"bind -N 'Rotate through the panes' C-o { rotate-window }",
348 		"bind -N 'Suspend the current client' C-z { suspend-client }",
349 		"bind -N 'Select next layout' Space { next-layout }",
350 		"bind -N 'Break pane to a new window' ! { break-pane }",
351 		"bind -N 'Split window vertically' '\"' { split-window }",
352 		"bind -N 'List all paste buffers' '#' { list-buffers }",
353 		"bind -N 'Rename current session' '$' { command-prompt -I'#S' { rename-session -- '%%' } }",
354 		"bind -N 'Split window horizontally' % { split-window -h }",
355 		"bind -N 'Kill current window' & { confirm-before -p\"kill-window #W? (y/n)\" kill-window }",
356 		"bind -N 'Prompt for window index to select' \"'\" { command-prompt -T window-target -pindex { select-window -t ':%%' } }",
357 		"bind -N 'Switch to previous client' ( { switch-client -p }",
358 		"bind -N 'Switch to next client' ) { switch-client -n }",
359 		"bind -N 'Rename current window' , { command-prompt -I'#W' { rename-window -- '%%' } }",
360 		"bind -N 'Delete the most recent paste buffer' - { delete-buffer }",
361 		"bind -N 'Move the current window' . { command-prompt -T target { move-window -t '%%' } }",
362 		"bind -N 'Describe key binding' '/' { command-prompt -kpkey  { list-keys -1N '%%' } }",
363 		"bind -N 'Select window 0' 0 { select-window -t:=0 }",
364 		"bind -N 'Select window 1' 1 { select-window -t:=1 }",
365 		"bind -N 'Select window 2' 2 { select-window -t:=2 }",
366 		"bind -N 'Select window 3' 3 { select-window -t:=3 }",
367 		"bind -N 'Select window 4' 4 { select-window -t:=4 }",
368 		"bind -N 'Select window 5' 5 { select-window -t:=5 }",
369 		"bind -N 'Select window 6' 6 { select-window -t:=6 }",
370 		"bind -N 'Select window 7' 7 { select-window -t:=7 }",
371 		"bind -N 'Select window 8' 8 { select-window -t:=8 }",
372 		"bind -N 'Select window 9' 9 { select-window -t:=9 }",
373 		"bind -N 'Prompt for a command' : { command-prompt }",
374 		"bind -N 'Move to the previously active pane' \\; { last-pane }",
375 		"bind -N 'Choose a paste buffer from a list' = { choose-buffer -Z }",
376 		"bind -N 'List key bindings' ? { list-keys -N }",
377 		"bind -N 'Choose a client from a list' D { choose-client -Z }",
378 		"bind -N 'Spread panes out evenly' E { select-layout -E }",
379 		"bind -N 'Switch to the last client' L { switch-client -l }",
380 		"bind -N 'Clear the marked pane' M { select-pane -M }",
381 		"bind -N 'Enter copy mode' [ { copy-mode }",
382 		"bind -N 'Paste the most recent paste buffer' ] { paste-buffer -p }",
383 		"bind -N 'Create a new window' c { new-window }",
384 		"bind -N 'Detach the current client' d { detach-client }",
385 		"bind -N 'Search for a pane' f { command-prompt { find-window -Z -- '%%' } }",
386 		"bind -N 'Display window information' i { display-message }",
387 		"bind -N 'Select the previously current window' l { last-window }",
388 		"bind -N 'Toggle the marked pane' m { select-pane -m }",
389 		"bind -N 'Select the next window' n { next-window }",
390 		"bind -N 'Select the next pane' o { select-pane -t:.+ }",
391 		"bind -N 'Customize options' C { customize-mode -Z }",
392 		"bind -N 'Select the previous window' p { previous-window }",
393 		"bind -N 'Display pane numbers' q { display-panes }",
394 		"bind -N 'Redraw the current client' r { refresh-client }",
395 		"bind -N 'Choose a session from a list' s { choose-tree -Zs }",
396 		"bind -N 'Show a clock' t { clock-mode }",
397 		"bind -N 'Choose a window from a list' w { choose-tree -Zw }",
398 		"bind -N 'Kill the active pane' x { confirm-before -p\"kill-pane #P? (y/n)\" kill-pane }",
399 		"bind -N 'Zoom the active pane' z { resize-pane -Z }",
400 		"bind -N 'Swap the active pane with the pane above' '{' { swap-pane -U }",
401 		"bind -N 'Swap the active pane with the pane below' '}' { swap-pane -D }",
402 		"bind -N 'Show messages' '~' { show-messages }",
403 		"bind -N 'Enter copy mode and scroll up' PPage { copy-mode -u }",
404 		"bind -N 'Select the pane above the active pane' -r Up { select-pane -U }",
405 		"bind -N 'Select the pane below the active pane' -r Down { select-pane -D }",
406 		"bind -N 'Select the pane to the left of the active pane' -r Left { select-pane -L }",
407 		"bind -N 'Select the pane to the right of the active pane' -r Right { select-pane -R }",
408 		"bind -N 'Set the even-horizontal layout' M-1 { select-layout even-horizontal }",
409 		"bind -N 'Set the even-vertical layout' M-2 { select-layout even-vertical }",
410 		"bind -N 'Set the main-horizontal layout' M-3 { select-layout main-horizontal }",
411 		"bind -N 'Set the main-vertical layout' M-4 { select-layout main-vertical }",
412 		"bind -N 'Select the tiled layout' M-5 { select-layout tiled }",
413 		"bind -N 'Select the next window with an alert' M-n { next-window -a }",
414 		"bind -N 'Rotate through the panes in reverse' M-o { rotate-window -D }",
415 		"bind -N 'Select the previous window with an alert' M-p { previous-window -a }",
416 		"bind -N 'Move the visible part of the window up' -r S-Up { refresh-client -U 10 }",
417 		"bind -N 'Move the visible part of the window down' -r S-Down { refresh-client -D 10 }",
418 		"bind -N 'Move the visible part of the window left' -r S-Left { refresh-client -L 10 }",
419 		"bind -N 'Move the visible part of the window right' -r S-Right { refresh-client -R 10 }",
420 		"bind -N 'Reset so the visible part of the window follows the cursor' -r DC { refresh-client -c }",
421 		"bind -N 'Resize the pane up by 5' -r M-Up { resize-pane -U 5 }",
422 		"bind -N 'Resize the pane down by 5' -r M-Down { resize-pane -D 5 }",
423 		"bind -N 'Resize the pane left by 5' -r M-Left { resize-pane -L 5 }",
424 		"bind -N 'Resize the pane right by 5' -r M-Right { resize-pane -R 5 }",
425 		"bind -N 'Resize the pane up' -r C-Up { resize-pane -U }",
426 		"bind -N 'Resize the pane down' -r C-Down { resize-pane -D }",
427 		"bind -N 'Resize the pane left' -r C-Left { resize-pane -L }",
428 		"bind -N 'Resize the pane right' -r C-Right { resize-pane -R }",
429 
430 		/* Menu keys */
431 		"bind < { display-menu -xW -yW -T '#[align=centre]#{window_index}:#{window_name}' " DEFAULT_WINDOW_MENU " }",
432 		"bind > { display-menu -xP -yP -T '#[align=centre]#{pane_index} (#{pane_id})' " DEFAULT_PANE_MENU " }",
433 
434 		/* Mouse button 1 down on pane. */
435 		"bind -n MouseDown1Pane { select-pane -t=; send -M }",
436 
437 		/* Mouse button 1 drag on pane. */
438 		"bind -n MouseDrag1Pane { if -F '#{||:#{pane_in_mode},#{mouse_any_flag}}' { send -M } { copy-mode -M } }",
439 
440 		/* Mouse wheel up on pane. */
441 		"bind -n WheelUpPane { if -F '#{||:#{pane_in_mode},#{mouse_any_flag}}' { send -M } { copy-mode -e } }",
442 
443 		/* Mouse button 2 down on pane. */
444 		"bind -n MouseDown2Pane { select-pane -t=; if -F '#{||:#{pane_in_mode},#{mouse_any_flag}}' { send -M } { paste -p } }",
445 
446 		/* Mouse button 1 double click on pane. */
447 		"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 } }",
448 
449 		/* Mouse button 1 triple click on pane. */
450 		"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 } }",
451 
452 		/* Mouse button 1 drag on border. */
453 		"bind -n MouseDrag1Border { resize-pane -M }",
454 
455 		/* Mouse button 1 down on status line. */
456 		"bind -n MouseDown1Status { select-window -t= }",
457 
458 		/* Mouse wheel down on status line. */
459 		"bind -n WheelDownStatus { next-window }",
460 
461 		/* Mouse wheel up on status line. */
462 		"bind -n WheelUpStatus { previous-window }",
463 
464 		/* Mouse button 3 down on status left. */
465 		"bind -n MouseDown3StatusLeft { display-menu -t= -xM -yW -T '#[align=centre]#{session_name}' " DEFAULT_SESSION_MENU " }",
466 
467 		/* Mouse button 3 down on status line. */
468 		"bind -n MouseDown3Status { display-menu -t= -xW -yW -T '#[align=centre]#{window_index}:#{window_name}' " DEFAULT_WINDOW_MENU "}",
469 
470 		/* Mouse button 3 down on pane. */
471 		"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 " } }",
472 		"bind -n M-MouseDown3Pane { display-menu -t= -xM -yM -T '#[align=centre]#{pane_index} (#{pane_id})' " DEFAULT_PANE_MENU " }",
473 
474 		/* Copy mode (emacs) keys. */
475 		"bind -Tcopy-mode C-Space { send -X begin-selection }",
476 		"bind -Tcopy-mode C-a { send -X start-of-line }",
477 		"bind -Tcopy-mode C-c { send -X cancel }",
478 		"bind -Tcopy-mode C-e { send -X end-of-line }",
479 		"bind -Tcopy-mode C-f { send -X cursor-right }",
480 		"bind -Tcopy-mode C-b { send -X cursor-left }",
481 		"bind -Tcopy-mode C-g { send -X clear-selection }",
482 		"bind -Tcopy-mode C-k { send -X copy-pipe-end-of-line-and-cancel }",
483 		"bind -Tcopy-mode C-n { send -X cursor-down }",
484 		"bind -Tcopy-mode C-p { send -X cursor-up }",
485 		"bind -Tcopy-mode C-r { command-prompt -T search -ip'(search up)' -I'#{pane_search_string}' { send -X search-backward-incremental '%%' } }",
486 		"bind -Tcopy-mode C-s { command-prompt -T search -ip'(search down)' -I'#{pane_search_string}' { send -X search-forward-incremental '%%' } }",
487 		"bind -Tcopy-mode C-v { send -X page-down }",
488 		"bind -Tcopy-mode C-w { send -X copy-pipe-and-cancel }",
489 		"bind -Tcopy-mode Escape { send -X cancel }",
490 		"bind -Tcopy-mode Space { send -X page-down }",
491 		"bind -Tcopy-mode , { send -X jump-reverse }",
492 		"bind -Tcopy-mode \\; { send -X jump-again }",
493 		"bind -Tcopy-mode F { command-prompt -1p'(jump backward)' { send -X jump-backward '%%' } }",
494 		"bind -Tcopy-mode N { send -X search-reverse }",
495 		"bind -Tcopy-mode R { send -X rectangle-toggle }",
496 		"bind -Tcopy-mode T { command-prompt -1p'(jump to backward)' { send -X jump-to-backward '%%' } }",
497 		"bind -Tcopy-mode X { send -X set-mark }",
498 		"bind -Tcopy-mode f { command-prompt -1p'(jump forward)' { send -X jump-forward '%%' } }",
499 		"bind -Tcopy-mode g { command-prompt -p'(goto line)' { send -X goto-line '%%' } }",
500 		"bind -Tcopy-mode n { send -X search-again }",
501 		"bind -Tcopy-mode q { send -X cancel }",
502 		"bind -Tcopy-mode r { send -X refresh-from-pane }",
503 		"bind -Tcopy-mode t { command-prompt -1p'(jump to forward)' { send -X jump-to-forward '%%' } }",
504 		"bind -Tcopy-mode Home { send -X start-of-line }",
505 		"bind -Tcopy-mode End { send -X end-of-line }",
506 		"bind -Tcopy-mode MouseDown1Pane select-pane",
507 		"bind -Tcopy-mode MouseDrag1Pane { select-pane; send -X begin-selection }",
508 		"bind -Tcopy-mode MouseDragEnd1Pane { send -X copy-pipe-and-cancel }",
509 		"bind -Tcopy-mode WheelUpPane { select-pane; send -N5 -X scroll-up }",
510 		"bind -Tcopy-mode WheelDownPane { select-pane; send -N5 -X scroll-down }",
511 		"bind -Tcopy-mode DoubleClick1Pane { select-pane; send -X select-word; run -d0.3; send -X copy-pipe-and-cancel }",
512 		"bind -Tcopy-mode TripleClick1Pane { select-pane; send -X select-line; run -d0.3; send -X copy-pipe-and-cancel }",
513 		"bind -Tcopy-mode NPage { send -X page-down }",
514 		"bind -Tcopy-mode PPage { send -X page-up }",
515 		"bind -Tcopy-mode Up { send -X cursor-up }",
516 		"bind -Tcopy-mode Down { send -X cursor-down }",
517 		"bind -Tcopy-mode Left { send -X cursor-left }",
518 		"bind -Tcopy-mode Right { send -X cursor-right }",
519 		"bind -Tcopy-mode M-1 { command-prompt -Np'(repeat)' -I1 { send -N '%%' } }",
520 		"bind -Tcopy-mode M-2 { command-prompt -Np'(repeat)' -I2 { send -N '%%' } }",
521 		"bind -Tcopy-mode M-3 { command-prompt -Np'(repeat)' -I3 { send -N '%%' } }",
522 		"bind -Tcopy-mode M-4 { command-prompt -Np'(repeat)' -I4 { send -N '%%' } }",
523 		"bind -Tcopy-mode M-5 { command-prompt -Np'(repeat)' -I5 { send -N '%%' } }",
524 		"bind -Tcopy-mode M-6 { command-prompt -Np'(repeat)' -I6 { send -N '%%' } }",
525 		"bind -Tcopy-mode M-7 { command-prompt -Np'(repeat)' -I7 { send -N '%%' } }",
526 		"bind -Tcopy-mode M-8 { command-prompt -Np'(repeat)' -I8 { send -N '%%' } }",
527 		"bind -Tcopy-mode M-9 { command-prompt -Np'(repeat)' -I9 { send -N '%%' } }",
528 		"bind -Tcopy-mode M-< { send -X history-top }",
529 		"bind -Tcopy-mode M-> { send -X history-bottom }",
530 		"bind -Tcopy-mode M-R { send -X top-line }",
531 		"bind -Tcopy-mode M-b { send -X previous-word }",
532 		"bind -Tcopy-mode C-M-b { send -X previous-matching-bracket }",
533 		"bind -Tcopy-mode M-f { send -X next-word-end }",
534 		"bind -Tcopy-mode C-M-f { send -X next-matching-bracket }",
535 		"bind -Tcopy-mode M-m { send -X back-to-indentation }",
536 		"bind -Tcopy-mode M-r { send -X middle-line }",
537 		"bind -Tcopy-mode M-v { send -X page-up }",
538 		"bind -Tcopy-mode M-w { send -X copy-pipe-and-cancel }",
539 		"bind -Tcopy-mode M-x { send -X jump-to-mark }",
540 		"bind -Tcopy-mode 'M-{' { send -X previous-paragraph }",
541 		"bind -Tcopy-mode 'M-}' { send -X next-paragraph }",
542 		"bind -Tcopy-mode M-Up { send -X halfpage-up }",
543 		"bind -Tcopy-mode M-Down { send -X halfpage-down }",
544 		"bind -Tcopy-mode C-Up { send -X scroll-up }",
545 		"bind -Tcopy-mode C-Down { send -X scroll-down }",
546 
547 		/* Copy mode (vi) keys. */
548 		"bind -Tcopy-mode-vi '#' { send -FX search-backward '#{copy_cursor_word}' }",
549 		"bind -Tcopy-mode-vi * { send -FX search-forward '#{copy_cursor_word}' }",
550 		"bind -Tcopy-mode-vi C-c { send -X cancel }",
551 		"bind -Tcopy-mode-vi C-d { send -X halfpage-down }",
552 		"bind -Tcopy-mode-vi C-e { send -X scroll-down }",
553 		"bind -Tcopy-mode-vi C-b { send -X page-up }",
554 		"bind -Tcopy-mode-vi C-f { send -X page-down }",
555 		"bind -Tcopy-mode-vi C-h { send -X cursor-left }",
556 		"bind -Tcopy-mode-vi C-j { send -X copy-pipe-and-cancel }",
557 		"bind -Tcopy-mode-vi Enter { send -X copy-pipe-and-cancel }",
558 		"bind -Tcopy-mode-vi C-u { send -X halfpage-up }",
559 		"bind -Tcopy-mode-vi C-v { send -X rectangle-toggle }",
560 		"bind -Tcopy-mode-vi C-y { send -X scroll-up }",
561 		"bind -Tcopy-mode-vi Escape { send -X clear-selection }",
562 		"bind -Tcopy-mode-vi Space { send -X begin-selection }",
563 		"bind -Tcopy-mode-vi '$' { send -X end-of-line }",
564 		"bind -Tcopy-mode-vi , { send -X jump-reverse }",
565 		"bind -Tcopy-mode-vi / { command-prompt -T search -p'(search down)' { send -X search-forward '%%' } }",
566 		"bind -Tcopy-mode-vi 0 { send -X start-of-line }",
567 		"bind -Tcopy-mode-vi 1 { command-prompt -Np'(repeat)' -I1 { send -N '%%' } }",
568 		"bind -Tcopy-mode-vi 2 { command-prompt -Np'(repeat)' -I2 { send -N '%%' } }",
569 		"bind -Tcopy-mode-vi 3 { command-prompt -Np'(repeat)' -I3 { send -N '%%' } }",
570 		"bind -Tcopy-mode-vi 4 { command-prompt -Np'(repeat)' -I4 { send -N '%%' } }",
571 		"bind -Tcopy-mode-vi 5 { command-prompt -Np'(repeat)' -I5 { send -N '%%' } }",
572 		"bind -Tcopy-mode-vi 6 { command-prompt -Np'(repeat)' -I6 { send -N '%%' } }",
573 		"bind -Tcopy-mode-vi 7 { command-prompt -Np'(repeat)' -I7 { send -N '%%' } }",
574 		"bind -Tcopy-mode-vi 8 { command-prompt -Np'(repeat)' -I8 { send -N '%%' } }",
575 		"bind -Tcopy-mode-vi 9 { command-prompt -Np'(repeat)' -I9 { send -N '%%' } }",
576 		"bind -Tcopy-mode-vi : { command-prompt -p'(goto line)' { send -X goto-line '%%' } }",
577 		"bind -Tcopy-mode-vi \\; { send -X jump-again }",
578 		"bind -Tcopy-mode-vi ? { command-prompt -T search -p'(search up)' { send -X search-backward '%%' } }",
579 		"bind -Tcopy-mode-vi A { send -X append-selection-and-cancel }",
580 		"bind -Tcopy-mode-vi B { send -X previous-space }",
581 		"bind -Tcopy-mode-vi D { send -X copy-pipe-end-of-line-and-cancel }",
582 		"bind -Tcopy-mode-vi E { send -X next-space-end }",
583 		"bind -Tcopy-mode-vi F { command-prompt -1p'(jump backward)' { send -X jump-backward '%%' } }",
584 		"bind -Tcopy-mode-vi G { send -X history-bottom }",
585 		"bind -Tcopy-mode-vi H { send -X top-line }",
586 		"bind -Tcopy-mode-vi J { send -X scroll-down }",
587 		"bind -Tcopy-mode-vi K { send -X scroll-up }",
588 		"bind -Tcopy-mode-vi L { send -X bottom-line }",
589 		"bind -Tcopy-mode-vi M { send -X middle-line }",
590 		"bind -Tcopy-mode-vi N { send -X search-reverse }",
591 		"bind -Tcopy-mode-vi T { command-prompt -1p'(jump to backward)' { send -X jump-to-backward '%%' } }",
592 		"bind -Tcopy-mode-vi V { send -X select-line }",
593 		"bind -Tcopy-mode-vi W { send -X next-space }",
594 		"bind -Tcopy-mode-vi X { send -X set-mark }",
595 		"bind -Tcopy-mode-vi ^ { send -X back-to-indentation }",
596 		"bind -Tcopy-mode-vi b { send -X previous-word }",
597 		"bind -Tcopy-mode-vi e { send -X next-word-end }",
598 		"bind -Tcopy-mode-vi f { command-prompt -1p'(jump forward)' { send -X jump-forward '%%' } }",
599 		"bind -Tcopy-mode-vi g { send -X history-top }",
600 		"bind -Tcopy-mode-vi h { send -X cursor-left }",
601 		"bind -Tcopy-mode-vi j { send -X cursor-down }",
602 		"bind -Tcopy-mode-vi k { send -X cursor-up }",
603 		"bind -Tcopy-mode-vi l { send -X cursor-right }",
604 		"bind -Tcopy-mode-vi n { send -X search-again }",
605 		"bind -Tcopy-mode-vi o { send -X other-end }",
606 		"bind -Tcopy-mode-vi q { send -X cancel }",
607 		"bind -Tcopy-mode-vi r { send -X refresh-from-pane }",
608 		"bind -Tcopy-mode-vi t { command-prompt -1p'(jump to forward)' { send -X jump-to-forward '%%' } }",
609 		"bind -Tcopy-mode-vi v { send -X rectangle-toggle }",
610 		"bind -Tcopy-mode-vi w { send -X next-word }",
611 		"bind -Tcopy-mode-vi '{' { send -X previous-paragraph }",
612 		"bind -Tcopy-mode-vi '}' { send -X next-paragraph }",
613 		"bind -Tcopy-mode-vi % { send -X next-matching-bracket }",
614 		"bind -Tcopy-mode-vi MouseDown1Pane { select-pane }",
615 		"bind -Tcopy-mode-vi MouseDrag1Pane { select-pane; send -X begin-selection }",
616 		"bind -Tcopy-mode-vi MouseDragEnd1Pane { send -X copy-pipe-and-cancel }",
617 		"bind -Tcopy-mode-vi WheelUpPane { select-pane; send -N5 -X scroll-up }",
618 		"bind -Tcopy-mode-vi WheelDownPane { select-pane; send -N5 -X scroll-down }",
619 		"bind -Tcopy-mode-vi DoubleClick1Pane { select-pane; send -X select-word; run -d0.3; send -X copy-pipe-and-cancel }",
620 		"bind -Tcopy-mode-vi TripleClick1Pane { select-pane; send -X select-line; run -d0.3; send -X copy-pipe-and-cancel }",
621 		"bind -Tcopy-mode-vi BSpace { send -X cursor-left }",
622 		"bind -Tcopy-mode-vi NPage { send -X page-down }",
623 		"bind -Tcopy-mode-vi PPage { send -X page-up }",
624 		"bind -Tcopy-mode-vi Up { send -X cursor-up }",
625 		"bind -Tcopy-mode-vi Down { send -X cursor-down }",
626 		"bind -Tcopy-mode-vi Left { send -X cursor-left }",
627 		"bind -Tcopy-mode-vi Right { send -X cursor-right }",
628 		"bind -Tcopy-mode-vi M-x { send -X jump-to-mark }",
629 		"bind -Tcopy-mode-vi C-Up { send -X scroll-up }",
630 		"bind -Tcopy-mode-vi C-Down { send -X scroll-down }",
631 	};
632 	u_int			 i;
633 	struct cmd_parse_result	*pr;
634 
635 	for (i = 0; i < nitems(defaults); i++) {
636 		pr = cmd_parse_from_string(defaults[i], NULL);
637 		if (pr->status != CMD_PARSE_SUCCESS) {
638 			log_debug("%s", pr->error);
639 			fatalx("bad default key: %s", defaults[i]);
640 		}
641 		cmdq_append(NULL, cmdq_get_command(pr->cmdlist, NULL));
642 		cmd_list_free(pr->cmdlist);
643 	}
644 	cmdq_append(NULL, cmdq_get_callback(key_bindings_init_done, NULL));
645 }
646 
647 static enum cmd_retval
648 key_bindings_read_only(struct cmdq_item *item, __unused void *data)
649 {
650 	cmdq_error(item, "client is read-only");
651 	return (CMD_RETURN_ERROR);
652 }
653 
654 struct cmdq_item *
655 key_bindings_dispatch(struct key_binding *bd, struct cmdq_item *item,
656     struct client *c, struct key_event *event, struct cmd_find_state *fs)
657 {
658 	struct cmdq_item	*new_item;
659 	struct cmdq_state	*new_state;
660 	int			 readonly, flags = 0;
661 
662 	if (c == NULL || (~c->flags & CLIENT_READONLY))
663 		readonly = 1;
664 	else
665 		readonly = cmd_list_all_have(bd->cmdlist, CMD_READONLY);
666 	if (!readonly)
667 		new_item = cmdq_get_callback(key_bindings_read_only, NULL);
668 	else {
669 		if (bd->flags & KEY_BINDING_REPEAT)
670 			flags |= CMDQ_STATE_REPEAT;
671 		new_state = cmdq_new_state(fs, event, flags);
672 		new_item = cmdq_get_command(bd->cmdlist, new_state);
673 		cmdq_free_state(new_state);
674 	}
675 	if (item != NULL)
676 		new_item = cmdq_insert_after(item, new_item);
677 	else
678 		new_item = cmdq_append(c, new_item);
679 	return (new_item);
680 }
681