xref: /openbsd-src/usr.bin/tmux/cmd-set-option.c (revision 82b5cde7a95db2e5b263ffa7be0fdfeae6305e19)
1 /* $OpenBSD: cmd-set-option.c,v 1.103 2017/01/11 14:56:44 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  * Set an option.
28  */
29 
30 static enum cmd_retval	cmd_set_option_exec(struct cmd *, struct cmdq_item *);
31 
32 static enum cmd_retval	cmd_set_option_user(struct cmd *, struct cmdq_item *,
33 			    const char *, const char *);
34 
35 static int	cmd_set_option_unset(struct cmd *, struct cmdq_item *,
36 		    const struct options_table_entry *, struct options *,
37 		    const char *);
38 static int	cmd_set_option_set(struct cmd *, struct cmdq_item *,
39 		    const struct options_table_entry *, struct options *,
40 		    const char *);
41 
42 static struct options_entry *cmd_set_option_string(struct cmd *,
43 	    struct cmdq_item *, const struct options_table_entry *,
44 	    struct options *, const char *);
45 static struct options_entry *cmd_set_option_number(struct cmd *,
46 	    struct cmdq_item *, const struct options_table_entry *,
47 	    struct options *, const char *);
48 static struct options_entry *cmd_set_option_key(struct cmd *,
49 	    struct cmdq_item *, const struct options_table_entry *,
50 	    struct options *, const char *);
51 static struct options_entry *cmd_set_option_colour(struct cmd *,
52 	    struct cmdq_item *, const struct options_table_entry *,
53 	    struct options *, const char *);
54 static struct options_entry *cmd_set_option_attributes(struct cmd *,
55 	    struct cmdq_item *, const struct options_table_entry *,
56 	    struct options *, const char *);
57 static struct options_entry *cmd_set_option_flag(struct cmd *,
58 	    struct cmdq_item *, const struct options_table_entry *,
59 	    struct options *, const char *);
60 static struct options_entry *cmd_set_option_choice(struct cmd *,
61 	    struct cmdq_item *, const struct options_table_entry *,
62 	    struct options *, const char *);
63 static struct options_entry *cmd_set_option_style(struct cmd *,
64 	    struct cmdq_item *, const struct options_table_entry *,
65 	    struct options *, const char *);
66 
67 const struct cmd_entry cmd_set_option_entry = {
68 	.name = "set-option",
69 	.alias = "set",
70 
71 	.args = { "agoqst:uw", 1, 2 },
72 	.usage = "[-agosquw] [-t target-window] option [value]",
73 
74 	.tflag = CMD_WINDOW_CANFAIL,
75 
76 	.flags = CMD_AFTERHOOK,
77 	.exec = cmd_set_option_exec
78 };
79 
80 const struct cmd_entry cmd_set_window_option_entry = {
81 	.name = "set-window-option",
82 	.alias = "setw",
83 
84 	.args = { "agoqt:u", 1, 2 },
85 	.usage = "[-agoqu] " CMD_TARGET_WINDOW_USAGE " option [value]",
86 
87 	.tflag = CMD_WINDOW_CANFAIL,
88 
89 	.flags = CMD_AFTERHOOK,
90 	.exec = cmd_set_option_exec
91 };
92 
93 static enum cmd_retval
94 cmd_set_option_exec(struct cmd *self, struct cmdq_item *item)
95 {
96 	struct args				*args = self->args;
97 	struct session				*s = item->state.tflag.s;
98 	struct winlink				*wl = item->state.tflag.wl;
99 	struct window				*w;
100 	struct client				*c;
101 	const struct options_table_entry	*oe;
102 	struct options				*oo;
103 	const char				*optstr, *valstr, *target;
104 
105 	/* Get the option name and value. */
106 	optstr = args->argv[0];
107 	if (*optstr == '\0') {
108 		cmdq_error(item, "invalid option");
109 		return (CMD_RETURN_ERROR);
110 	}
111 	if (args->argc < 2)
112 		valstr = NULL;
113 	else
114 		valstr = args->argv[1];
115 
116 	/* Is this a user option? */
117 	if (*optstr == '@')
118 		return (cmd_set_option_user(self, item, optstr, valstr));
119 
120 	/* Find the option entry. */
121 	oe = NULL;
122 	if (options_table_find(optstr, &oe) != 0) {
123 		if (!args_has(args, 'q')) {
124 			cmdq_error(item, "ambiguous option: %s", optstr);
125 			return (CMD_RETURN_ERROR);
126 		}
127 		return (CMD_RETURN_NORMAL);
128 	}
129 	if (oe == NULL) {
130 		if (!args_has(args, 'q')) {
131 			cmdq_error(item, "unknown option: %s", optstr);
132 			return (CMD_RETURN_ERROR);
133 		}
134 		return (CMD_RETURN_NORMAL);
135 	}
136 
137 	/* Work out the tree from the scope of the option. */
138 	if (oe->scope == OPTIONS_TABLE_SERVER)
139 		oo = global_options;
140 	else if (oe->scope == OPTIONS_TABLE_WINDOW) {
141 		if (args_has(self->args, 'g'))
142 			oo = global_w_options;
143 		else if (wl == NULL) {
144 			target = args_get(args, 't');
145 			if (target != NULL) {
146 				cmdq_error(item, "no such window: %s",
147 				    target);
148 			} else
149 				cmdq_error(item, "no current window");
150 			return (CMD_RETURN_ERROR);
151 		} else
152 			oo = wl->window->options;
153 	} else if (oe->scope == OPTIONS_TABLE_SESSION) {
154 		if (args_has(self->args, 'g'))
155 			oo = global_s_options;
156 		else if (s == NULL) {
157 			target = args_get(args, 't');
158 			if (target != NULL) {
159 				cmdq_error(item, "no such session: %s",
160 				    target);
161 			} else
162 				cmdq_error(item, "no current session");
163 			return (CMD_RETURN_ERROR);
164 		} else
165 			oo = s->options;
166 	} else {
167 		cmdq_error(item, "unknown table");
168 		return (CMD_RETURN_ERROR);
169 	}
170 
171 	/* Unset or set the option. */
172 	if (args_has(args, 'u')) {
173 		if (cmd_set_option_unset(self, item, oe, oo, valstr) != 0)
174 			return (CMD_RETURN_ERROR);
175 	} else {
176 		if (args_has(args, 'o') && options_find1(oo, optstr) != NULL) {
177 			if (!args_has(args, 'q')) {
178 				cmdq_error(item, "already set: %s", optstr);
179 				return (CMD_RETURN_ERROR);
180 			}
181 			return (CMD_RETURN_NORMAL);
182 		}
183 		if (cmd_set_option_set(self, item, oe, oo, valstr) != 0)
184 			return (CMD_RETURN_ERROR);
185 	}
186 
187 	/* Update timers and so on for various options. */
188 	if (strcmp(oe->name, "automatic-rename") == 0) {
189 		RB_FOREACH(w, windows, &windows) {
190 			if (w->active == NULL)
191 				continue;
192 			if (options_get_number(w->options, "automatic-rename"))
193 				w->active->flags |= PANE_CHANGED;
194 		}
195 	}
196 	if (strcmp(oe->name, "key-table") == 0) {
197 		TAILQ_FOREACH(c, &clients, entry)
198 			server_client_set_key_table(c, NULL);
199 	}
200 	if (strcmp(oe->name, "status") == 0 ||
201 	    strcmp(oe->name, "status-interval") == 0)
202 		status_timer_start_all();
203 	if (strcmp(oe->name, "monitor-silence") == 0)
204 		alerts_reset_all();
205 	if (strcmp(oe->name, "window-style") == 0 ||
206 	    strcmp(oe->name, "window-active-style") == 0) {
207 		RB_FOREACH(w, windows, &windows)
208 			w->flags |= WINDOW_STYLECHANGED;
209 	}
210 	if (strcmp(oe->name, "pane-border-status") == 0) {
211 		RB_FOREACH(w, windows, &windows)
212 			layout_fix_panes(w, w->sx, w->sy);
213 	}
214 
215 	/* Update sizes and redraw. May not need it but meh. */
216 	recalculate_sizes();
217 	TAILQ_FOREACH(c, &clients, entry) {
218 		if (c->session != NULL)
219 			server_redraw_client(c);
220 	}
221 
222 	return (CMD_RETURN_NORMAL);
223 }
224 
225 /* Set user option. */
226 static enum cmd_retval
227 cmd_set_option_user(struct cmd *self, struct cmdq_item *item,
228     const char *optstr, const char *valstr)
229 {
230 	struct args		*args = self->args;
231 	struct session		*s = item->state.tflag.s;
232 	struct winlink		*wl = item->state.tflag.wl;
233 	struct options		*oo;
234 	struct options_entry	*o;
235 	const char		*target;
236 
237 	if (args_has(args, 's'))
238 		oo = global_options;
239 	else if (args_has(self->args, 'w') ||
240 	    self->entry == &cmd_set_window_option_entry) {
241 		if (args_has(self->args, 'g'))
242 			oo = global_w_options;
243 		else if (wl == NULL) {
244 			target = args_get(args, 't');
245 			if (target != NULL) {
246 				cmdq_error(item, "no such window: %s",
247 				    target);
248 			} else
249 				cmdq_error(item, "no current window");
250 			return (CMD_RETURN_ERROR);
251 		} else
252 			oo = wl->window->options;
253 	} else {
254 		if (args_has(self->args, 'g'))
255 			oo = global_s_options;
256 		else if (s == NULL) {
257 			target = args_get(args, 't');
258 			if (target != NULL) {
259 				cmdq_error(item, "no such session: %s",
260 				    target);
261 			} else
262 				cmdq_error(item, "no current session");
263 			return (CMD_RETURN_ERROR);
264 		} else
265 			oo = s->options;
266 	}
267 
268 	if (args_has(args, 'u')) {
269 		if (options_find1(oo, optstr) == NULL) {
270 			if (!args_has(args, 'q')) {
271 				cmdq_error(item, "unknown option: %s", optstr);
272 				return (CMD_RETURN_ERROR);
273 			}
274 			return (CMD_RETURN_NORMAL);
275 		}
276 		if (valstr != NULL) {
277 			cmdq_error(item, "value passed to unset option: %s",
278 			    optstr);
279 			return (CMD_RETURN_ERROR);
280 		}
281 		options_remove(oo, optstr);
282 	} else {
283 		o = options_find1(oo, optstr);
284 		if (args_has(args, 'o') && o != NULL) {
285 			if (!args_has(args, 'q')) {
286 				cmdq_error(item, "already set: %s", optstr);
287 				return (CMD_RETURN_ERROR);
288 			}
289 			return (CMD_RETURN_NORMAL);
290 		}
291 		if (valstr == NULL) {
292 			cmdq_error(item, "empty value");
293 			return (CMD_RETURN_ERROR);
294 		}
295 		if (o != NULL && args_has(args, 'a'))
296 			options_set_string(oo, optstr, "%s%s", o->str, valstr);
297 		else
298 			options_set_string(oo, optstr, "%s", valstr);
299 	}
300 	return (CMD_RETURN_NORMAL);
301 }
302 
303 /* Unset an option. */
304 static int
305 cmd_set_option_unset(struct cmd *self, struct cmdq_item *item,
306     const struct options_table_entry *oe, struct options *oo,
307     const char *value)
308 {
309 	struct args	*args = self->args;
310 
311 	if (value != NULL) {
312 		cmdq_error(item, "value passed to unset option: %s", oe->name);
313 		return (-1);
314 	}
315 
316 	if (args_has(args, 'g') || oo == global_options) {
317 		switch (oe->type) {
318 		case OPTIONS_TABLE_STRING:
319 			options_set_string(oo, oe->name, "%s", oe->default_str);
320 			break;
321 		case OPTIONS_TABLE_STYLE:
322 			options_set_style(oo, oe->name, oe->default_str, 0);
323 			break;
324 		default:
325 			options_set_number(oo, oe->name, oe->default_num);
326 			break;
327 		}
328 	} else
329 		options_remove(oo, oe->name);
330 	return (0);
331 }
332 
333 /* Set an option. */
334 static int
335 cmd_set_option_set(struct cmd *self, struct cmdq_item *item,
336     const struct options_table_entry *oe, struct options *oo,
337     const char *value)
338 {
339 	struct options_entry	*o;
340 
341 	switch (oe->type) {
342 	case OPTIONS_TABLE_FLAG:
343 	case OPTIONS_TABLE_CHOICE:
344 		break;
345 	default:
346 		if (value == NULL) {
347 			cmdq_error(item, "empty value");
348 			return (-1);
349 		}
350 	}
351 
352 	o = NULL;
353 	switch (oe->type) {
354 	case OPTIONS_TABLE_STRING:
355 		o = cmd_set_option_string(self, item, oe, oo, value);
356 		break;
357 	case OPTIONS_TABLE_NUMBER:
358 		o = cmd_set_option_number(self, item, oe, oo, value);
359 		break;
360 	case OPTIONS_TABLE_KEY:
361 		o = cmd_set_option_key(self, item, oe, oo, value);
362 		break;
363 	case OPTIONS_TABLE_COLOUR:
364 		o = cmd_set_option_colour(self, item, oe, oo, value);
365 		if (o != NULL)
366 			style_update_new(oo, o->name, oe->style);
367 		break;
368 	case OPTIONS_TABLE_ATTRIBUTES:
369 		o = cmd_set_option_attributes(self, item, oe, oo, value);
370 		if (o != NULL)
371 			style_update_new(oo, o->name, oe->style);
372 		break;
373 	case OPTIONS_TABLE_FLAG:
374 		o = cmd_set_option_flag(self, item, oe, oo, value);
375 		break;
376 	case OPTIONS_TABLE_CHOICE:
377 		o = cmd_set_option_choice(self, item, oe, oo, value);
378 		break;
379 	case OPTIONS_TABLE_STYLE:
380 		o = cmd_set_option_style(self, item, oe, oo, value);
381 		break;
382 	}
383 	if (o == NULL)
384 		return (-1);
385 	return (0);
386 }
387 
388 /* Set a string option. */
389 static struct options_entry *
390 cmd_set_option_string(struct cmd *self, __unused struct cmdq_item *item,
391     const struct options_table_entry *oe, struct options *oo,
392     const char *value)
393 {
394 	struct args		*args = self->args;
395 	struct options_entry	*o;
396 	char			*oldval, *newval;
397 
398 	if (args_has(args, 'a')) {
399 		oldval = options_get_string(oo, oe->name);
400 		xasprintf(&newval, "%s%s", oldval, value);
401 	} else
402 		newval = xstrdup(value);
403 
404 	o = options_set_string(oo, oe->name, "%s", newval);
405 
406 	free(newval);
407 	return (o);
408 }
409 
410 /* Set a number option. */
411 static struct options_entry *
412 cmd_set_option_number(__unused struct cmd *self, struct cmdq_item *item,
413     const struct options_table_entry *oe, struct options *oo,
414     const char *value)
415 {
416 	long long	 ll;
417 	const char     	*errstr;
418 
419 	ll = strtonum(value, oe->minimum, oe->maximum, &errstr);
420 	if (errstr != NULL) {
421 		cmdq_error(item, "value is %s: %s", errstr, value);
422 		return (NULL);
423 	}
424 
425 	return (options_set_number(oo, oe->name, ll));
426 }
427 
428 /* Set a key option. */
429 static struct options_entry *
430 cmd_set_option_key(__unused struct cmd *self, struct cmdq_item *item,
431     const struct options_table_entry *oe, struct options *oo,
432     const char *value)
433 {
434 	key_code	key;
435 
436 	key = key_string_lookup_string(value);
437 	if (key == KEYC_UNKNOWN) {
438 		cmdq_error(item, "bad key: %s", value);
439 		return (NULL);
440 	}
441 
442 	return (options_set_number(oo, oe->name, key));
443 }
444 
445 /* Set a colour option. */
446 static struct options_entry *
447 cmd_set_option_colour(__unused struct cmd *self, struct cmdq_item *item,
448     const struct options_table_entry *oe, struct options *oo,
449     const char *value)
450 {
451 	int	colour;
452 
453 	if ((colour = colour_fromstring(value)) == -1) {
454 		cmdq_error(item, "bad colour: %s", value);
455 		return (NULL);
456 	}
457 
458 	return (options_set_number(oo, oe->name, colour));
459 }
460 
461 /* Set an attributes option. */
462 static struct options_entry *
463 cmd_set_option_attributes(__unused struct cmd *self, struct cmdq_item *item,
464     const struct options_table_entry *oe, struct options *oo,
465     const char *value)
466 {
467 	int	attr;
468 
469 	if ((attr = attributes_fromstring(value)) == -1) {
470 		cmdq_error(item, "bad attributes: %s", value);
471 		return (NULL);
472 	}
473 
474 	return (options_set_number(oo, oe->name, attr));
475 }
476 
477 /* Set a flag option. */
478 static struct options_entry *
479 cmd_set_option_flag(__unused struct cmd *self, struct cmdq_item *item,
480     const struct options_table_entry *oe, struct options *oo,
481     const char *value)
482 {
483 	int	flag;
484 
485 	if (value == NULL || *value == '\0')
486 		flag = !options_get_number(oo, oe->name);
487 	else {
488 		if ((value[0] == '1' && value[1] == '\0') ||
489 		    strcasecmp(value, "on") == 0 ||
490 		    strcasecmp(value, "yes") == 0)
491 			flag = 1;
492 		else if ((value[0] == '0' && value[1] == '\0') ||
493 		    strcasecmp(value, "off") == 0 ||
494 		    strcasecmp(value, "no") == 0)
495 			flag = 0;
496 		else {
497 			cmdq_error(item, "bad value: %s", value);
498 			return (NULL);
499 		}
500 	}
501 
502 	return (options_set_number(oo, oe->name, flag));
503 }
504 
505 /* Set a choice option. */
506 static struct options_entry *
507 cmd_set_option_choice(__unused struct cmd *self, struct cmdq_item *item,
508     const struct options_table_entry *oe, struct options *oo,
509     const char *value)
510 {
511 	const char	**choicep;
512 	int		  n, choice = -1;
513 
514 	if (value == NULL) {
515 		choice = options_get_number(oo, oe->name);
516 		if (choice < 2)
517 			choice = !choice;
518 	} else {
519 		n = 0;
520 		for (choicep = oe->choices; *choicep != NULL; choicep++) {
521 			n++;
522 			if (strncmp(*choicep, value, strlen(value)) != 0)
523 				continue;
524 
525 			if (choice != -1) {
526 				cmdq_error(item, "ambiguous value: %s", value);
527 				return (NULL);
528 			}
529 			choice = n - 1;
530 		}
531 		if (choice == -1) {
532 			cmdq_error(item, "unknown value: %s", value);
533 			return (NULL);
534 		}
535 	}
536 
537 	return (options_set_number(oo, oe->name, choice));
538 }
539 
540 /* Set a style option. */
541 static struct options_entry *
542 cmd_set_option_style(struct cmd *self, struct cmdq_item *item,
543     const struct options_table_entry *oe, struct options *oo,
544     const char *value)
545 {
546 	struct args		*args = self->args;
547 	struct options_entry	*o;
548 	int			 append;
549 
550 	append = args_has(args, 'a');
551 	if ((o = options_set_style(oo, oe->name, value, append)) == NULL) {
552 		cmdq_error(item, "bad style: %s", value);
553 		return (NULL);
554 	}
555 
556 	style_update_old(oo, oe->name, &o->style);
557 	return (o);
558 }
559