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