cmd-set-option.c

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