builtins/shopt.def

   1 This file is shopt.def, from which is created shopt.c.
   2 It implements the Bash `shopt' builtin.
   3
   4 Copyright (C) 1994-2003 Free Software Foundation, Inc.
   5
   6 This file is part of GNU Bash, the Bourne Again SHell.
   7
   8 Bash is free software; you can redistribute it and/or modify it under
   9 the terms of the GNU General Public License as published by the Free
  10 Software Foundation; either version 2, or (at your option) any later
  11 version.
  12
  13 Bash is distributed in the hope that it will be useful, but WITHOUT ANY
  14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16 for more details.
  17
  18 You should have received a copy of the GNU General Public License along
  19 with Bash; see the file COPYING.  If not, write to the Free Software
  20 Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA.
  21
  22 $PRODUCES shopt.c
  23
  24 $BUILTIN shopt
  25 $FUNCTION shopt_builtin
  26 $SHORT_DOC shopt [-pqsu] [-o long-option] optname [optname...]
  27 Toggle the values of variables controlling optional behavior.
  28 The -s flag means to enable (set) each OPTNAME; the -u flag
  29 unsets each OPTNAME.  The -q flag suppresses output; the exit
  30 status indicates whether each OPTNAME is set or unset.  The -o
  31 option restricts the OPTNAMEs to those defined for use with
  32 `set -o'.  With no options, or with the -p option, a list of all
  33 settable options is displayed, with an indication of whether or
  34 not each is set.
  35 $END
  36
  37 #include <config.h>
  38
  39 #if defined (HAVE_UNISTD_H)
  40 #  ifdef _MINIX
  41 #    include <sys/types.h>
  42 #  endif
  43 #  include <unistd.h>
  44 #endif
  45
  46 #include <stdio.h>
  47
  48 #include "../bashintl.h"
  49
  50 #include "../shell.h"
  51 #include "../flags.h"
  52 #include "common.h"
  53 #include "bashgetopt.h"
  54
  55 #define UNSETOPT        0
  56 #define SETOPT          1
  57
  58 #define OPTFMT          "%-15s\t%s\n"
  59
  60 extern int allow_null_glob_expansion, fail_glob_expansion, glob_dot_filenames;
  61 extern int cdable_vars, mail_warning, source_uses_path;
  62 extern int no_exit_on_failed_exec, print_shift_error;
  63 extern int check_hashed_filenames, promptvars;
  64 extern int cdspelling, expand_aliases;
  65 extern int extended_quote;
  66 extern int check_window_size;
  67 extern int glob_ignore_case;
  68 extern int hup_on_exit;
  69 extern int xpg_echo;
  70 extern int gnu_error_format;
  71
  72 #if defined (EXTENDED_GLOB)
  73 extern int extended_glob;
  74 #endif
  75
  76 #if defined (HISTORY)
  77 extern int literal_history, command_oriented_history;
  78 extern int force_append_history;
  79 #endif
  80
  81 #if defined (READLINE)
  82 extern int hist_verify, history_reediting, perform_hostname_completion;
  83 extern int no_empty_command_completion;
  84 extern int force_fignore;
  85 extern int enable_hostname_completion __P((int));
  86 #endif
  87
  88 #if defined (PROGRAMMABLE_COMPLETION)
  89 extern int prog_completion_enabled;
  90 #endif
  91
  92 #if defined (RESTRICTED_SHELL)
  93 extern char *shell_name;
  94 #endif
  95
  96 #if defined (DEBUGGER)
  97 extern int debugging_mode;
  98 #endif
  99
 100 static void shopt_error __P((char *));
 101
 102 static int set_shellopts_after_change __P((int));
 103
 104 #if defined (RESTRICTED_SHELL)
 105 static int set_restricted_shell __P((int));
 106 #endif
 107
 108 static int shopt_login_shell;
 109
 110 typedef int shopt_set_func_t __P((int));
 111
 112 static struct {
 113   char *name;
 114   int  *value;
 115   shopt_set_func_t *set_func;
 116 } shopt_vars[] = {
 117   { "cdable_vars", &cdable_vars, (shopt_set_func_t *)NULL },
 118   { "cdspell", &cdspelling, (shopt_set_func_t *)NULL },
 119   { "checkhash", &check_hashed_filenames, (shopt_set_func_t *)NULL },
 120   { "checkwinsize", &check_window_size, (shopt_set_func_t *)NULL },
 121 #if defined (HISTORY)
 122   { "cmdhist", &command_oriented_history, (shopt_set_func_t *)NULL },
 123 #endif
 124   { "dotglob", &glob_dot_filenames, (shopt_set_func_t *)NULL },
 125   { "execfail", &no_exit_on_failed_exec, (shopt_set_func_t *)NULL },
 126   { "expand_aliases", &expand_aliases, (shopt_set_func_t *)NULL },
 127 #if defined (DEBUGGER)
 128   { "extdebug", &debugging_mode, (shopt_set_func_t *)NULL },
 129 #endif
 130 #if defined (EXTENDED_GLOB)
 131   { "extglob", &extended_glob, (shopt_set_func_t *)NULL },
 132 #endif
 133   { "extquote", &extended_quote, (shopt_set_func_t *)NULL },
 134   { "failglob", &fail_glob_expansion, (shopt_set_func_t *)NULL },
 135 #if defined (READLINE)
 136   { "force_fignore", &force_fignore, (shopt_set_func_t *)NULL },
 137   { "gnu_errfmt", &gnu_error_format, (shopt_set_func_t *)NULL },
 138   { "histreedit", &history_reediting, (shopt_set_func_t *)NULL },
 139 #endif
 140 #if defined (HISTORY)
 141   { "histappend", &force_append_history, (shopt_set_func_t *)NULL },
 142 #endif
 143 #if defined (READLINE)
 144   { "histverify", &hist_verify, (shopt_set_func_t *)NULL },
 145   { "hostcomplete", &perform_hostname_completion, enable_hostname_completion },
 146 #endif
 147   { "huponexit", &hup_on_exit, (shopt_set_func_t *)NULL },
 148   { "interactive_comments", &interactive_comments, set_shellopts_after_change },
 149 #if defined (HISTORY)
 150   { "lithist", &literal_history, (shopt_set_func_t *)NULL },
 151 #endif
 152   { "login_shell", &shopt_login_shell, set_login_shell },
 153   { "mailwarn", &mail_warning, (shopt_set_func_t *)NULL },
 154 #if defined (READLINE)
 155   { "no_empty_cmd_completion", &no_empty_command_completion, (shopt_set_func_t *)NULL },
 156 #endif
 157   { "nocaseglob", &glob_ignore_case, (shopt_set_func_t *)NULL },
 158   { "nullglob", &allow_null_glob_expansion, (shopt_set_func_t *)NULL },
 159 #if defined (PROGRAMMABLE_COMPLETION)
 160   { "progcomp", &prog_completion_enabled, (shopt_set_func_t *)NULL },
 161 #endif
 162   { "promptvars", &promptvars, (shopt_set_func_t *)NULL },
 163 #if defined (RESTRICTED_SHELL)
 164   { "restricted_shell", &restricted_shell, set_restricted_shell },
 165 #endif
 166   { "shift_verbose", &print_shift_error, (shopt_set_func_t *)NULL },
 167   { "sourcepath", &source_uses_path, (shopt_set_func_t *)NULL },
 168   { "xpg_echo", &xpg_echo, (shopt_set_func_t *)NULL },
 169   { (char *)0, (int *)0, (shopt_set_func_t *)NULL }
 170 };
 171
 172 static char *on = "on";
 173 static char *off = "off";
 174
 175 static int find_shopt __P((char *));
 176 static int toggle_shopts __P((int, WORD_LIST *, int));
 177 static void print_shopt __P((char *, int, int));
 178 static int list_shopts __P((WORD_LIST *, int));
 179 static int list_some_shopts __P((int, int));
 180 static int list_shopt_o_options __P((WORD_LIST *, int));
 181 static int list_some_o_options __P((int, int));
 182 static int set_shopt_o_options __P((int, WORD_LIST *, int));
 183
 184 #define SFLAG   0x01
 185 #define UFLAG   0x02
 186 #define QFLAG   0x04
 187 #define OFLAG   0x08
 188 #define PFLAG   0x10
 189
 190 int
 191 shopt_builtin (list)
 192      WORD_LIST *list;
 193 {
 194   int opt, flags, rval;
 195
 196   flags = 0;
 197   reset_internal_getopt ();
 198   while ((opt = internal_getopt (list, "psuoq")) != -1)
 199     {
 200       switch (opt)
 201         {
 202         case 's':
 203           flags |= SFLAG;
 204           break;
 205         case 'u':
 206           flags |= UFLAG;
 207           break;
 208         case 'q':
 209           flags |= QFLAG;
 210           break;
 211         case 'o':
 212           flags |= OFLAG;
 213           break;
 214         case 'p':
 215           flags |= PFLAG;
 216           break;
 217         default:
 218           builtin_usage ();
 219           return (EX_USAGE);
 220         }
 221     }
 222   list = loptend;
 223
 224   if ((flags & (SFLAG|UFLAG)) == (SFLAG|UFLAG))
 225     {
 226       builtin_error (_("cannot set and unset shell options simultaneously"));
 227       return (EXECUTION_FAILURE);
 228     }
 229
 230   rval = EXECUTION_SUCCESS;
 231   if ((flags & OFLAG) && ((flags & (SFLAG|UFLAG)) == 0))        /* shopt -o */
 232     rval = list_shopt_o_options (list, flags);
 233   else if (list && (flags & OFLAG))             /* shopt -so args */
 234     rval = set_shopt_o_options ((flags & SFLAG) ? FLAG_ON : FLAG_OFF, list, flags & QFLAG);
 235   else if (flags & OFLAG)       /* shopt -so */
 236     rval = list_some_o_options ((flags & SFLAG) ? 1 : 0, flags);
 237   else if (list && (flags & (SFLAG|UFLAG)))     /* shopt -su args */
 238     rval = toggle_shopts ((flags & SFLAG) ? SETOPT : UNSETOPT, list, flags & QFLAG);
 239   else if ((flags & (SFLAG|UFLAG)) == 0)        /* shopt [args] */
 240     rval = list_shopts (list, flags);
 241   else                                          /* shopt -su */
 242     rval = list_some_shopts ((flags & SFLAG) ? SETOPT : UNSETOPT, flags);
 243   return (rval);
 244 }
 245
 246 /* Reset the options managed by `shopt' to the values they would have at
 247    shell startup. */
 248 void
 249 reset_shopt_options ()
 250 {
 251   allow_null_glob_expansion = glob_dot_filenames = 0;
 252   cdable_vars = mail_warning = 0;
 253   no_exit_on_failed_exec = print_shift_error = 0;
 254   check_hashed_filenames = cdspelling = expand_aliases = check_window_size = 0;
 255
 256   source_uses_path = promptvars = 1;
 257
 258 #if defined (EXTENDED_GLOB)
 259   extended_glob = 0;
 260 #endif
 261
 262 #if defined (HISTORY)
 263   literal_history = force_append_history = 0;
 264   command_oriented_history = 1;
 265 #endif
 266
 267 #if defined (READLINE)
 268   hist_verify = history_reediting = 0;
 269   perform_hostname_completion = 1;
 270 #endif
 271
 272   shopt_login_shell = login_shell;
 273 }
 274
 275 static int
 276 find_shopt (name)
 277      char *name;
 278 {
 279   int i;
 280
 281   for (i = 0; shopt_vars[i].name; i++)
 282     if (STREQ (name, shopt_vars[i].name))
 283       return i;
 284   return -1;
 285 }
 286
 287 static void
 288 shopt_error (s)
 289      char *s;
 290 {
 291   builtin_error (_("%s: invalid shell option name"), s);
 292 }
 293
 294 static int
 295 toggle_shopts (mode, list, quiet)
 296      int mode;
 297      WORD_LIST *list;
 298      int quiet;
 299 {
 300   WORD_LIST *l;
 301   int ind, rval;
 302
 303   for (l = list, rval = EXECUTION_SUCCESS; l; l = l->next)
 304     {
 305       ind = find_shopt (l->word->word);
 306       if (ind < 0)
 307         {
 308           shopt_error (l->word->word);
 309           rval = EXECUTION_FAILURE;
 310         }
 311       else
 312         {
 313           *shopt_vars[ind].value = mode;        /* 1 for set, 0 for unset */
 314           if (shopt_vars[ind].set_func)
 315             (*shopt_vars[ind].set_func) (mode);
 316         }
 317     }
 318   return (rval);
 319 }
 320
 321 static void
 322 print_shopt (name, val, flags)
 323      char *name;
 324      int val, flags;
 325 {
 326   if (flags & PFLAG)
 327     printf ("shopt %s %s\n", val ? "-s" : "-u", name);
 328   else
 329     printf (OPTFMT, name, val ? on : off);
 330 }
 331
 332 /* List the values of all or any of the `shopt' options.  Returns 0 if
 333    all were listed or all variables queried were on; 1 otherwise. */
 334 static int
 335 list_shopts (list, flags)
 336      WORD_LIST *list;
 337      int flags;
 338 {
 339   WORD_LIST *l;
 340   int i, val, rval;
 341
 342   if (list == 0)
 343     {
 344       for (i = 0; shopt_vars[i].name; i++)
 345         {
 346           val = *shopt_vars[i].value;
 347           if ((flags & QFLAG) == 0)
 348             print_shopt (shopt_vars[i].name, val, flags);
 349         }
 350       return (EXECUTION_SUCCESS);
 351     }
 352
 353   for (l = list, rval = EXECUTION_SUCCESS; l; l = l->next)
 354     {
 355       i = find_shopt (l->word->word);
 356       if (i < 0)
 357         {
 358           shopt_error (l->word->word);
 359           rval = EXECUTION_FAILURE;
 360           continue;
 361         }
 362       val = *shopt_vars[i].value;
 363       if (val == 0)
 364         rval = EXECUTION_FAILURE;
 365       if ((flags & QFLAG) == 0)
 366         print_shopt (l->word->word, val, flags);
 367     }
 368
 369   return (rval);
 370 }
 371
 372 static int
 373 list_some_shopts (mode, flags)
 374      int mode, flags;
 375 {
 376   int val, i;
 377
 378   for (i = 0; shopt_vars[i].name; i++)
 379     {
 380       val = *shopt_vars[i].value;
 381       if (((flags & QFLAG) == 0) && mode == val)
 382         print_shopt (shopt_vars[i].name, val, flags);
 383     }
 384   return (EXECUTION_SUCCESS);
 385 }
 386
 387 static int
 388 list_shopt_o_options (list, flags)
 389      WORD_LIST *list;
 390      int flags;
 391 {
 392   WORD_LIST *l;
 393   int val, rval;
 394
 395   if (list == 0)
 396     {
 397       if ((flags & QFLAG) == 0)
 398         list_minus_o_opts (-1, (flags & PFLAG));
 399       return (EXECUTION_SUCCESS);
 400     }
 401
 402   for (l = list, rval = EXECUTION_SUCCESS; l; l = l->next)
 403     {
 404       val = minus_o_option_value (l->word->word);
 405       if (val == -1)
 406         {
 407           sh_invalidoptname (l->word->word);
 408           rval = EXECUTION_FAILURE;
 409           continue;
 410         }
 411       if (val == 0)
 412         rval = EXECUTION_FAILURE;
 413       if ((flags & QFLAG) == 0)
 414         {
 415           if (flags & PFLAG)
 416             printf ("set %co %s\n", val ? '-' : '+', l->word->word);
 417           else
 418             printf (OPTFMT, l->word->word, val ? on : off);
 419         }
 420     }
 421   return (rval);
 422 }
 423
 424 static int
 425 list_some_o_options (mode, flags)
 426      int mode, flags;
 427 {
 428   if ((flags & QFLAG) == 0)
 429     list_minus_o_opts (mode, (flags & PFLAG));
 430   return (EXECUTION_SUCCESS);
 431 }
 432
 433 static int
 434 set_shopt_o_options (mode, list, quiet)
 435      int mode;
 436      WORD_LIST *list;
 437      int quiet;
 438 {
 439   WORD_LIST *l;
 440   int rval;
 441
 442   for (l = list, rval = EXECUTION_SUCCESS; l; l = l->next)
 443     {
 444       if (set_minus_o_option (mode, l->word->word) == EXECUTION_FAILURE)
 445         rval = EXECUTION_FAILURE;
 446     }
 447   set_shellopts ();
 448   return rval;
 449 }
 450
 451 /* If we set or unset interactive_comments with shopt, make sure the
 452    change is reflected in $SHELLOPTS. */
 453 static int
 454 set_shellopts_after_change (mode)
 455      int mode;
 456 {
 457   set_shellopts ();
 458   return (0);
 459 }
 460
 461 #if defined (RESTRICTED_SHELL)
 462 /* Don't allow the value of restricted_shell to be modified. */
 463
 464 static int
 465 set_restricted_shell (mode)
 466      int mode;
 467 {
 468   static int save_restricted = -1;
 469
 470   if (save_restricted == -1)
 471     save_restricted = shell_is_restricted (shell_name);
 472
 473   restricted_shell = save_restricted;
 474   return (0);
 475 }
 476 #endif /* RESTRICTED_SHELL */
 477
 478 /* Not static so shell.c can call it to initialize shopt_login_shell */
 479 int
 480 set_login_shell (mode)
 481      int mode;
 482 {
 483   shopt_login_shell = login_shell != 0;
 484   return (0);
 485 }
 486
 487 char **
 488 get_shopt_options ()
 489 {
 490   char **ret;
 491   int n, i;
 492
 493   n = sizeof (shopt_vars) / sizeof (shopt_vars[0]);
 494   ret = strvec_create (n + 1);
 495   for (i = 0; shopt_vars[i].name; i++)
 496     ret[i] = savestring (shopt_vars[i].name);
 497   ret[i] = (char *)NULL;
 498   return ret;
 499 }
 500
 501 /*
 502  * External interface for other parts of the shell.  NAME is a string option;
 503  * MODE is 0 if we want to unset an option; 1 if we want to set an option.
 504  * REUSABLE is 1 if we want to print output in a form that may be reused.
 505  */
 506 int
 507 shopt_setopt (name, mode)
 508      char *name;
 509      int mode;
 510 {
 511   WORD_LIST *wl;
 512   int r;
 513
 514   wl = add_string_to_list (name, (WORD_LIST *)NULL);
 515   r = toggle_shopts (mode, wl, 0);
 516   dispose_words (wl);
 517   return r;
 518 }
 519
 520 int
 521 shopt_listopt (name, reusable)
 522      char *name;
 523      int reusable;
 524 {
 525   int i;
 526
 527   if (name == 0)
 528     return (list_shopts ((WORD_LIST *)NULL, reusable ? PFLAG : 0));
 529
 530   i = find_shopt (name);
 531   if (i < 0)
 532     {
 533       shopt_error (name);
 534       return (EXECUTION_FAILURE);
 535     }
 536
 537   print_shopt (name, *shopt_vars[i].value, reusable ? PFLAG : 0);
 538   return (EXECUTION_SUCCESS);
 539 }