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