xref: /openbsd-src/usr.bin/tmux/cmd-send-keys.c (revision 6eb18d37e9f29758f2e66a2a7d4ddeb7dfbebff7)
1 /* $OpenBSD: cmd-send-keys.c,v 1.51 2019/11/07 07:11:25 nicm Exp $ */
2 
3 /*
4  * Copyright (c) 2008 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 <stdlib.h>
22 #include <string.h>
23 
24 #include "tmux.h"
25 
26 /*
27  * Send keys to client.
28  */
29 
30 static enum cmd_retval	cmd_send_keys_exec(struct cmd *, struct cmdq_item *);
31 
32 const struct cmd_entry cmd_send_keys_entry = {
33 	.name = "send-keys",
34 	.alias = "send",
35 
36 	.args = { "FHlMN:Rt:X", 0, -1 },
37 	.usage = "[-FHlMRX] [-N repeat-count] " CMD_TARGET_PANE_USAGE
38 	         " key ...",
39 
40 	.target = { 't', CMD_FIND_PANE, 0 },
41 
42 	.flags = CMD_AFTERHOOK,
43 	.exec = cmd_send_keys_exec
44 };
45 
46 const struct cmd_entry cmd_send_prefix_entry = {
47 	.name = "send-prefix",
48 	.alias = NULL,
49 
50 	.args = { "2t:", 0, 0 },
51 	.usage = "[-2] " CMD_TARGET_PANE_USAGE,
52 
53 	.target = { 't', CMD_FIND_PANE, 0 },
54 
55 	.flags = CMD_AFTERHOOK,
56 	.exec = cmd_send_keys_exec
57 };
58 
59 static struct cmdq_item *
60 cmd_send_keys_inject_key(struct client *c, struct cmd_find_state *fs,
61     struct cmdq_item *item, key_code key)
62 {
63 	struct window_mode_entry	*wme;
64 	struct key_table		*table;
65 	struct key_binding		*bd;
66 
67 	wme = TAILQ_FIRST(&fs->wp->modes);
68 	if (wme == NULL || wme->mode->key_table == NULL) {
69 		if (options_get_number(fs->wp->window->options, "xterm-keys"))
70 			key |= KEYC_XTERM;
71 		window_pane_key(fs->wp, item->client, fs->s, fs->wl, key, NULL);
72 		return (item);
73 	}
74 	table = key_bindings_get_table(wme->mode->key_table(wme), 1);
75 
76 	bd = key_bindings_get(table, key & ~KEYC_XTERM);
77 	if (bd != NULL) {
78 		table->references++;
79 		item = key_bindings_dispatch(bd, item, c, NULL, &item->target);
80 		key_bindings_unref_table(table);
81 	}
82 	return (item);
83 }
84 
85 static struct cmdq_item *
86 cmd_send_keys_inject_string(struct client *c, struct cmd_find_state *fs,
87     struct cmdq_item *item, struct args *args, int i)
88 {
89 	const char		*s = args->argv[i];
90 	struct utf8_data	*ud, *uc;
91 	wchar_t			 wc;
92 	key_code		 key;
93 	char			*endptr;
94 	long			 n;
95 	int			 literal;
96 
97 	if (args_has(args, 'H')) {
98 		n = strtol(s, &endptr, 16);
99 		if (*s =='\0' || n < 0 || n > 0xff || *endptr != '\0')
100 			return (item);
101 		return (cmd_send_keys_inject_key(c, fs, item, KEYC_LITERAL|n));
102 	}
103 
104 	literal = args_has(args, 'l');
105 	if (!literal) {
106 		key = key_string_lookup_string(s);
107 		if (key != KEYC_NONE && key != KEYC_UNKNOWN)
108 			return (cmd_send_keys_inject_key(c, fs, item, key));
109 		literal = 1;
110 	}
111 	if (literal) {
112 		ud = utf8_fromcstr(s);
113 		for (uc = ud; uc->size != 0; uc++) {
114 			if (utf8_combine(uc, &wc) != UTF8_DONE)
115 				continue;
116 			item = cmd_send_keys_inject_key(c, fs, item, wc);
117 		}
118 		free(ud);
119 	}
120 	return (item);
121 }
122 
123 static enum cmd_retval
124 cmd_send_keys_exec(struct cmd *self, struct cmdq_item *item)
125 {
126 	struct args			*args = self->args;
127 	struct client			*c = cmd_find_client(item, NULL, 1);
128 	struct cmd_find_state		*fs = &item->target;
129 	struct window_pane		*wp = item->target.wp;
130 	struct session			*s = item->target.s;
131 	struct winlink			*wl = item->target.wl;
132 	struct mouse_event		*m = &item->shared->mouse;
133 	struct window_mode_entry	*wme = TAILQ_FIRST(&wp->modes);
134 	int				 i;
135 	key_code			 key;
136 	u_int				 np = 1;
137 	char				*cause = NULL;
138 
139 	if (args_has(args, 'N')) {
140 		np = args_strtonum(args, 'N', 1, UINT_MAX, &cause);
141 		if (cause != NULL) {
142 			cmdq_error(item, "repeat count %s", cause);
143 			free(cause);
144 			return (CMD_RETURN_ERROR);
145 		}
146 		if (wme != NULL && (args_has(args, 'X') || args->argc == 0)) {
147 			if (wme == NULL || wme->mode->command == NULL) {
148 				cmdq_error(item, "not in a mode");
149 				return (CMD_RETURN_ERROR);
150 			}
151 			wme->prefix = np;
152 		}
153 	}
154 
155 	if (args_has(args, 'X')) {
156 		if (wme == NULL || wme->mode->command == NULL) {
157 			cmdq_error(item, "not in a mode");
158 			return (CMD_RETURN_ERROR);
159 		}
160 		if (!m->valid)
161 			m = NULL;
162 		wme->mode->command(wme, c, s, wl, args, m);
163 		return (CMD_RETURN_NORMAL);
164 	}
165 
166 	if (args_has(args, 'M')) {
167 		wp = cmd_mouse_pane(m, &s, NULL);
168 		if (wp == NULL) {
169 			cmdq_error(item, "no mouse target");
170 			return (CMD_RETURN_ERROR);
171 		}
172 		window_pane_key(wp, item->client, s, wl, m->key, m);
173 		return (CMD_RETURN_NORMAL);
174 	}
175 
176 	if (self->entry == &cmd_send_prefix_entry) {
177 		if (args_has(args, '2'))
178 			key = options_get_number(s->options, "prefix2");
179 		else
180 			key = options_get_number(s->options, "prefix");
181 		cmd_send_keys_inject_key(c, fs, item, key);
182 		return (CMD_RETURN_NORMAL);
183 	}
184 
185 	if (args_has(args, 'R')) {
186 		window_pane_reset_palette(wp);
187 		input_reset(wp, 1);
188 	}
189 
190 	for (; np != 0; np--) {
191 		for (i = 0; i < args->argc; i++)
192 			item = cmd_send_keys_inject_string(c, fs, item, args, i);
193 	}
194 
195 	return (CMD_RETURN_NORMAL);
196 }
197