xref: /openbsd-src/usr.bin/tmux/cmd-set-option.c (revision 8b73f3537bb9467ce77add8d0c2081a5dea1f143)
1 /* $OpenBSD: cmd-set-option.c,v 1.45 2011/01/04 01:58:12 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 int	cmd_set_option_exec(struct cmd *, struct cmd_ctx *);
31 
32 int	cmd_set_option_unset(struct cmd *, struct cmd_ctx *,
33 	    const struct options_table_entry *, struct options *,
34 	    const char *);
35 int	cmd_set_option_set(struct cmd *, struct cmd_ctx *,
36 	    const struct options_table_entry *, struct options *,
37 	    const char *);
38 
39 struct options_entry *cmd_set_option_string(struct cmd *, struct cmd_ctx *,
40 	    const struct options_table_entry *, struct options *,
41 	    const char *);
42 struct options_entry *cmd_set_option_number(struct cmd *, struct cmd_ctx *,
43 	    const struct options_table_entry *, struct options *,
44 	    const char *);
45 struct options_entry *cmd_set_option_keys(struct cmd *, struct cmd_ctx *,
46 	    const struct options_table_entry *, struct options *,
47 	    const char *);
48 struct options_entry *cmd_set_option_colour(struct cmd *, struct cmd_ctx *,
49 	    const struct options_table_entry *, struct options *,
50 	    const char *);
51 struct options_entry *cmd_set_option_attributes(struct cmd *, struct cmd_ctx *,
52 	    const struct options_table_entry *, struct options *,
53 	    const char *);
54 struct options_entry *cmd_set_option_flag(struct cmd *, struct cmd_ctx *,
55 	    const struct options_table_entry *, struct options *,
56 	    const char *);
57 struct options_entry *cmd_set_option_choice(struct cmd *, struct cmd_ctx *,
58 	    const struct options_table_entry *, struct options *,
59 	    const char *);
60 
61 const struct cmd_entry cmd_set_option_entry = {
62 	"set-option", "set",
63 	"agst:uw", 1, 2,
64 	"[-agsuw] [-t target-session|target-window] option [value]",
65 	0,
66 	NULL,
67 	NULL,
68 	cmd_set_option_exec
69 };
70 
71 int
72 cmd_set_option_exec(struct cmd *self, struct cmd_ctx *ctx)
73 {
74 	struct args				*args = self->args;
75 	const struct options_table_entry	*table, *oe, *oe_loop;
76 	struct session				*s;
77 	struct winlink				*wl;
78 	struct client				*c;
79 	struct options				*oo;
80 	struct jobs				*jobs;
81 	struct job				*job, *nextjob;
82 	const char				*optstr, *valstr;
83 	u_int					 i;
84 	int					 try_again;
85 
86 	/* Work out the options tree and table to use. */
87 	if (args_has(self->args, 's')) {
88 		oo = &global_options;
89 		table = server_options_table;
90 	} else if (args_has(self->args, 'w')) {
91 		table = window_options_table;
92 		if (args_has(self->args, 'g'))
93 			oo = &global_w_options;
94 		else {
95 			wl = cmd_find_window(ctx, args_get(args, 't'), NULL);
96 			if (wl == NULL)
97 				return (-1);
98 			oo = &wl->window->options;
99 		}
100 	} else {
101 		table = session_options_table;
102 		if (args_has(self->args, 'g'))
103 			oo = &global_s_options;
104 		else {
105 			s = cmd_find_session(ctx, args_get(args, 't'));
106 			if (s == NULL)
107 				return (-1);
108 			oo = &s->options;
109 		}
110 	}
111 
112 	/* Get the option name and value. */
113 	optstr = args->argv[0];
114 	if (*optstr == '\0') {
115 		ctx->error(ctx, "invalid option");
116 		return (-1);
117 	}
118 	if (args->argc < 2)
119 		valstr = NULL;
120 	else
121 		valstr = args->argv[1];
122 
123 	/* Find the option table entry. */
124 	oe = NULL;
125 	for (oe_loop = table; oe_loop->name != NULL; oe_loop++) {
126 		if (strncmp(oe_loop->name, optstr, strlen(optstr)) != 0)
127 			continue;
128 
129 		if (oe != NULL) {
130 			ctx->error(ctx, "ambiguous option: %s", optstr);
131 			return (-1);
132 		}
133 		oe = oe_loop;
134 
135 		/* Bail now if an exact match. */
136 		if (strcmp(oe->name, optstr) == 0)
137 			break;
138 	}
139 	if (oe == NULL) {
140 		ctx->error(ctx, "unknown option: %s", optstr);
141 		return (-1);
142 	}
143 
144 	/* Unset or set the option. */
145 	if (args_has(args, 'u')) {
146 		if (cmd_set_option_unset(self, ctx, oe, oo, valstr) != 0)
147 			return (-1);
148 	} else {
149 		if (cmd_set_option_set(self, ctx, oe, oo, valstr) != 0)
150 			return (-1);
151 	}
152 
153 	/* Update sizes and redraw. May not need it but meh. */
154 	recalculate_sizes();
155 	for (i = 0; i < ARRAY_LENGTH(&clients); i++) {
156 		c = ARRAY_ITEM(&clients, i);
157 		if (c != NULL && c->session != NULL)
158 			server_redraw_client(c);
159 	}
160 
161 	/*
162 	 * Special-case: kill all persistent jobs if status-left, status-right
163 	 * or set-titles-string have changed. Persistent jobs are only used by
164 	 * the status line at the moment so this works XXX.
165 	 */
166 	if (strcmp(oe->name, "status-left") == 0 ||
167 	    strcmp(oe->name, "status-right") == 0 ||
168 	    strcmp(oe->name, "status") == 0 ||
169 	    strcmp(oe->name, "set-titles-string") == 0 ||
170 	    strcmp(oe->name, "window-status-format") == 0) {
171 		for (i = 0; i < ARRAY_LENGTH(&clients); i++) {
172 			c = ARRAY_ITEM(&clients, i);
173 			if (c == NULL || c->session == NULL)
174 				continue;
175 
176 			jobs = &c->status_jobs;
177 			do {
178 				try_again = 0;
179 				job = RB_ROOT(jobs);
180 				while (job != NULL) {
181 					nextjob = RB_NEXT(jobs, jobs, job);
182 					if (job->flags & JOB_PERSIST) {
183 						job_remove(jobs, job);
184 						try_again = 1;
185 						break;
186 					}
187 					job = nextjob;
188 				}
189 			} while (try_again);
190 			server_redraw_client(c);
191 		}
192 	}
193 
194 	return (0);
195 }
196 
197 /* Unset an option. */
198 int
199 cmd_set_option_unset(struct cmd *self, struct cmd_ctx *ctx,
200     const struct options_table_entry *oe, struct options *oo, const char *value)
201 {
202 	struct args	*args = self->args;
203 
204 	if (args_has(args, 'g')) {
205 		ctx->error(ctx, "can't unset global option: %s", oe->name);
206 		return (-1);
207 	}
208 	if (value != NULL) {
209 		ctx->error(ctx, "value passed to unset option: %s", oe->name);
210 		return (-1);
211 	}
212 
213 	options_remove(oo, oe->name);
214 	ctx->info(ctx, "unset option: %s", oe->name);
215 	return (0);
216 }
217 
218 /* Set an option. */
219 int
220 cmd_set_option_set(struct cmd *self, struct cmd_ctx *ctx,
221     const struct options_table_entry *oe, struct options *oo, const char *value)
222 {
223 	struct options_entry	*o;
224 	const char		*s;
225 
226 	if (oe->type != OPTIONS_TABLE_FLAG && value == NULL) {
227 		ctx->error(ctx, "empty value");
228 		return (-1);
229 	}
230 
231 	o = NULL;
232 	switch (oe->type) {
233 	case OPTIONS_TABLE_STRING:
234 		o = cmd_set_option_string(self, ctx, oe, oo, value);
235 		break;
236 	case OPTIONS_TABLE_NUMBER:
237 		o = cmd_set_option_number(self, ctx, oe, oo, value);
238 		break;
239 	case OPTIONS_TABLE_KEYS:
240 		o = cmd_set_option_keys(self, ctx, oe, oo, value);
241 		break;
242 	case OPTIONS_TABLE_COLOUR:
243 		o = cmd_set_option_colour(self, ctx, oe, oo, value);
244 		break;
245 	case OPTIONS_TABLE_ATTRIBUTES:
246 		o = cmd_set_option_attributes(self, ctx, oe, oo, value);
247 		break;
248 	case OPTIONS_TABLE_FLAG:
249 		o = cmd_set_option_flag(self, ctx, oe, oo, value);
250 		break;
251 	case OPTIONS_TABLE_CHOICE:
252 		o = cmd_set_option_choice(self, ctx, oe, oo, value);
253 		break;
254 	}
255 	if (o == NULL)
256 		return (-1);
257 
258 	s = options_table_print_entry(oe, o);
259 	ctx->info(ctx, "set option: %s -> %s", oe->name, s);
260 	return (0);
261 }
262 
263 /* Set a string option. */
264 struct options_entry *
265 cmd_set_option_string(struct cmd *self, unused struct cmd_ctx *ctx,
266     const struct options_table_entry *oe, struct options *oo, const char *value)
267 {
268 	struct args	*args = self->args;
269 	struct options_entry	*o;
270 	char			*oldval, *newval;
271 
272 	if (args_has(args, 'a')) {
273 		oldval = options_get_string(oo, oe->name);
274 		xasprintf(&newval, "%s%s", oldval, value);
275 	} else
276 		newval = xstrdup(value);
277 
278 	o = options_set_string(oo, oe->name, "%s", newval);
279 
280 	xfree(newval);
281 	return (o);
282 }
283 
284 /* Set a number option. */
285 struct options_entry *
286 cmd_set_option_number(unused struct cmd *self, struct cmd_ctx *ctx,
287     const struct options_table_entry *oe, struct options *oo, const char *value)
288 {
289 	long long	 ll;
290 	const char     	*errstr;
291 
292 	ll = strtonum(value, oe->minimum, oe->maximum, &errstr);
293 	if (errstr != NULL) {
294 		ctx->error(ctx, "value is %s: %s", errstr, value);
295 		return (NULL);
296 	}
297 
298 	return (options_set_number(oo, oe->name, ll));
299 }
300 
301 /* Set a keys option. */
302 struct options_entry *
303 cmd_set_option_keys(unused struct cmd *self, struct cmd_ctx *ctx,
304     const struct options_table_entry *oe, struct options *oo, const char *value)
305 {
306 	struct keylist	*keylist;
307 	char		*copy, *ptr, *s;
308 	int		 key;
309 
310 	keylist = xmalloc(sizeof *keylist);
311 	ARRAY_INIT(keylist);
312 
313 	ptr = copy = xstrdup(value);
314 	while ((s = strsep(&ptr, ",")) != NULL) {
315 		if ((key = key_string_lookup_string(s)) == KEYC_NONE) {
316 			ctx->error(ctx, "unknown key: %s", s);
317 			xfree(copy);
318 			xfree(keylist);
319 			return (NULL);
320 		}
321 		ARRAY_ADD(keylist, key);
322 	}
323 	xfree(copy);
324 
325 	return (options_set_data(oo, oe->name, keylist, xfree));
326 }
327 
328 /* Set a colour option. */
329 struct options_entry *
330 cmd_set_option_colour(unused struct cmd *self, struct cmd_ctx *ctx,
331     const struct options_table_entry *oe, struct options *oo, const char *value)
332 {
333 	int	colour;
334 
335 	if ((colour = colour_fromstring(value)) == -1) {
336 		ctx->error(ctx, "bad colour: %s", value);
337 		return (NULL);
338 	}
339 
340 	return (options_set_number(oo, oe->name, colour));
341 }
342 
343 /* Set an attributes option. */
344 struct options_entry *
345 cmd_set_option_attributes(unused struct cmd *self, struct cmd_ctx *ctx,
346     const struct options_table_entry *oe, struct options *oo, const char *value)
347 {
348 	int	attr;
349 
350 	if ((attr = attributes_fromstring(value)) == -1) {
351 		ctx->error(ctx, "bad attributes: %s", value);
352 		return (NULL);
353 	}
354 
355 	return (options_set_number(oo, oe->name, attr));
356 }
357 
358 /* Set a flag option. */
359 struct options_entry *
360 cmd_set_option_flag(unused struct cmd *self, struct cmd_ctx *ctx,
361     const struct options_table_entry *oe, struct options *oo, const char *value)
362 {
363 	int	flag;
364 
365 	if (value == NULL || *value == '\0')
366 		flag = !options_get_number(oo, oe->name);
367 	else {
368 		if ((value[0] == '1' && value[1] == '\0') ||
369 		    strcasecmp(value, "on") == 0 ||
370 		    strcasecmp(value, "yes") == 0)
371 			flag = 1;
372 		else if ((value[0] == '0' && value[1] == '\0') ||
373 		    strcasecmp(value, "off") == 0 ||
374 		    strcasecmp(value, "no") == 0)
375 			flag = 0;
376 		else {
377 			ctx->error(ctx, "bad value: %s", value);
378 			return (NULL);
379 		}
380 	}
381 
382 	return (options_set_number(oo, oe->name, flag));
383 }
384 
385 /* Set a choice option. */
386 struct options_entry *
387 cmd_set_option_choice(unused struct cmd *self, struct cmd_ctx *ctx,
388     const struct options_table_entry *oe, struct options *oo, const char *value)
389 {
390 	const char	**choicep;
391 	int		  n, choice = -1;
392 
393 	n = 0;
394 	for (choicep = oe->choices; *choicep != NULL; choicep++) {
395 		n++;
396 		if (strncmp(*choicep, value, strlen(value)) != 0)
397 			continue;
398 
399 		if (choice != -1) {
400 			ctx->error(ctx, "ambiguous value: %s", value);
401 			return (NULL);
402 		}
403 		choice = n - 1;
404 	}
405 	if (choice == -1) {
406 		ctx->error(ctx, "unknown value: %s", value);
407 		return (NULL);
408 	}
409 
410 	return (options_set_number(oo, oe->name, choice));
411 }
412