xref: /openbsd-src/usr.bin/tmux/cmd-refresh-client.c (revision 5a38ef86d0b61900239c7913d24a05e7b88a58f0)
1 /* $OpenBSD: cmd-refresh-client.c,v 1.45 2021/08/27 17:15:57 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 <stdlib.h>
22 #include <string.h>
23 
24 #include "tmux.h"
25 
26 /*
27  * Refresh client.
28  */
29 
30 static enum cmd_retval	cmd_refresh_client_exec(struct cmd *,
31 			    struct cmdq_item *);
32 
33 const struct cmd_entry cmd_refresh_client_entry = {
34 	.name = "refresh-client",
35 	.alias = "refresh",
36 
37 	.args = { "A:B:cC:Df:F:lLRSt:U", 0, 1, NULL },
38 	.usage = "[-cDlLRSU] [-A pane:state] [-B name:what:format] "
39 		 "[-C XxY] [-f flags] " CMD_TARGET_CLIENT_USAGE " [adjustment]",
40 
41 	.flags = CMD_AFTERHOOK|CMD_CLIENT_TFLAG,
42 	.exec = cmd_refresh_client_exec
43 };
44 
45 static void
46 cmd_refresh_client_update_subscription(struct client *tc, const char *value)
47 {
48 	char			*copy, *split, *name, *what;
49 	enum control_sub_type	 subtype;
50 	int			 subid = -1;
51 
52 	copy = name = xstrdup(value);
53 	if ((split = strchr(copy, ':')) == NULL) {
54 		control_remove_sub(tc, copy);
55 		goto out;
56 	}
57 	*split++ = '\0';
58 
59 	what = split;
60 	if ((split = strchr(what, ':')) == NULL)
61 		goto out;
62 	*split++ = '\0';
63 
64 	if (strcmp(what, "%*") == 0)
65 		subtype = CONTROL_SUB_ALL_PANES;
66 	else if (sscanf(what, "%%%d", &subid) == 1 && subid >= 0)
67 		subtype = CONTROL_SUB_PANE;
68 	else if (strcmp(what, "@*") == 0)
69 		subtype = CONTROL_SUB_ALL_WINDOWS;
70 	else if (sscanf(what, "@%d", &subid) == 1 && subid >= 0)
71 		subtype = CONTROL_SUB_WINDOW;
72 	else
73 		subtype = CONTROL_SUB_SESSION;
74 	control_add_sub(tc, name, subtype, subid, split);
75 
76 out:
77 	free(copy);
78 }
79 
80 static enum cmd_retval
81 cmd_refresh_client_control_client_size(struct cmd *self, struct cmdq_item *item)
82 {
83 	struct args		*args = cmd_get_args(self);
84 	struct client		*tc = cmdq_get_target_client(item);
85 	const char		*size = args_get(args, 'C');
86 	u_int			 w, x, y;
87 	struct client_window	*cw;
88 
89 	if (sscanf(size, "@%u:%ux%u", &w, &x, &y) == 3) {
90 		if (x < WINDOW_MINIMUM || x > WINDOW_MAXIMUM ||
91 		    y < WINDOW_MINIMUM || y > WINDOW_MAXIMUM) {
92 			cmdq_error(item, "size too small or too big");
93 			return (CMD_RETURN_ERROR);
94 		}
95 		log_debug("%s: client %s window @%u: size %ux%u", __func__,
96 		    tc->name, w, x, y);
97 		cw = server_client_add_client_window(tc, w);
98 		cw->sx = x;
99 		cw->sy = y;
100 		tc->flags |= CLIENT_WINDOWSIZECHANGED;
101 		recalculate_sizes_now(1);
102 		return (CMD_RETURN_NORMAL);
103 	}
104 	if (sscanf(size, "@%u:", &w) == 1) {
105 		cw = server_client_get_client_window(tc, w);
106 		if (cw != NULL) {
107 			log_debug("%s: client %s window @%u: no size", __func__,
108 			    tc->name, w);
109 			cw->sx = 0;
110 			cw->sy = 0;
111 			recalculate_sizes_now(1);
112 		}
113 		return (CMD_RETURN_NORMAL);
114 	}
115 
116 	if (sscanf(size, "%u,%u", &x, &y) != 2 &&
117 	    sscanf(size, "%ux%u", &x, &y) != 2) {
118 		cmdq_error(item, "bad size argument");
119 		return (CMD_RETURN_ERROR);
120 	}
121 	if (x < WINDOW_MINIMUM || x > WINDOW_MAXIMUM ||
122 	    y < WINDOW_MINIMUM || y > WINDOW_MAXIMUM) {
123 		cmdq_error(item, "size too small or too big");
124 		return (CMD_RETURN_ERROR);
125 	}
126 	tty_set_size(&tc->tty, x, y, 0, 0);
127 	tc->flags |= CLIENT_SIZECHANGED;
128 	recalculate_sizes_now(1);
129 	return (CMD_RETURN_NORMAL);
130 }
131 
132 static void
133 cmd_refresh_client_update_offset(struct client *tc, const char *value)
134 {
135 	struct window_pane	*wp;
136 	char			*copy, *split;
137 	u_int			 pane;
138 
139 	if (*value != '%')
140 		return;
141 	copy = xstrdup(value);
142 	if ((split = strchr(copy, ':')) == NULL)
143 		goto out;
144 	*split++ = '\0';
145 
146 	if (sscanf(copy, "%%%u", &pane) != 1)
147 		goto out;
148 	wp = window_pane_find_by_id(pane);
149 	if (wp == NULL)
150 		goto out;
151 
152 	if (strcmp(split, "on") == 0)
153 		control_set_pane_on(tc, wp);
154 	else if (strcmp(split, "off") == 0)
155 		control_set_pane_off(tc, wp);
156 	else if (strcmp(split, "continue") == 0)
157 		control_continue_pane(tc, wp);
158 	else if (strcmp(split, "pause") == 0)
159 		control_pause_pane(tc, wp);
160 
161 out:
162 	free(copy);
163 }
164 
165 static enum cmd_retval
166 cmd_refresh_client_exec(struct cmd *self, struct cmdq_item *item)
167 {
168 	struct args		*args = cmd_get_args(self);
169 	struct client		*tc = cmdq_get_target_client(item);
170 	struct tty		*tty = &tc->tty;
171 	struct window		*w;
172 	const char		*errstr;
173 	u_int			 adjust;
174 	struct args_value	*av;
175 
176 	if (args_has(args, 'c') ||
177 	    args_has(args, 'L') ||
178 	    args_has(args, 'R') ||
179 	    args_has(args, 'U') ||
180 	    args_has(args, 'D'))
181 	{
182 		if (args_count(args) == 0)
183 			adjust = 1;
184 		else {
185 			adjust = strtonum(args_string(args, 0), 1, INT_MAX,
186 			    &errstr);
187 			if (errstr != NULL) {
188 				cmdq_error(item, "adjustment %s", errstr);
189 				return (CMD_RETURN_ERROR);
190 			}
191 		}
192 
193 		if (args_has(args, 'c'))
194 			tc->pan_window = NULL;
195 		else {
196 			w = tc->session->curw->window;
197 			if (tc->pan_window != w) {
198 				tc->pan_window = w;
199 				tc->pan_ox = tty->oox;
200 				tc->pan_oy = tty->ooy;
201 			}
202 			if (args_has(args, 'L')) {
203 				if (tc->pan_ox > adjust)
204 					tc->pan_ox -= adjust;
205 				else
206 					tc->pan_ox = 0;
207 			} else if (args_has(args, 'R')) {
208 				tc->pan_ox += adjust;
209 				if (tc->pan_ox > w->sx - tty->osx)
210 					tc->pan_ox = w->sx - tty->osx;
211 			} else if (args_has(args, 'U')) {
212 				if (tc->pan_oy > adjust)
213 					tc->pan_oy -= adjust;
214 				else
215 					tc->pan_oy = 0;
216 			} else if (args_has(args, 'D')) {
217 				tc->pan_oy += adjust;
218 				if (tc->pan_oy > w->sy - tty->osy)
219 					tc->pan_oy = w->sy - tty->osy;
220 			}
221 		}
222 		tty_update_client_offset(tc);
223 		server_redraw_client(tc);
224 		return (CMD_RETURN_NORMAL);
225 	}
226 
227 	if (args_has(args, 'l')) {
228 		tty_putcode_ptr2(&tc->tty, TTYC_MS, "", "?");
229 		return (CMD_RETURN_NORMAL);
230 	}
231 
232 	if (args_has(args, 'F')) /* -F is an alias for -f */
233 		server_client_set_flags(tc, args_get(args, 'F'));
234 	if (args_has(args, 'f'))
235 		server_client_set_flags(tc, args_get(args, 'f'));
236 
237 	if (args_has(args, 'A')) {
238 		if (~tc->flags & CLIENT_CONTROL)
239 			goto not_control_client;
240 		av = args_first_value(args, 'A');
241 		while (av != NULL) {
242 			cmd_refresh_client_update_offset(tc, av->string);
243 			av = args_next_value(av);
244 		}
245 		return (CMD_RETURN_NORMAL);
246 	}
247 	if (args_has(args, 'B')) {
248 		if (~tc->flags & CLIENT_CONTROL)
249 			goto not_control_client;
250 		av = args_first_value(args, 'B');
251 		while (av != NULL) {
252 			cmd_refresh_client_update_subscription(tc, av->string);
253 			av = args_next_value(av);
254 		}
255 		return (CMD_RETURN_NORMAL);
256 	}
257 	if (args_has(args, 'C')) {
258 		if (~tc->flags & CLIENT_CONTROL)
259 			goto not_control_client;
260 		return (cmd_refresh_client_control_client_size(self, item));
261 	}
262 
263 	if (args_has(args, 'S')) {
264 		tc->flags |= CLIENT_STATUSFORCE;
265 		server_status_client(tc);
266 	} else {
267 		tc->flags |= CLIENT_STATUSFORCE;
268 		server_redraw_client(tc);
269 	}
270 	return (CMD_RETURN_NORMAL);
271 
272 not_control_client:
273 	cmdq_error(item, "not a control client");
274 	return (CMD_RETURN_ERROR);
275 }
276