xref: /openbsd/usr.bin/tmux/cmd-set-option.c (revision 5af055cd)
1 /* $OpenBSD: cmd-set-option.c,v 1.94 2016/03/03 14:15:22 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 enum cmd_retval	cmd_set_option_exec(struct cmd *, struct cmd_q *);
31 
32 enum cmd_retval	cmd_set_option_user(struct cmd *, struct cmd_q *,
33 	    const char *, const char *);
34 
35 int	cmd_set_option_unset(struct cmd *, struct cmd_q *,
36 	    const struct options_table_entry *, struct options *,
37 	    const char *);
38 int	cmd_set_option_set(struct cmd *, struct cmd_q *,
39 	    const struct options_table_entry *, struct options *,
40 	    const char *);
41 
42 struct options_entry *cmd_set_option_string(struct cmd *, struct cmd_q *,
43 	    const struct options_table_entry *, struct options *,
44 	    const char *);
45 struct options_entry *cmd_set_option_number(struct cmd *, struct cmd_q *,
46 	    const struct options_table_entry *, struct options *,
47 	    const char *);
48 struct options_entry *cmd_set_option_key(struct cmd *, struct cmd_q *,
49 	    const struct options_table_entry *, struct options *,
50 	    const char *);
51 struct options_entry *cmd_set_option_colour(struct cmd *, struct cmd_q *,
52 	    const struct options_table_entry *, struct options *,
53 	    const char *);
54 struct options_entry *cmd_set_option_attributes(struct cmd *, struct cmd_q *,
55 	    const struct options_table_entry *, struct options *,
56 	    const char *);
57 struct options_entry *cmd_set_option_flag(struct cmd *, struct cmd_q *,
58 	    const struct options_table_entry *, struct options *,
59 	    const char *);
60 struct options_entry *cmd_set_option_choice(struct cmd *, struct cmd_q *,
61 	    const struct options_table_entry *, struct options *,
62 	    const char *);
63 struct options_entry *cmd_set_option_style(struct cmd *, struct cmd_q *,
64 	    const struct options_table_entry *, struct options *,
65 	    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 = 0,
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 = 0,
90 	.exec = cmd_set_option_exec
91 };
92 
93 enum cmd_retval
94 cmd_set_option_exec(struct cmd *self, struct cmd_q *cmdq)
95 {
96 	struct args				*args = self->args;
97 	struct session				*s = cmdq->state.tflag.s;
98 	struct winlink				*wl = cmdq->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(cmdq, "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, cmdq, optstr, valstr));
119 
120 	/* Find the option entry, try each table. */
121 	oe = NULL;
122 	if (options_table_find(optstr, &oe) != 0) {
123 		if (!args_has(args, 'q')) {
124 			cmdq_error(cmdq, "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(cmdq, "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(cmdq, "no such window: %s",
147 				    target);
148 			} else
149 				cmdq_error(cmdq, "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(cmdq, "no such session: %s",
160 				    target);
161 			} else
162 				cmdq_error(cmdq, "no current session");
163 			return (CMD_RETURN_ERROR);
164 		} else
165 			oo = s->options;
166 	} else {
167 		cmdq_error(cmdq, "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, cmdq, 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(cmdq, "already set: %s", optstr);
179 				return (CMD_RETURN_ERROR);
180 			}
181 			return (CMD_RETURN_NORMAL);
182 		}
183 		if (cmd_set_option_set(self, cmdq, oe, oo, valstr) != 0)
184 			return (CMD_RETURN_ERROR);
185 	}
186 
187 	/* Start or stop timers if necessary. */
188 	if (strcmp(oe->name, "automatic-rename") == 0) {
189 		RB_FOREACH(w, windows, &windows) {
190 			if (options_get_number(w->options, "automatic-rename"))
191 				w->active->flags |= PANE_CHANGED;
192 		}
193 	}
194 	if (strcmp(oe->name, "key-table") == 0) {
195 		TAILQ_FOREACH(c, &clients, entry)
196 			server_client_set_key_table(c, NULL);
197 	}
198 	if (strcmp(oe->name, "status") == 0 ||
199 	    strcmp(oe->name, "status-interval") == 0)
200 		status_timer_start_all();
201 	if (strcmp(oe->name, "monitor-silence") == 0)
202 		alerts_reset_all();
203 
204 	/* Update sizes and redraw. May not need it but meh. */
205 	recalculate_sizes();
206 	TAILQ_FOREACH(c, &clients, entry) {
207 		if (c->session != NULL)
208 			server_redraw_client(c);
209 	}
210 
211 	return (CMD_RETURN_NORMAL);
212 }
213 
214 /* Set user option. */
215 enum cmd_retval
216 cmd_set_option_user(struct cmd *self, struct cmd_q *cmdq, const char *optstr,
217     const char *valstr)
218 {
219 	struct args	*args = self->args;
220 	struct session	*s = cmdq->state.tflag.s;
221 	struct winlink	*wl = cmdq->state.tflag.wl;
222 	struct options	*oo;
223 
224 	if (args_has(args, 's'))
225 		oo = global_options;
226 	else if (args_has(self->args, 'w') ||
227 	    self->entry == &cmd_set_window_option_entry) {
228 		if (args_has(self->args, 'g'))
229 			oo = global_w_options;
230 		else
231 			oo = wl->window->options;
232 	} else {
233 		if (args_has(self->args, 'g'))
234 			oo = global_s_options;
235 		else
236 			oo = s->options;
237 	}
238 
239 	if (args_has(args, 'u')) {
240 		if (options_find1(oo, optstr) == NULL) {
241 			if (!args_has(args, 'q')) {
242 				cmdq_error(cmdq, "unknown option: %s", optstr);
243 				return (CMD_RETURN_ERROR);
244 			}
245 			return (CMD_RETURN_NORMAL);
246 		}
247 		if (valstr != NULL) {
248 			cmdq_error(cmdq, "value passed to unset option: %s",
249 			    optstr);
250 			return (CMD_RETURN_ERROR);
251 		}
252 		options_remove(oo, optstr);
253 	} else {
254 		if (valstr == NULL) {
255 			cmdq_error(cmdq, "empty value");
256 			return (CMD_RETURN_ERROR);
257 		}
258 		if (args_has(args, 'o') && options_find1(oo, optstr) != NULL) {
259 			if (!args_has(args, 'q')) {
260 				cmdq_error(cmdq, "already set: %s", optstr);
261 				return (CMD_RETURN_ERROR);
262 			}
263 			return (CMD_RETURN_NORMAL);
264 		}
265 		options_set_string(oo, optstr, "%s", valstr);
266 	}
267 	return (CMD_RETURN_NORMAL);
268 }
269 
270 /* Unset an option. */
271 int
272 cmd_set_option_unset(struct cmd *self, struct cmd_q *cmdq,
273     const struct options_table_entry *oe, struct options *oo,
274     const char *value)
275 {
276 	struct args	*args = self->args;
277 
278 	if (value != NULL) {
279 		cmdq_error(cmdq, "value passed to unset option: %s", oe->name);
280 		return (-1);
281 	}
282 
283 	if (args_has(args, 'g') || oo == global_options) {
284 		switch (oe->type) {
285 		case OPTIONS_TABLE_STRING:
286 			options_set_string(oo, oe->name, "%s", oe->default_str);
287 			break;
288 		case OPTIONS_TABLE_STYLE:
289 			options_set_style(oo, oe->name, oe->default_str, 0);
290 			break;
291 		default:
292 			options_set_number(oo, oe->name, oe->default_num);
293 			break;
294 		}
295 	} else
296 		options_remove(oo, oe->name);
297 	return (0);
298 }
299 
300 /* Set an option. */
301 int
302 cmd_set_option_set(struct cmd *self, struct cmd_q *cmdq,
303     const struct options_table_entry *oe, struct options *oo,
304     const char *value)
305 {
306 	struct options_entry	*o;
307 
308 	switch (oe->type) {
309 	case OPTIONS_TABLE_FLAG:
310 	case OPTIONS_TABLE_CHOICE:
311 		break;
312 	default:
313 		if (value == NULL) {
314 			cmdq_error(cmdq, "empty value");
315 			return (-1);
316 		}
317 	}
318 
319 	o = NULL;
320 	switch (oe->type) {
321 	case OPTIONS_TABLE_STRING:
322 		o = cmd_set_option_string(self, cmdq, oe, oo, value);
323 		break;
324 	case OPTIONS_TABLE_NUMBER:
325 		o = cmd_set_option_number(self, cmdq, oe, oo, value);
326 		break;
327 	case OPTIONS_TABLE_KEY:
328 		o = cmd_set_option_key(self, cmdq, oe, oo, value);
329 		break;
330 	case OPTIONS_TABLE_COLOUR:
331 		o = cmd_set_option_colour(self, cmdq, oe, oo, value);
332 		if (o != NULL)
333 			style_update_new(oo, o->name, oe->style);
334 		break;
335 	case OPTIONS_TABLE_ATTRIBUTES:
336 		o = cmd_set_option_attributes(self, cmdq, oe, oo, value);
337 		if (o != NULL)
338 			style_update_new(oo, o->name, oe->style);
339 		break;
340 	case OPTIONS_TABLE_FLAG:
341 		o = cmd_set_option_flag(self, cmdq, oe, oo, value);
342 		break;
343 	case OPTIONS_TABLE_CHOICE:
344 		o = cmd_set_option_choice(self, cmdq, oe, oo, value);
345 		break;
346 	case OPTIONS_TABLE_STYLE:
347 		o = cmd_set_option_style(self, cmdq, oe, oo, value);
348 		break;
349 	}
350 	if (o == NULL)
351 		return (-1);
352 	return (0);
353 }
354 
355 /* Set a string option. */
356 struct options_entry *
357 cmd_set_option_string(struct cmd *self, __unused struct cmd_q *cmdq,
358     const struct options_table_entry *oe, struct options *oo,
359     const char *value)
360 {
361 	struct args		*args = self->args;
362 	struct options_entry	*o;
363 	char			*oldval, *newval;
364 
365 	if (args_has(args, 'a')) {
366 		oldval = options_get_string(oo, oe->name);
367 		xasprintf(&newval, "%s%s", oldval, value);
368 	} else
369 		newval = xstrdup(value);
370 
371 	o = options_set_string(oo, oe->name, "%s", newval);
372 
373 	free(newval);
374 	return (o);
375 }
376 
377 /* Set a number option. */
378 struct options_entry *
379 cmd_set_option_number(__unused struct cmd *self, struct cmd_q *cmdq,
380     const struct options_table_entry *oe, struct options *oo,
381     const char *value)
382 {
383 	long long	 ll;
384 	const char     	*errstr;
385 
386 	ll = strtonum(value, oe->minimum, oe->maximum, &errstr);
387 	if (errstr != NULL) {
388 		cmdq_error(cmdq, "value is %s: %s", errstr, value);
389 		return (NULL);
390 	}
391 
392 	return (options_set_number(oo, oe->name, ll));
393 }
394 
395 /* Set a key option. */
396 struct options_entry *
397 cmd_set_option_key(__unused struct cmd *self, struct cmd_q *cmdq,
398     const struct options_table_entry *oe, struct options *oo,
399     const char *value)
400 {
401 	key_code	key;
402 
403 	key = key_string_lookup_string(value);
404 	if (key == KEYC_UNKNOWN) {
405 		cmdq_error(cmdq, "bad key: %s", value);
406 		return (NULL);
407 	}
408 
409 	return (options_set_number(oo, oe->name, key));
410 }
411 
412 /* Set a colour option. */
413 struct options_entry *
414 cmd_set_option_colour(__unused struct cmd *self, struct cmd_q *cmdq,
415     const struct options_table_entry *oe, struct options *oo,
416     const char *value)
417 {
418 	int	colour;
419 
420 	if ((colour = colour_fromstring(value)) == -1) {
421 		cmdq_error(cmdq, "bad colour: %s", value);
422 		return (NULL);
423 	}
424 
425 	return (options_set_number(oo, oe->name, colour));
426 }
427 
428 /* Set an attributes option. */
429 struct options_entry *
430 cmd_set_option_attributes(__unused struct cmd *self, struct cmd_q *cmdq,
431     const struct options_table_entry *oe, struct options *oo,
432     const char *value)
433 {
434 	int	attr;
435 
436 	if ((attr = attributes_fromstring(value)) == -1) {
437 		cmdq_error(cmdq, "bad attributes: %s", value);
438 		return (NULL);
439 	}
440 
441 	return (options_set_number(oo, oe->name, attr));
442 }
443 
444 /* Set a flag option. */
445 struct options_entry *
446 cmd_set_option_flag(__unused struct cmd *self, struct cmd_q *cmdq,
447     const struct options_table_entry *oe, struct options *oo,
448     const char *value)
449 {
450 	int	flag;
451 
452 	if (value == NULL || *value == '\0')
453 		flag = !options_get_number(oo, oe->name);
454 	else {
455 		if ((value[0] == '1' && value[1] == '\0') ||
456 		    strcasecmp(value, "on") == 0 ||
457 		    strcasecmp(value, "yes") == 0)
458 			flag = 1;
459 		else if ((value[0] == '0' && value[1] == '\0') ||
460 		    strcasecmp(value, "off") == 0 ||
461 		    strcasecmp(value, "no") == 0)
462 			flag = 0;
463 		else {
464 			cmdq_error(cmdq, "bad value: %s", value);
465 			return (NULL);
466 		}
467 	}
468 
469 	return (options_set_number(oo, oe->name, flag));
470 }
471 
472 /* Set a choice option. */
473 struct options_entry *
474 cmd_set_option_choice(__unused struct cmd *self, struct cmd_q *cmdq,
475     const struct options_table_entry *oe, struct options *oo,
476     const char *value)
477 {
478 	const char	**choicep;
479 	int		  n, choice = -1;
480 
481 	if (value == NULL) {
482 		choice = options_get_number(oo, oe->name);
483 		if (choice < 2)
484 			choice = !choice;
485 	} else {
486 		n = 0;
487 		for (choicep = oe->choices; *choicep != NULL; choicep++) {
488 			n++;
489 			if (strncmp(*choicep, value, strlen(value)) != 0)
490 				continue;
491 
492 			if (choice != -1) {
493 				cmdq_error(cmdq, "ambiguous value: %s", value);
494 				return (NULL);
495 			}
496 			choice = n - 1;
497 		}
498 		if (choice == -1) {
499 			cmdq_error(cmdq, "unknown value: %s", value);
500 			return (NULL);
501 		}
502 	}
503 
504 	return (options_set_number(oo, oe->name, choice));
505 }
506 
507 /* Set a style option. */
508 struct options_entry *
509 cmd_set_option_style(struct cmd *self, struct cmd_q *cmdq,
510     const struct options_table_entry *oe, struct options *oo,
511     const char *value)
512 {
513 	struct args		*args = self->args;
514 	struct options_entry	*o;
515 	int			 append;
516 
517 	append = args_has(args, 'a');
518 	if ((o = options_set_style(oo, oe->name, value, append)) == NULL) {
519 		cmdq_error(cmdq, "bad style: %s", value);
520 		return (NULL);
521 	}
522 
523 	style_update_old(oo, oe->name, &o->style);
524 	return (o);
525 }
526