1 /* $OpenBSD: cmd-set-option.c,v 1.38 2010/09/01 21:06:51 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 const char *cmd_set_option_print( 33 const struct set_option_entry *, struct options_entry *); 34 void cmd_set_option_string(struct cmd_ctx *, 35 struct options *, const struct set_option_entry *, char *, int); 36 void cmd_set_option_number(struct cmd_ctx *, 37 struct options *, const struct set_option_entry *, char *); 38 void cmd_set_option_keys(struct cmd_ctx *, 39 struct options *, const struct set_option_entry *, char *); 40 void cmd_set_option_colour(struct cmd_ctx *, 41 struct options *, const struct set_option_entry *, char *); 42 void cmd_set_option_attributes(struct cmd_ctx *, 43 struct options *, const struct set_option_entry *, char *); 44 void cmd_set_option_flag(struct cmd_ctx *, 45 struct options *, const struct set_option_entry *, char *); 46 void cmd_set_option_choice(struct cmd_ctx *, 47 struct options *, const struct set_option_entry *, char *); 48 49 const struct cmd_entry cmd_set_option_entry = { 50 "set-option", "set", 51 "[-agsuw] [-t target-session|target-window] option [value]", 52 CMD_ARG12, "agsuw", 53 NULL, 54 cmd_target_parse, 55 cmd_set_option_exec, 56 cmd_target_free, 57 cmd_target_print 58 }; 59 60 const char *set_option_mode_keys_list[] = { 61 "emacs", "vi", NULL 62 }; 63 const char *set_option_clock_mode_style_list[] = { 64 "12", "24", NULL 65 }; 66 const char *set_option_status_keys_list[] = { 67 "emacs", "vi", NULL 68 }; 69 const char *set_option_status_justify_list[] = { 70 "left", "centre", "right", NULL 71 }; 72 const char *set_option_bell_action_list[] = { 73 "none", "any", "current", NULL 74 }; 75 76 const struct set_option_entry set_option_table[] = { 77 { "escape-time", SET_OPTION_NUMBER, 0, INT_MAX, NULL }, 78 { "quiet", SET_OPTION_FLAG, 0, 0, NULL }, 79 { NULL, 0, 0, 0, NULL } 80 }; 81 82 const struct set_option_entry set_session_option_table[] = { 83 { "base-index", SET_OPTION_NUMBER, 0, INT_MAX, NULL }, 84 { "bell-action", SET_OPTION_CHOICE, 0, 0, set_option_bell_action_list }, 85 { "buffer-limit", SET_OPTION_NUMBER, 1, INT_MAX, NULL }, 86 { "default-command", SET_OPTION_STRING, 0, 0, NULL }, 87 { "default-path", SET_OPTION_STRING, 0, 0, NULL }, 88 { "default-shell", SET_OPTION_STRING, 0, 0, NULL }, 89 { "default-terminal", SET_OPTION_STRING, 0, 0, NULL }, 90 { "detach-on-destroy", SET_OPTION_FLAG, 0, 0, NULL }, 91 { "display-panes-colour", SET_OPTION_COLOUR, 0, 0, NULL }, 92 { "display-panes-active-colour", SET_OPTION_COLOUR, 0, 0, NULL }, 93 { "display-panes-time", SET_OPTION_NUMBER, 1, INT_MAX, NULL }, 94 { "display-time", SET_OPTION_NUMBER, 1, INT_MAX, NULL }, 95 { "history-limit", SET_OPTION_NUMBER, 0, INT_MAX, NULL }, 96 { "lock-after-time", SET_OPTION_NUMBER, 0, INT_MAX, NULL }, 97 { "lock-command", SET_OPTION_STRING, 0, 0, NULL }, 98 { "lock-server", SET_OPTION_FLAG, 0, 0, NULL }, 99 { "message-attr", SET_OPTION_ATTRIBUTES, 0, 0, NULL }, 100 { "message-bg", SET_OPTION_COLOUR, 0, 0, NULL }, 101 { "message-fg", SET_OPTION_COLOUR, 0, 0, NULL }, 102 { "message-limit", SET_OPTION_NUMBER, 0, INT_MAX, NULL }, 103 { "mouse-select-pane", SET_OPTION_FLAG, 0, 0, NULL }, 104 { "pane-active-border-bg", SET_OPTION_COLOUR, 0, 0, NULL }, 105 { "pane-active-border-fg", SET_OPTION_COLOUR, 0, 0, NULL }, 106 { "pane-border-bg", SET_OPTION_COLOUR, 0, 0, NULL }, 107 { "pane-border-fg", SET_OPTION_COLOUR, 0, 0, NULL }, 108 { "prefix", SET_OPTION_KEYS, 0, 0, NULL }, 109 { "repeat-time", SET_OPTION_NUMBER, 0, SHRT_MAX, NULL }, 110 { "set-remain-on-exit", SET_OPTION_FLAG, 0, 0, NULL }, 111 { "set-titles", SET_OPTION_FLAG, 0, 0, NULL }, 112 { "set-titles-string", SET_OPTION_STRING, 0, 0, NULL }, 113 { "status", SET_OPTION_FLAG, 0, 0, NULL }, 114 { "status-attr", SET_OPTION_ATTRIBUTES, 0, 0, NULL }, 115 { "status-bg", SET_OPTION_COLOUR, 0, 0, NULL }, 116 { "status-fg", SET_OPTION_COLOUR, 0, 0, NULL }, 117 { "status-interval", SET_OPTION_NUMBER, 0, INT_MAX, NULL }, 118 { "status-justify", 119 SET_OPTION_CHOICE, 0, 0, set_option_status_justify_list }, 120 { "status-keys", SET_OPTION_CHOICE, 0, 0, set_option_status_keys_list }, 121 { "status-left", SET_OPTION_STRING, 0, 0, NULL }, 122 { "status-left-attr", SET_OPTION_ATTRIBUTES, 0, 0, NULL }, 123 { "status-left-bg", SET_OPTION_COLOUR, 0, 0, NULL }, 124 { "status-left-fg", SET_OPTION_COLOUR, 0, 0, NULL }, 125 { "status-left-length", SET_OPTION_NUMBER, 0, SHRT_MAX, NULL }, 126 { "status-right", SET_OPTION_STRING, 0, 0, NULL }, 127 { "status-right-attr", SET_OPTION_ATTRIBUTES, 0, 0, NULL }, 128 { "status-right-bg", SET_OPTION_COLOUR, 0, 0, NULL }, 129 { "status-right-fg", SET_OPTION_COLOUR, 0, 0, NULL }, 130 { "status-right-length", SET_OPTION_NUMBER, 0, SHRT_MAX, NULL }, 131 { "status-utf8", SET_OPTION_FLAG, 0, 0, NULL }, 132 { "terminal-overrides", SET_OPTION_STRING, 0, 0, NULL }, 133 { "update-environment", SET_OPTION_STRING, 0, 0, NULL }, 134 { "visual-activity", SET_OPTION_FLAG, 0, 0, NULL }, 135 { "visual-bell", SET_OPTION_FLAG, 0, 0, NULL }, 136 { "visual-content", SET_OPTION_FLAG, 0, 0, NULL }, 137 { NULL, 0, 0, 0, NULL } 138 }; 139 140 const struct set_option_entry set_window_option_table[] = { 141 { "aggressive-resize", SET_OPTION_FLAG, 0, 0, NULL }, 142 { "alternate-screen", SET_OPTION_FLAG, 0, 0, NULL }, 143 { "automatic-rename", SET_OPTION_FLAG, 0, 0, NULL }, 144 { "clock-mode-colour", SET_OPTION_COLOUR, 0, 0, NULL }, 145 { "clock-mode-style", 146 SET_OPTION_CHOICE, 0, 0, set_option_clock_mode_style_list }, 147 { "force-height", SET_OPTION_NUMBER, 0, INT_MAX, NULL }, 148 { "force-width", SET_OPTION_NUMBER, 0, INT_MAX, NULL }, 149 { "main-pane-height", SET_OPTION_NUMBER, 1, INT_MAX, NULL }, 150 { "main-pane-width", SET_OPTION_NUMBER, 1, INT_MAX, NULL }, 151 { "mode-attr", SET_OPTION_ATTRIBUTES, 0, 0, NULL }, 152 { "mode-bg", SET_OPTION_COLOUR, 0, 0, NULL }, 153 { "mode-fg", SET_OPTION_COLOUR, 0, 0, NULL }, 154 { "mode-keys", SET_OPTION_CHOICE, 0, 0, set_option_mode_keys_list }, 155 { "mode-mouse", SET_OPTION_FLAG, 0, 0, NULL }, 156 { "monitor-activity", SET_OPTION_FLAG, 0, 0, NULL }, 157 { "monitor-content", SET_OPTION_STRING, 0, 0, NULL }, 158 { "remain-on-exit", SET_OPTION_FLAG, 0, 0, NULL }, 159 { "synchronize-panes", SET_OPTION_FLAG, 0, 0, NULL }, 160 { "utf8", SET_OPTION_FLAG, 0, 0, NULL }, 161 { "window-status-alert-attr", SET_OPTION_ATTRIBUTES, 0, 0, NULL }, 162 { "window-status-alert-bg", SET_OPTION_COLOUR, 0, 0, NULL }, 163 { "window-status-alert-fg", SET_OPTION_COLOUR, 0, 0, NULL }, 164 { "window-status-attr", SET_OPTION_ATTRIBUTES, 0, 0, NULL }, 165 { "window-status-bg", SET_OPTION_COLOUR, 0, 0, NULL }, 166 { "window-status-current-attr", SET_OPTION_ATTRIBUTES, 0, 0, NULL }, 167 { "window-status-current-bg", SET_OPTION_COLOUR, 0, 0, NULL }, 168 { "window-status-current-fg", SET_OPTION_COLOUR, 0, 0, NULL }, 169 { "window-status-current-format", SET_OPTION_STRING, 0, 0, NULL }, 170 { "window-status-fg", SET_OPTION_COLOUR, 0, 0, NULL }, 171 { "window-status-format", SET_OPTION_STRING, 0, 0, NULL }, 172 { "word-separators", SET_OPTION_STRING, 0, 0, NULL }, 173 { "xterm-keys", SET_OPTION_FLAG, 0, 0, NULL }, 174 { NULL, 0, 0, 0, NULL } 175 }; 176 177 int 178 cmd_set_option_exec(struct cmd *self, struct cmd_ctx *ctx) 179 { 180 struct cmd_target_data *data = self->data; 181 const struct set_option_entry *table; 182 struct session *s; 183 struct winlink *wl; 184 struct client *c; 185 struct options *oo; 186 const struct set_option_entry *entry, *opt; 187 struct jobs *jobs; 188 struct job *job, *nextjob; 189 u_int i; 190 int try_again; 191 192 if (cmd_check_flag(data->chflags, 's')) { 193 oo = &global_options; 194 table = set_option_table; 195 } else if (cmd_check_flag(data->chflags, 'w')) { 196 table = set_window_option_table; 197 if (cmd_check_flag(data->chflags, 'g')) 198 oo = &global_w_options; 199 else { 200 wl = cmd_find_window(ctx, data->target, NULL); 201 if (wl == NULL) 202 return (-1); 203 oo = &wl->window->options; 204 } 205 } else { 206 table = set_session_option_table; 207 if (cmd_check_flag(data->chflags, 'g')) 208 oo = &global_s_options; 209 else { 210 s = cmd_find_session(ctx, data->target); 211 if (s == NULL) 212 return (-1); 213 oo = &s->options; 214 } 215 } 216 217 if (*data->arg == '\0') { 218 ctx->error(ctx, "invalid option"); 219 return (-1); 220 } 221 222 entry = NULL; 223 for (opt = table; opt->name != NULL; opt++) { 224 if (strncmp(opt->name, data->arg, strlen(data->arg)) != 0) 225 continue; 226 if (entry != NULL) { 227 ctx->error(ctx, "ambiguous option: %s", data->arg); 228 return (-1); 229 } 230 entry = opt; 231 232 /* Bail now if an exact match. */ 233 if (strcmp(entry->name, data->arg) == 0) 234 break; 235 } 236 if (entry == NULL) { 237 ctx->error(ctx, "unknown option: %s", data->arg); 238 return (-1); 239 } 240 241 if (cmd_check_flag(data->chflags, 'u')) { 242 if (cmd_check_flag(data->chflags, 'g')) { 243 ctx->error(ctx, 244 "can't unset global option: %s", entry->name); 245 return (-1); 246 } 247 if (data->arg2 != NULL) { 248 ctx->error(ctx, 249 "value passed to unset option: %s", entry->name); 250 return (-1); 251 } 252 253 options_remove(oo, entry->name); 254 ctx->info(ctx, "unset option: %s", entry->name); 255 } else { 256 switch (entry->type) { 257 case SET_OPTION_STRING: 258 cmd_set_option_string(ctx, oo, entry, 259 data->arg2, cmd_check_flag(data->chflags, 'a')); 260 break; 261 case SET_OPTION_NUMBER: 262 cmd_set_option_number(ctx, oo, entry, data->arg2); 263 break; 264 case SET_OPTION_KEYS: 265 cmd_set_option_keys(ctx, oo, entry, data->arg2); 266 break; 267 case SET_OPTION_COLOUR: 268 cmd_set_option_colour(ctx, oo, entry, data->arg2); 269 break; 270 case SET_OPTION_ATTRIBUTES: 271 cmd_set_option_attributes(ctx, oo, entry, data->arg2); 272 break; 273 case SET_OPTION_FLAG: 274 cmd_set_option_flag(ctx, oo, entry, data->arg2); 275 break; 276 case SET_OPTION_CHOICE: 277 cmd_set_option_choice(ctx, oo, entry, data->arg2); 278 break; 279 } 280 } 281 282 recalculate_sizes(); 283 for (i = 0; i < ARRAY_LENGTH(&clients); i++) { 284 c = ARRAY_ITEM(&clients, i); 285 if (c != NULL && c->session != NULL) 286 server_redraw_client(c); 287 } 288 289 /* 290 * Special-case: kill all persistent jobs if status-left, status-right 291 * or set-titles-string have changed. Persistent jobs are only used by 292 * the status line at the moment so this works XXX. 293 */ 294 if (strcmp(entry->name, "status-left") == 0 || 295 strcmp(entry->name, "status-right") == 0 || 296 strcmp(entry->name, "status") == 0 || 297 strcmp(entry->name, "set-titles-string") == 0 || 298 strcmp(entry->name, "window-status-format") == 0) { 299 for (i = 0; i < ARRAY_LENGTH(&clients); i++) { 300 c = ARRAY_ITEM(&clients, i); 301 if (c == NULL || c->session == NULL) 302 continue; 303 304 jobs = &c->status_jobs; 305 do { 306 try_again = 0; 307 job = RB_ROOT(jobs); 308 while (job != NULL) { 309 nextjob = RB_NEXT(jobs, jobs, job); 310 if (job->flags & JOB_PERSIST) { 311 job_remove(jobs, job); 312 try_again = 1; 313 break; 314 } 315 job = nextjob; 316 } 317 } while (try_again); 318 server_redraw_client(c); 319 } 320 } 321 322 return (0); 323 } 324 325 const char * 326 cmd_set_option_print( 327 const struct set_option_entry *entry, struct options_entry *o) 328 { 329 static char out[BUFSIZ]; 330 const char *s; 331 struct keylist *keylist; 332 u_int i; 333 334 *out = '\0'; 335 switch (entry->type) { 336 case SET_OPTION_STRING: 337 xsnprintf(out, sizeof out, "\"%s\"", o->str); 338 break; 339 case SET_OPTION_NUMBER: 340 xsnprintf(out, sizeof out, "%lld", o->num); 341 break; 342 case SET_OPTION_KEYS: 343 keylist = o->data; 344 for (i = 0; i < ARRAY_LENGTH(keylist); i++) { 345 strlcat(out, key_string_lookup_key( 346 ARRAY_ITEM(keylist, i)), sizeof out); 347 if (i != ARRAY_LENGTH(keylist) - 1) 348 strlcat(out, ",", sizeof out); 349 } 350 break; 351 case SET_OPTION_COLOUR: 352 s = colour_tostring(o->num); 353 xsnprintf(out, sizeof out, "%s", s); 354 break; 355 case SET_OPTION_ATTRIBUTES: 356 s = attributes_tostring(o->num); 357 xsnprintf(out, sizeof out, "%s", s); 358 break; 359 case SET_OPTION_FLAG: 360 if (o->num) 361 strlcpy(out, "on", sizeof out); 362 else 363 strlcpy(out, "off", sizeof out); 364 break; 365 case SET_OPTION_CHOICE: 366 s = entry->choices[o->num]; 367 xsnprintf(out, sizeof out, "%s", s); 368 break; 369 } 370 return (out); 371 } 372 373 void 374 cmd_set_option_string(struct cmd_ctx *ctx, struct options *oo, 375 const struct set_option_entry *entry, char *value, int append) 376 { 377 struct options_entry *o; 378 char *oldvalue, *newvalue; 379 380 if (value == NULL) { 381 ctx->error(ctx, "empty value"); 382 return; 383 } 384 385 if (append) { 386 oldvalue = options_get_string(oo, entry->name); 387 xasprintf(&newvalue, "%s%s", oldvalue, value); 388 } else 389 newvalue = value; 390 391 o = options_set_string(oo, entry->name, "%s", newvalue); 392 ctx->info(ctx, 393 "set option: %s -> %s", o->name, cmd_set_option_print(entry, o)); 394 395 if (newvalue != value) 396 xfree(newvalue); 397 } 398 399 void 400 cmd_set_option_number(struct cmd_ctx *ctx, struct options *oo, 401 const struct set_option_entry *entry, char *value) 402 { 403 struct options_entry *o; 404 long long number; 405 const char *errstr; 406 407 if (value == NULL) { 408 ctx->error(ctx, "empty value"); 409 return; 410 } 411 412 number = strtonum(value, entry->minimum, entry->maximum, &errstr); 413 if (errstr != NULL) { 414 ctx->error(ctx, "value is %s: %s", errstr, value); 415 return; 416 } 417 418 o = options_set_number(oo, entry->name, number); 419 ctx->info(ctx, 420 "set option: %s -> %s", o->name, cmd_set_option_print(entry, o)); 421 } 422 423 void 424 cmd_set_option_keys(struct cmd_ctx *ctx, struct options *oo, 425 const struct set_option_entry *entry, char *value) 426 { 427 struct options_entry *o; 428 struct keylist *keylist; 429 char *copyvalue, *ptr, *str; 430 int key; 431 432 if (value == NULL) { 433 ctx->error(ctx, "empty value"); 434 return; 435 } 436 437 keylist = xmalloc(sizeof *keylist); 438 ARRAY_INIT(keylist); 439 440 ptr = copyvalue = xstrdup(value); 441 while ((str = strsep(&ptr, ",")) != NULL) { 442 if ((key = key_string_lookup_string(str)) == KEYC_NONE) { 443 xfree(keylist); 444 ctx->error(ctx, "unknown key: %s", str); 445 xfree(copyvalue); 446 return; 447 } 448 ARRAY_ADD(keylist, key); 449 } 450 xfree(copyvalue); 451 452 o = options_set_data(oo, entry->name, keylist, xfree); 453 ctx->info(ctx, 454 "set option: %s -> %s", o->name, cmd_set_option_print(entry, o)); 455 } 456 457 void 458 cmd_set_option_colour(struct cmd_ctx *ctx, struct options *oo, 459 const struct set_option_entry *entry, char *value) 460 { 461 struct options_entry *o; 462 int colour; 463 464 if (value == NULL) { 465 ctx->error(ctx, "empty value"); 466 return; 467 } 468 469 if ((colour = colour_fromstring(value)) == -1) { 470 ctx->error(ctx, "bad colour: %s", value); 471 return; 472 } 473 474 o = options_set_number(oo, entry->name, colour); 475 ctx->info(ctx, 476 "set option: %s -> %s", o->name, cmd_set_option_print(entry, o)); 477 } 478 479 void 480 cmd_set_option_attributes(struct cmd_ctx *ctx, struct options *oo, 481 const struct set_option_entry *entry, char *value) 482 { 483 struct options_entry *o; 484 int attr; 485 486 if (value == NULL) { 487 ctx->error(ctx, "empty value"); 488 return; 489 } 490 491 if ((attr = attributes_fromstring(value)) == -1) { 492 ctx->error(ctx, "bad attributes: %s", value); 493 return; 494 } 495 496 o = options_set_number(oo, entry->name, attr); 497 ctx->info(ctx, 498 "set option: %s -> %s", o->name, cmd_set_option_print(entry, o)); 499 } 500 501 void 502 cmd_set_option_flag(struct cmd_ctx *ctx, struct options *oo, 503 const struct set_option_entry *entry, char *value) 504 { 505 struct options_entry *o; 506 int flag; 507 508 if (value == NULL || *value == '\0') 509 flag = !options_get_number(oo, entry->name); 510 else { 511 if ((value[0] == '1' && value[1] == '\0') || 512 strcasecmp(value, "on") == 0 || 513 strcasecmp(value, "yes") == 0) 514 flag = 1; 515 else if ((value[0] == '0' && value[1] == '\0') || 516 strcasecmp(value, "off") == 0 || 517 strcasecmp(value, "no") == 0) 518 flag = 0; 519 else { 520 ctx->error(ctx, "bad value: %s", value); 521 return; 522 } 523 } 524 525 o = options_set_number(oo, entry->name, flag); 526 ctx->info(ctx, 527 "set option: %s -> %s", o->name, cmd_set_option_print(entry, o)); 528 } 529 530 void 531 cmd_set_option_choice(struct cmd_ctx *ctx, struct options *oo, 532 const struct set_option_entry *entry, char *value) 533 { 534 struct options_entry *o; 535 const char **choicep; 536 int n, choice = -1; 537 538 if (value == NULL) { 539 ctx->error(ctx, "empty value"); 540 return; 541 } 542 543 n = 0; 544 for (choicep = entry->choices; *choicep != NULL; choicep++) { 545 n++; 546 if (strncmp(*choicep, value, strlen(value)) != 0) 547 continue; 548 549 if (choice != -1) { 550 ctx->error(ctx, "ambiguous option value: %s", value); 551 return; 552 } 553 choice = n - 1; 554 } 555 if (choice == -1) { 556 ctx->error(ctx, "unknown option value: %s", value); 557 return; 558 } 559 560 o = options_set_number(oo, entry->name, choice); 561 ctx->info(ctx, 562 "set option: %s -> %s", o->name, cmd_set_option_print(entry, o)); 563 } 564