xref: /openbsd-src/usr.bin/tmux/cmd-set-option.c (revision a12989f14b8bb5424453188b1a9caa36d5893d1b)
1 /* $OpenBSD: cmd-set-option.c,v 1.104 2017/01/12 15:36:35 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 		options_set_string(oo, optstr, args_has(args, 'a'), "%s",
296 		    valstr);
297 	}
298 	return (CMD_RETURN_NORMAL);
299 }
300 
301 /* Unset an option. */
302 static int
303 cmd_set_option_unset(struct cmd *self, struct cmdq_item *item,
304     const struct options_table_entry *oe, struct options *oo,
305     const char *value)
306 {
307 	struct args	*args = self->args;
308 
309 	if (value != NULL) {
310 		cmdq_error(item, "value passed to unset option: %s", oe->name);
311 		return (-1);
312 	}
313 
314 	if (args_has(args, 'g') || oo == global_options) {
315 		switch (oe->type) {
316 		case OPTIONS_TABLE_STRING:
317 			options_set_string(oo, oe->name, 0, "%s",
318 			    oe->default_str);
319 			break;
320 		case OPTIONS_TABLE_STYLE:
321 			options_set_style(oo, oe->name, 0, oe->default_str);
322 			break;
323 		default:
324 			options_set_number(oo, oe->name, oe->default_num);
325 			break;
326 		}
327 	} else
328 		options_remove(oo, oe->name);
329 	return (0);
330 }
331 
332 /* Set an option. */
333 static int
334 cmd_set_option_set(struct cmd *self, struct cmdq_item *item,
335     const struct options_table_entry *oe, struct options *oo,
336     const char *value)
337 {
338 	struct options_entry	*o;
339 
340 	switch (oe->type) {
341 	case OPTIONS_TABLE_FLAG:
342 	case OPTIONS_TABLE_CHOICE:
343 		break;
344 	default:
345 		if (value == NULL) {
346 			cmdq_error(item, "empty value");
347 			return (-1);
348 		}
349 	}
350 
351 	o = NULL;
352 	switch (oe->type) {
353 	case OPTIONS_TABLE_STRING:
354 		o = cmd_set_option_string(self, item, oe, oo, value);
355 		break;
356 	case OPTIONS_TABLE_NUMBER:
357 		o = cmd_set_option_number(self, item, oe, oo, value);
358 		break;
359 	case OPTIONS_TABLE_KEY:
360 		o = cmd_set_option_key(self, item, oe, oo, value);
361 		break;
362 	case OPTIONS_TABLE_COLOUR:
363 		o = cmd_set_option_colour(self, item, oe, oo, value);
364 		if (o != NULL)
365 			style_update_new(oo, o->name, oe->style);
366 		break;
367 	case OPTIONS_TABLE_ATTRIBUTES:
368 		o = cmd_set_option_attributes(self, item, oe, oo, value);
369 		if (o != NULL)
370 			style_update_new(oo, o->name, oe->style);
371 		break;
372 	case OPTIONS_TABLE_FLAG:
373 		o = cmd_set_option_flag(self, item, oe, oo, value);
374 		break;
375 	case OPTIONS_TABLE_CHOICE:
376 		o = cmd_set_option_choice(self, item, oe, oo, value);
377 		break;
378 	case OPTIONS_TABLE_STYLE:
379 		o = cmd_set_option_style(self, item, oe, oo, value);
380 		break;
381 	}
382 	if (o == NULL)
383 		return (-1);
384 	return (0);
385 }
386 
387 /* Set a string option. */
388 static struct options_entry *
389 cmd_set_option_string(struct cmd *self, __unused struct cmdq_item *item,
390     const struct options_table_entry *oe, struct options *oo,
391     const char *value)
392 {
393 	struct args	*args = self->args;
394 	int		 append = args_has(args, 'a');
395 
396 	return (options_set_string(oo, oe->name, append, "%s", value));
397 }
398 
399 /* Set a number option. */
400 static struct options_entry *
401 cmd_set_option_number(__unused struct cmd *self, struct cmdq_item *item,
402     const struct options_table_entry *oe, struct options *oo,
403     const char *value)
404 {
405 	long long	 ll;
406 	const char     	*errstr;
407 
408 	ll = strtonum(value, oe->minimum, oe->maximum, &errstr);
409 	if (errstr != NULL) {
410 		cmdq_error(item, "value is %s: %s", errstr, value);
411 		return (NULL);
412 	}
413 
414 	return (options_set_number(oo, oe->name, ll));
415 }
416 
417 /* Set a key option. */
418 static struct options_entry *
419 cmd_set_option_key(__unused struct cmd *self, struct cmdq_item *item,
420     const struct options_table_entry *oe, struct options *oo,
421     const char *value)
422 {
423 	key_code	key;
424 
425 	key = key_string_lookup_string(value);
426 	if (key == KEYC_UNKNOWN) {
427 		cmdq_error(item, "bad key: %s", value);
428 		return (NULL);
429 	}
430 
431 	return (options_set_number(oo, oe->name, key));
432 }
433 
434 /* Set a colour option. */
435 static struct options_entry *
436 cmd_set_option_colour(__unused struct cmd *self, struct cmdq_item *item,
437     const struct options_table_entry *oe, struct options *oo,
438     const char *value)
439 {
440 	int	colour;
441 
442 	if ((colour = colour_fromstring(value)) == -1) {
443 		cmdq_error(item, "bad colour: %s", value);
444 		return (NULL);
445 	}
446 
447 	return (options_set_number(oo, oe->name, colour));
448 }
449 
450 /* Set an attributes option. */
451 static struct options_entry *
452 cmd_set_option_attributes(__unused struct cmd *self, struct cmdq_item *item,
453     const struct options_table_entry *oe, struct options *oo,
454     const char *value)
455 {
456 	int	attr;
457 
458 	if ((attr = attributes_fromstring(value)) == -1) {
459 		cmdq_error(item, "bad attributes: %s", value);
460 		return (NULL);
461 	}
462 
463 	return (options_set_number(oo, oe->name, attr));
464 }
465 
466 /* Set a flag option. */
467 static struct options_entry *
468 cmd_set_option_flag(__unused struct cmd *self, struct cmdq_item *item,
469     const struct options_table_entry *oe, struct options *oo,
470     const char *value)
471 {
472 	int	flag;
473 
474 	if (value == NULL || *value == '\0')
475 		flag = !options_get_number(oo, oe->name);
476 	else {
477 		if ((value[0] == '1' && value[1] == '\0') ||
478 		    strcasecmp(value, "on") == 0 ||
479 		    strcasecmp(value, "yes") == 0)
480 			flag = 1;
481 		else if ((value[0] == '0' && value[1] == '\0') ||
482 		    strcasecmp(value, "off") == 0 ||
483 		    strcasecmp(value, "no") == 0)
484 			flag = 0;
485 		else {
486 			cmdq_error(item, "bad value: %s", value);
487 			return (NULL);
488 		}
489 	}
490 
491 	return (options_set_number(oo, oe->name, flag));
492 }
493 
494 /* Set a choice option. */
495 static struct options_entry *
496 cmd_set_option_choice(__unused struct cmd *self, struct cmdq_item *item,
497     const struct options_table_entry *oe, struct options *oo,
498     const char *value)
499 {
500 	const char	**choicep;
501 	int		  n, choice = -1;
502 
503 	if (value == NULL) {
504 		choice = options_get_number(oo, oe->name);
505 		if (choice < 2)
506 			choice = !choice;
507 	} else {
508 		n = 0;
509 		for (choicep = oe->choices; *choicep != NULL; choicep++) {
510 			n++;
511 			if (strncmp(*choicep, value, strlen(value)) != 0)
512 				continue;
513 
514 			if (choice != -1) {
515 				cmdq_error(item, "ambiguous value: %s", value);
516 				return (NULL);
517 			}
518 			choice = n - 1;
519 		}
520 		if (choice == -1) {
521 			cmdq_error(item, "unknown value: %s", value);
522 			return (NULL);
523 		}
524 	}
525 
526 	return (options_set_number(oo, oe->name, choice));
527 }
528 
529 /* Set a style option. */
530 static struct options_entry *
531 cmd_set_option_style(struct cmd *self, struct cmdq_item *item,
532     const struct options_table_entry *oe, struct options *oo,
533     const char *value)
534 {
535 	struct args		*args = self->args;
536 	int			 append = args_has(args, 'a');
537 	struct options_entry	*o;
538 
539 	if ((o = options_set_style(oo, oe->name, append, value)) == NULL) {
540 		cmdq_error(item, "bad style: %s", value);
541 		return (NULL);
542 	}
543 
544 	style_update_old(oo, oe->name, &o->style);
545 	return (o);
546 }
547