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