xref: /openbsd-src/usr.bin/tmux/cmd-set-option.c (revision a8c9f8391cc553aa4d86398b1dedfc0f0cb99cfa)
1 /* $OpenBSD: cmd-set-option.c,v 1.64 2014/01/28 23:07:09 nicm Exp $ */
2 
3 /*
4  * Copyright (c) 2007 Nicholas Marriott <nicm@users.sourceforge.net>
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 	"set-option", "set",
69 	"agoqst:uw", 1, 2,
70 	"[-agosquw] [-t target-session|target-window] option [value]",
71 	0,
72 	NULL,
73 	cmd_set_option_exec
74 };
75 
76 const struct cmd_entry cmd_set_window_option_entry = {
77 	"set-window-option", "setw",
78 	"agoqt:u", 1, 2,
79 	"[-agoqu] " CMD_TARGET_WINDOW_USAGE " option [value]",
80 	0,
81 	NULL,
82 	cmd_set_option_exec
83 };
84 
85 enum cmd_retval
86 cmd_set_option_exec(struct cmd *self, struct cmd_q *cmdq)
87 {
88 	struct args				*args = self->args;
89 	const struct options_table_entry	*table, *oe;
90 	struct session				*s;
91 	struct winlink				*wl;
92 	struct client				*c;
93 	struct options				*oo;
94 	struct window				*w;
95 	const char				*optstr, *valstr;
96 	u_int					 i;
97 
98 	/* Get the option name and value. */
99 	optstr = args->argv[0];
100 	if (*optstr == '\0') {
101 		cmdq_error(cmdq, "invalid option");
102 		return (CMD_RETURN_ERROR);
103 	}
104 	if (args->argc < 2)
105 		valstr = NULL;
106 	else
107 		valstr = args->argv[1];
108 
109 	/* Is this a user option? */
110 	if (*optstr == '@')
111 		return (cmd_set_option_user(self, cmdq, optstr, valstr));
112 
113 	/* Find the option entry, try each table. */
114 	table = oe = NULL;
115 	if (options_table_find(optstr, &table, &oe) != 0) {
116 		cmdq_error(cmdq, "ambiguous option: %s", optstr);
117 		return (CMD_RETURN_ERROR);
118 	}
119 	if (oe == NULL) {
120 		cmdq_error(cmdq, "unknown option: %s", optstr);
121 		return (CMD_RETURN_ERROR);
122 	}
123 
124 	/* Work out the tree from the table. */
125 	if (table == server_options_table)
126 		oo = &global_options;
127 	else if (table == window_options_table) {
128 		if (args_has(self->args, 'g'))
129 			oo = &global_w_options;
130 		else {
131 			wl = cmd_find_window(cmdq, args_get(args, 't'), NULL);
132 			if (wl == NULL) {
133 				cmdq_error(cmdq,
134 				    "couldn't set '%s'%s", optstr,
135 				    (!args_has(args, 't') && !args_has(args,
136 				    'g')) ? " need target window or -g" : "");
137 				return (CMD_RETURN_ERROR);
138 			}
139 			oo = &wl->window->options;
140 		}
141 	} else if (table == session_options_table) {
142 		if (args_has(self->args, 'g'))
143 			oo = &global_s_options;
144 		else {
145 			s = cmd_find_session(cmdq, args_get(args, 't'), 0);
146 			if (s == NULL) {
147 				cmdq_error(cmdq,
148 				    "couldn't set '%s'%s", optstr,
149 				    (!args_has(args, 't') && !args_has(args,
150 				    'g')) ? " need target session or -g" : "");
151 				return (CMD_RETURN_ERROR);
152 			}
153 			oo = &s->options;
154 		}
155 	} else {
156 		cmdq_error(cmdq, "unknown table");
157 		return (CMD_RETURN_ERROR);
158 	}
159 
160 	/* Unset or set the option. */
161 	if (args_has(args, 'u')) {
162 		if (cmd_set_option_unset(self, cmdq, oe, oo, valstr) != 0)
163 			return (CMD_RETURN_ERROR);
164 	} else {
165 		if (args_has(args, 'o') && options_find1(oo, optstr) != NULL) {
166 			if (!args_has(args, 'q'))
167 				cmdq_print(cmdq, "already set: %s", optstr);
168 			return (CMD_RETURN_NORMAL);
169 		}
170 		if (cmd_set_option_set(self, cmdq, oe, oo, valstr) != 0)
171 			return (CMD_RETURN_ERROR);
172 	}
173 
174 	/* Start or stop timers when automatic-rename changed. */
175 	if (strcmp (oe->name, "automatic-rename") == 0) {
176 		for (i = 0; i < ARRAY_LENGTH(&windows); i++) {
177 			if ((w = ARRAY_ITEM(&windows, i)) == NULL)
178 				continue;
179 			if (options_get_number(&w->options, "automatic-rename"))
180 				queue_window_name(w);
181 			else if (event_initialized(&w->name_timer))
182 				evtimer_del(&w->name_timer);
183 		}
184 	}
185 
186 	/* Update sizes and redraw. May not need it but meh. */
187 	recalculate_sizes();
188 	for (i = 0; i < ARRAY_LENGTH(&clients); i++) {
189 		c = ARRAY_ITEM(&clients, i);
190 		if (c != NULL && c->session != NULL)
191 			server_redraw_client(c);
192 	}
193 
194 	return (CMD_RETURN_NORMAL);
195 }
196 
197 /* Set user option. */
198 enum cmd_retval
199 cmd_set_option_user(struct cmd *self, struct cmd_q *cmdq, const char* optstr,
200     const char *valstr)
201 {
202 	struct args	*args = self->args;
203 	struct session	*s;
204 	struct winlink	*wl;
205 	struct options	*oo;
206 
207 	if (args_has(args, 's'))
208 		oo = &global_options;
209 	else if (args_has(self->args, 'w') ||
210 	    self->entry == &cmd_set_window_option_entry) {
211 		if (args_has(self->args, 'g'))
212 			oo = &global_w_options;
213 		else {
214 			wl = cmd_find_window(cmdq, args_get(args, 't'), NULL);
215 			if (wl == NULL)
216 				return (CMD_RETURN_ERROR);
217 			oo = &wl->window->options;
218 		}
219 	} else {
220 		if (args_has(self->args, 'g'))
221 			oo = &global_s_options;
222 		else {
223 			s = cmd_find_session(cmdq, args_get(args, 't'), 0);
224 			if (s == NULL)
225 				return (CMD_RETURN_ERROR);
226 			oo = &s->options;
227 		}
228 	}
229 
230 	if (args_has(args, 'u')) {
231 		if (options_find1(oo, optstr) == NULL) {
232 			cmdq_error(cmdq, "unknown option: %s", optstr);
233 			return (CMD_RETURN_ERROR);
234 		}
235 		if (valstr != NULL) {
236 			cmdq_error(cmdq, "value passed to unset option: %s",
237 			    optstr);
238 			return (CMD_RETURN_ERROR);
239 		}
240 		options_remove(oo, optstr);
241 	} else {
242 		if (valstr == NULL) {
243 			cmdq_error(cmdq, "empty value");
244 			return (CMD_RETURN_ERROR);
245 		}
246 		if (args_has(args, 'o') && options_find1(oo, optstr) != NULL) {
247 			if (!args_has(args, 'q'))
248 				cmdq_print(cmdq, "already set: %s", optstr);
249 			return (CMD_RETURN_NORMAL);
250 		}
251 		options_set_string(oo, optstr, "%s", valstr);
252 		if (!args_has(args, 'q')) {
253 			cmdq_info(cmdq, "set option: %s -> %s", optstr,
254 			    valstr);
255 		}
256 	}
257 	return (CMD_RETURN_NORMAL);
258 }
259 
260 
261 /* Unset an option. */
262 int
263 cmd_set_option_unset(struct cmd *self, struct cmd_q *cmdq,
264     const struct options_table_entry *oe, struct options *oo, const char *value)
265 {
266 	struct args	*args = self->args;
267 
268 	if (args_has(args, 'g')) {
269 		cmdq_error(cmdq, "can't unset global option: %s", oe->name);
270 		return (-1);
271 	}
272 	if (value != NULL) {
273 		cmdq_error(cmdq, "value passed to unset option: %s", oe->name);
274 		return (-1);
275 	}
276 
277 	options_remove(oo, oe->name);
278 	if (!args_has(args, 'q'))
279 		cmdq_info(cmdq, "unset option: %s", oe->name);
280 	return (0);
281 }
282 
283 /* Set an option. */
284 int
285 cmd_set_option_set(struct cmd *self, struct cmd_q *cmdq,
286     const struct options_table_entry *oe, struct options *oo, const char *value)
287 {
288 	struct args		*args = self->args;
289 	struct options_entry	*o;
290 	const char		*s;
291 
292 	if (oe->type != OPTIONS_TABLE_FLAG && value == NULL) {
293 		cmdq_error(cmdq, "empty value");
294 		return (-1);
295 	}
296 
297 	o = NULL;
298 	switch (oe->type) {
299 	case OPTIONS_TABLE_STRING:
300 		o = cmd_set_option_string(self, cmdq, oe, oo, value);
301 		break;
302 	case OPTIONS_TABLE_NUMBER:
303 		o = cmd_set_option_number(self, cmdq, oe, oo, value);
304 		break;
305 	case OPTIONS_TABLE_KEY:
306 		o = cmd_set_option_key(self, cmdq, oe, oo, value);
307 		break;
308 	case OPTIONS_TABLE_COLOUR:
309 		o = cmd_set_option_colour(self, cmdq, oe, oo, value);
310 		style_update_new(oo, o->name, oe->style);
311 		break;
312 	case OPTIONS_TABLE_ATTRIBUTES:
313 		o = cmd_set_option_attributes(self, cmdq, oe, oo, value);
314 		style_update_new(oo, o->name, oe->style);
315 		break;
316 	case OPTIONS_TABLE_FLAG:
317 		o = cmd_set_option_flag(self, cmdq, oe, oo, value);
318 		break;
319 	case OPTIONS_TABLE_CHOICE:
320 		o = cmd_set_option_choice(self, cmdq, oe, oo, value);
321 		break;
322 	case OPTIONS_TABLE_STYLE:
323 		o = cmd_set_option_style(self, cmdq, oe, oo, value);
324 		break;
325 	}
326 	if (o == NULL)
327 		return (-1);
328 
329 	s = options_table_print_entry(oe, o, 0);
330 	if (!args_has(args, 'q'))
331 		cmdq_info(cmdq, "set option: %s -> %s", oe->name, s);
332 	return (0);
333 }
334 
335 /* Set a string option. */
336 struct options_entry *
337 cmd_set_option_string(struct cmd *self, unused struct cmd_q *cmdq,
338     const struct options_table_entry *oe, struct options *oo, const char *value)
339 {
340 	struct args		*args = self->args;
341 	struct options_entry	*o;
342 	char			*oldval, *newval;
343 
344 	if (args_has(args, 'a')) {
345 		oldval = options_get_string(oo, oe->name);
346 		xasprintf(&newval, "%s%s", oldval, value);
347 	} else
348 		newval = xstrdup(value);
349 
350 	o = options_set_string(oo, oe->name, "%s", newval);
351 
352 	free(newval);
353 	return (o);
354 }
355 
356 /* Set a number option. */
357 struct options_entry *
358 cmd_set_option_number(unused struct cmd *self, struct cmd_q *cmdq,
359     const struct options_table_entry *oe, struct options *oo, const char *value)
360 {
361 	long long	 ll;
362 	const char     	*errstr;
363 
364 	ll = strtonum(value, oe->minimum, oe->maximum, &errstr);
365 	if (errstr != NULL) {
366 		cmdq_error(cmdq, "value is %s: %s", errstr, value);
367 		return (NULL);
368 	}
369 
370 	return (options_set_number(oo, oe->name, ll));
371 }
372 
373 /* Set a key option. */
374 struct options_entry *
375 cmd_set_option_key(unused struct cmd *self, struct cmd_q *cmdq,
376     const struct options_table_entry *oe, struct options *oo, const char *value)
377 {
378 	int	key;
379 
380 	if ((key = key_string_lookup_string(value)) == KEYC_NONE) {
381 		cmdq_error(cmdq, "bad key: %s", value);
382 		return (NULL);
383 	}
384 
385 	return (options_set_number(oo, oe->name, key));
386 }
387 
388 /* Set a colour option. */
389 struct options_entry *
390 cmd_set_option_colour(unused struct cmd *self, struct cmd_q *cmdq,
391     const struct options_table_entry *oe, struct options *oo, const char *value)
392 {
393 	int	colour;
394 
395 	if ((colour = colour_fromstring(value)) == -1) {
396 		cmdq_error(cmdq, "bad colour: %s", value);
397 		return (NULL);
398 	}
399 
400 	return (options_set_number(oo, oe->name, colour));
401 }
402 
403 /* Set an attributes option. */
404 struct options_entry *
405 cmd_set_option_attributes(unused struct cmd *self, struct cmd_q *cmdq,
406     const struct options_table_entry *oe, struct options *oo, const char *value)
407 {
408 	int	attr;
409 
410 	if ((attr = attributes_fromstring(value)) == -1) {
411 		cmdq_error(cmdq, "bad attributes: %s", value);
412 		return (NULL);
413 	}
414 
415 	return (options_set_number(oo, oe->name, attr));
416 }
417 
418 /* Set a flag option. */
419 struct options_entry *
420 cmd_set_option_flag(unused struct cmd *self, struct cmd_q *cmdq,
421     const struct options_table_entry *oe, struct options *oo, const char *value)
422 {
423 	int	flag;
424 
425 	if (value == NULL || *value == '\0')
426 		flag = !options_get_number(oo, oe->name);
427 	else {
428 		if ((value[0] == '1' && value[1] == '\0') ||
429 		    strcasecmp(value, "on") == 0 ||
430 		    strcasecmp(value, "yes") == 0)
431 			flag = 1;
432 		else if ((value[0] == '0' && value[1] == '\0') ||
433 		    strcasecmp(value, "off") == 0 ||
434 		    strcasecmp(value, "no") == 0)
435 			flag = 0;
436 		else {
437 			cmdq_error(cmdq, "bad value: %s", value);
438 			return (NULL);
439 		}
440 	}
441 
442 	return (options_set_number(oo, oe->name, flag));
443 }
444 
445 /* Set a choice option. */
446 struct options_entry *
447 cmd_set_option_choice(unused struct cmd *self, struct cmd_q *cmdq,
448     const struct options_table_entry *oe, struct options *oo,
449     const char *value)
450 {
451 	const char	**choicep;
452 	int		  n, choice = -1;
453 
454 	n = 0;
455 	for (choicep = oe->choices; *choicep != NULL; choicep++) {
456 		n++;
457 		if (strncmp(*choicep, value, strlen(value)) != 0)
458 			continue;
459 
460 		if (choice != -1) {
461 			cmdq_error(cmdq, "ambiguous value: %s", value);
462 			return (NULL);
463 		}
464 		choice = n - 1;
465 	}
466 	if (choice == -1) {
467 		cmdq_error(cmdq, "unknown value: %s", value);
468 		return (NULL);
469 	}
470 
471 	return (options_set_number(oo, oe->name, choice));
472 }
473 
474 /* Set a style option. */
475 struct options_entry *
476 cmd_set_option_style(struct cmd *self, struct cmd_q *cmdq,
477     const struct options_table_entry *oe, struct options *oo,
478     const char *value)
479 {
480 	struct args		*args = self->args;
481 	struct options_entry	*o;
482 	int			 append;
483 
484 	append = args_has(args, 'a');
485 	if ((o = options_set_style(oo, oe->name, value, append)) == NULL) {
486 		cmdq_error(cmdq, "bad style: %s", value);
487 		return (NULL);
488 	}
489 
490 	style_update_old(oo, oe->name, &o->style);
491 	return (o);
492 }
493