arrayfunc.c

   1 /* arrayfunc.c -- High-level array functions used by other parts of the shell. */
   2
   3 /* Copyright (C) 2001-2009 Free Software Foundation, Inc.
   4
   5    This file is part of GNU Bash, the Bourne Again SHell.
   6
   7    Bash is free software: you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation, either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    Bash is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with Bash.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include "config.h"
  22
  23 #if defined (ARRAY_VARS)
  24
  25 #if defined (HAVE_UNISTD_H)
  26 #  include <unistd.h>
  27 #endif
  28 #include <stdio.h>
  29
  30 #include "bashintl.h"
  31
  32 #include "shell.h"
  33 #include "pathexp.h"
  34
  35 #include "shmbutil.h"
  36
  37 #include "builtins/common.h"
  38
  39 extern char *this_command_name;
  40 extern int last_command_exit_value;
  41 extern int array_needs_making;
  42
  43 static SHELL_VAR *bind_array_var_internal __P((SHELL_VAR *, arrayind_t, char *, char *, int));
  44
  45 static char *quote_assign __P((const char *));
  46 static void quote_array_assignment_chars __P((WORD_LIST *));
  47 static char *array_value_internal __P((char *, int, int, int *));
  48
  49 /* Standard error message to use when encountering an invalid array subscript */
  50 const char * const bash_badsub_errmsg = N_("bad array subscript");
  51
  52 /* **************************************************************** */
  53 /*                                                                  */
  54 /*  Functions to manipulate array variables and perform assignments */
  55 /*                                                                  */
  56 /* **************************************************************** */
  57
  58 /* Convert a shell variable to an array variable.  The original value is
  59    saved as array[0]. */
  60 SHELL_VAR *
  61 convert_var_to_array (var)
  62      SHELL_VAR *var;
  63 {
  64   char *oldval;
  65   ARRAY *array;
  66
  67   oldval = value_cell (var);
  68   array = array_create ();
  69   if (oldval)
  70     array_insert (array, 0, oldval);
  71
  72   FREE (value_cell (var));
  73   var_setarray (var, array);
  74
  75   /* these aren't valid anymore */
  76   var->dynamic_value = (sh_var_value_func_t *)NULL;
  77   var->assign_func = (sh_var_assign_func_t *)NULL;
  78
  79   INVALIDATE_EXPORTSTR (var);
  80   if (exported_p (var))
  81     array_needs_making++;
  82
  83   VSETATTR (var, att_array);
  84   VUNSETATTR (var, att_invisible);
  85
  86   return var;
  87 }
  88
  89 /* Convert a shell variable to an array variable.  The original value is
  90    saved as array[0]. */
  91 SHELL_VAR *
  92 convert_var_to_assoc (var)
  93      SHELL_VAR *var;
  94 {
  95   char *oldval;
  96   HASH_TABLE *hash;
  97
  98   oldval = value_cell (var);
  99   hash = assoc_create (0);
 100   if (oldval)
 101     assoc_insert (hash, savestring ("0"), oldval);
 102
 103   FREE (value_cell (var));
 104   var_setassoc (var, hash);
 105
 106   /* these aren't valid anymore */
 107   var->dynamic_value = (sh_var_value_func_t *)NULL;
 108   var->assign_func = (sh_var_assign_func_t *)NULL;
 109
 110   INVALIDATE_EXPORTSTR (var);
 111   if (exported_p (var))
 112     array_needs_making++;
 113
 114   VSETATTR (var, att_assoc);
 115   VUNSETATTR (var, att_invisible);
 116
 117   return var;
 118 }
 119
 120 static SHELL_VAR *
 121 bind_array_var_internal (entry, ind, key, value, flags)
 122      SHELL_VAR *entry;
 123      arrayind_t ind;
 124      char *key;
 125      char *value;
 126      int flags;
 127 {
 128   SHELL_VAR *dentry;
 129   char *newval;
 130
 131   /* If we're appending, we need the old value of the array reference, so
 132      fake out make_variable_value with a dummy SHELL_VAR */
 133   if (flags & ASS_APPEND)
 134     {
 135       dentry = (SHELL_VAR *)xmalloc (sizeof (SHELL_VAR));
 136       dentry->name = savestring (entry->name);
 137       if (assoc_p (entry))
 138         newval = assoc_reference (assoc_cell (entry), key);
 139       else
 140         newval = array_reference (array_cell (entry), ind);
 141       if (newval)
 142         dentry->value = savestring (newval);
 143       else
 144         {
 145           dentry->value = (char *)xmalloc (1);
 146           dentry->value[0] = '\0';
 147         }
 148       dentry->exportstr = 0;
 149       dentry->attributes = entry->attributes & ~(att_array|att_assoc|att_exported);
 150       /* Leave the rest of the members uninitialized; the code doesn't look
 151          at them. */
 152       newval = make_variable_value (dentry, value, flags);
 153       dispose_variable (dentry);
 154     }
 155   else
 156     newval = make_variable_value (entry, value, flags);
 157
 158   if (entry->assign_func)
 159     (*entry->assign_func) (entry, newval, ind, key);
 160   else if (assoc_p (entry))
 161     assoc_insert (assoc_cell (entry), key, newval);
 162   else
 163     array_insert (array_cell (entry), ind, newval);
 164   FREE (newval);
 165
 166   return (entry);
 167 }
 168
 169 /* Perform an array assignment name[ind]=value.  If NAME already exists and
 170    is not an array, and IND is 0, perform name=value instead.  If NAME exists
 171    and is not an array, and IND is not 0, convert it into an array with the
 172    existing value as name[0].
 173
 174    If NAME does not exist, just create an array variable, no matter what
 175    IND's value may be. */
 176 SHELL_VAR *
 177 bind_array_variable (name, ind, value, flags)
 178      char *name;
 179      arrayind_t ind;
 180      char *value;
 181      int flags;
 182 {
 183   SHELL_VAR *entry;
 184
 185   entry = var_lookup (name, shell_variables);
 186
 187   if (entry == (SHELL_VAR *) 0)
 188     entry = make_new_array_variable (name);
 189   else if (readonly_p (entry) || noassign_p (entry))
 190     {
 191       if (readonly_p (entry))
 192         err_readonly (name);
 193       return (entry);
 194     }
 195   else if (array_p (entry) == 0)
 196     entry = convert_var_to_array (entry);
 197
 198   /* ENTRY is an array variable, and ARRAY points to the value. */
 199   return (bind_array_var_internal (entry, ind, 0, value, flags));
 200 }
 201
 202 SHELL_VAR *
 203 bind_array_element (entry, ind, value, flags)
 204      SHELL_VAR *entry;
 205      arrayind_t ind;
 206      char *value;
 207      int flags;
 208 {
 209   return (bind_array_var_internal (entry, ind, 0, value, flags));
 210 }
 211
 212 SHELL_VAR *
 213 bind_assoc_variable (entry, name, key, value, flags)
 214      SHELL_VAR *entry;
 215      char *name;
 216      char *key;
 217      char *value;
 218      int flags;
 219 {
 220   SHELL_VAR *dentry;
 221   char *newval;
 222
 223   if (readonly_p (entry) || noassign_p (entry))
 224     {
 225       if (readonly_p (entry))
 226         err_readonly (name);
 227       return (entry);
 228     }
 229
 230   return (bind_array_var_internal (entry, 0, key, value, flags));
 231 }
 232
 233 /* Parse NAME, a lhs of an assignment statement of the form v[s], and
 234    assign VALUE to that array element by calling bind_array_variable(). */
 235 SHELL_VAR *
 236 assign_array_element (name, value, flags)
 237      char *name, *value;
 238      int flags;
 239 {
 240   char *sub, *vname, *akey;
 241   arrayind_t ind;
 242   int sublen;
 243   SHELL_VAR *entry;
 244
 245   vname = array_variable_name (name, &sub, &sublen);
 246
 247   if (vname == 0)
 248     return ((SHELL_VAR *)NULL);
 249
 250   if ((ALL_ELEMENT_SUB (sub[0]) && sub[1] == ']') || (sublen <= 1))
 251     {
 252       free (vname);
 253       err_badarraysub (name);
 254       return ((SHELL_VAR *)NULL);
 255     }
 256
 257   entry = find_variable (vname);
 258
 259   if (entry && assoc_p (entry))
 260     {
 261       sub[sublen-1] = '\0';
 262       akey = expand_assignment_string_to_string (sub, 0);       /* [ */
 263       sub[sublen-1] = ']';
 264       if (akey == 0 || *akey == 0)
 265         {
 266           free (vname);
 267           err_badarraysub (name);
 268           return ((SHELL_VAR *)NULL);
 269         }
 270       entry = bind_assoc_variable (entry, vname, akey, value, flags);
 271     }
 272   else
 273     {
 274       ind = array_expand_index (sub, sublen);
 275       if (ind < 0)
 276         {
 277           free (vname);
 278           err_badarraysub (name);
 279           return ((SHELL_VAR *)NULL);
 280         }
 281       entry = bind_array_variable (vname, ind, value, flags);
 282     }
 283
 284   free (vname);
 285   return (entry);
 286 }
 287
 288 /* Find the array variable corresponding to NAME.  If there is no variable,
 289    create a new array variable.  If the variable exists but is not an array,
 290    convert it to an indexed array.  If FLAGS&1 is non-zero, an existing
 291    variable is checked for the readonly or noassign attribute in preparation
 292    for assignment (e.g., by the `read' builtin).  If FLAGS&2 is non-zero, we
 293    create an associative array. */
 294 SHELL_VAR *
 295 find_or_make_array_variable (name, flags)
 296      char *name;
 297      int flags;
 298 {
 299   SHELL_VAR *var;
 300
 301   var = find_variable (name);
 302
 303   if (var == 0)
 304     var = (flags & 2) ? make_new_assoc_variable (name) : make_new_array_variable (name);
 305   else if ((flags & 1) && (readonly_p (var) || noassign_p (var)))
 306     {
 307       if (readonly_p (var))
 308         err_readonly (name);
 309       return ((SHELL_VAR *)NULL);
 310     }
 311   else if ((flags & 2) && array_p (var))
 312     {
 313       report_error (_("%s: cannot convert indexed to associative array"), name);
 314       return ((SHELL_VAR *)NULL);
 315     }
 316   else if (array_p (var) == 0 && assoc_p (var) == 0)
 317     var = convert_var_to_array (var);
 318
 319   return (var);
 320 }
 321
 322 /* Perform a compound assignment statement for array NAME, where VALUE is
 323    the text between the parens:  NAME=( VALUE ) */
 324 SHELL_VAR *
 325 assign_array_from_string (name, value, flags)
 326      char *name, *value;
 327      int flags;
 328 {
 329   SHELL_VAR *var;
 330   int vflags;
 331
 332   vflags = 1;
 333   if (flags & ASS_MKASSOC)
 334     vflags |= 2;
 335
 336   var = find_or_make_array_variable (name, vflags);
 337   if (var == 0)
 338     return ((SHELL_VAR *)NULL);
 339
 340   return (assign_array_var_from_string (var, value, flags));
 341 }
 342
 343 /* Sequentially assign the indices of indexed array variable VAR from the
 344    words in LIST. */
 345 SHELL_VAR *
 346 assign_array_var_from_word_list (var, list, flags)
 347      SHELL_VAR *var;
 348      WORD_LIST *list;
 349      int flags;
 350 {
 351   register arrayind_t i;
 352   register WORD_LIST *l;
 353   ARRAY *a;
 354
 355   a = array_cell (var);
 356   i = (flags & ASS_APPEND) ? array_max_index (a) + 1 : 0;
 357
 358   for (l = list; l; l = l->next, i++)
 359     if (var->assign_func)
 360       (*var->assign_func) (var, l->word->word, i, 0);
 361     else
 362       array_insert (a, i, l->word->word);
 363   return var;
 364 }
 365
 366 WORD_LIST *
 367 expand_compound_array_assignment (var, value, flags)
 368      SHELL_VAR *var;
 369      char *value;
 370      int flags;
 371 {
 372   WORD_LIST *list, *nlist;
 373   char *val;
 374   int ni;
 375
 376   /* I don't believe this condition is ever true any more. */
 377   if (*value == '(')    /*)*/
 378     {
 379       ni = 1;
 380       val = extract_array_assignment_list (value, &ni);
 381       if (val == 0)
 382         return (WORD_LIST *)NULL;
 383     }
 384   else
 385     val = value;
 386
 387   /* Expand the value string into a list of words, performing all the
 388      shell expansions including pathname generation and word splitting. */
 389   /* First we split the string on whitespace, using the shell parser
 390      (ksh93 seems to do this). */
 391   list = parse_string_to_word_list (val, 1, "array assign");
 392
 393   /* If we're using [subscript]=value, we need to quote each [ and ] to
 394      prevent unwanted filename expansion. */
 395   if (list)
 396     quote_array_assignment_chars (list);
 397
 398   /* Now that we've split it, perform the shell expansions on each
 399      word in the list. */
 400   nlist = list ? expand_words_no_vars (list) : (WORD_LIST *)NULL;
 401
 402   dispose_words (list);
 403
 404   if (val != value)
 405     free (val);
 406
 407   return nlist;
 408 }
 409
 410 /* Callers ensure that VAR is not NULL */
 411 void
 412 assign_compound_array_list (var, nlist, flags)
 413      SHELL_VAR *var;
 414      WORD_LIST *nlist;
 415      int flags;
 416 {
 417   ARRAY *a;
 418   HASH_TABLE *h;
 419   WORD_LIST *list;
 420   char *w, *val, *nval;
 421   int len, iflags;
 422   arrayind_t ind, last_ind;
 423   char *akey;
 424
 425   a = (var && array_p (var)) ? array_cell (var) : (ARRAY *)0;
 426   h = (var && assoc_p (var)) ? assoc_cell (var) : (HASH_TABLE *)0;
 427
 428   akey = (char *)0;
 429   ind = 0;
 430
 431   /* Now that we are ready to assign values to the array, kill the existing
 432      value. */
 433   if ((flags & ASS_APPEND) == 0)
 434     {
 435       if (a && array_p (var))
 436         array_flush (a);
 437       else if (h && assoc_p (var))
 438         assoc_flush (h);
 439     }
 440
 441   last_ind = (a && (flags & ASS_APPEND)) ? array_max_index (a) + 1 : 0;
 442
 443   for (list = nlist; list; list = list->next)
 444     {
 445       iflags = flags;
 446       w = list->word->word;
 447
 448       /* We have a word of the form [ind]=value */
 449       if ((list->word->flags & W_ASSIGNMENT) && w[0] == '[')
 450         {
 451           len = skipsubscript (w, 0, (var && assoc_p (var) != 0));
 452
 453           /* XXX - changes for `+=' */
 454           if (w[len] != ']' || (w[len+1] != '=' && (w[len+1] != '+' || w[len+2] != '=')))
 455             {
 456               if (assoc_p (var))
 457                 {
 458                   err_badarraysub (w);
 459                   continue;
 460                 }
 461               nval = make_variable_value (var, w, flags);
 462               if (var->assign_func)
 463                 (*var->assign_func) (var, nval, last_ind, 0);
 464               else
 465                 array_insert (a, last_ind, nval);
 466               FREE (nval);
 467               last_ind++;
 468               continue;
 469             }
 470
 471           if (len == 1)
 472             {
 473               err_badarraysub (w);
 474               continue;
 475             }
 476
 477           if (ALL_ELEMENT_SUB (w[1]) && len == 2)
 478             {
 479               if (assoc_p (var))
 480                 report_error (_("%s: invalid associative array key"), w);
 481               else
 482                 report_error (_("%s: cannot assign to non-numeric index"), w);
 483               continue;
 484             }
 485
 486           if (array_p (var))
 487             {
 488               ind = array_expand_index (w + 1, len);
 489               if (ind < 0)
 490                 {
 491                   err_badarraysub (w);
 492                   continue;
 493                 }
 494
 495               last_ind = ind;
 496             }
 497           else if (assoc_p (var))
 498             {
 499               akey = substring (w, 1, len);
 500               if (akey == 0 || *akey == 0)
 501                 {
 502                   err_badarraysub (w);
 503                   continue;
 504                 }
 505             }
 506
 507           /* XXX - changes for `+=' -- just accept the syntax.  ksh93 doesn't do this */
 508           if (w[len + 1] == '+' && w[len + 2] == '=')
 509             {
 510               iflags |= ASS_APPEND;
 511               val = w + len + 3;
 512             }
 513           else
 514             val = w + len + 2;
 515         }
 516       else if (assoc_p (var))
 517         {
 518           report_error (_("%s: %s: must use subscript when assigning associative array"), var->name, w);
 519           continue;
 520         }
 521       else              /* No [ind]=value, just a stray `=' */
 522         {
 523           ind = last_ind;
 524           val = w;
 525         }
 526
 527       if (integer_p (var))
 528         this_command_name = (char *)NULL;       /* no command name for errors */
 529       bind_array_var_internal (var, ind, akey, val, iflags);
 530       last_ind++;
 531     }
 532 }
 533
 534 /* Perform a compound array assignment:  VAR->name=( VALUE ).  The
 535    VALUE has already had the parentheses stripped. */
 536 SHELL_VAR *
 537 assign_array_var_from_string (var, value, flags)
 538      SHELL_VAR *var;
 539      char *value;
 540      int flags;
 541 {
 542   WORD_LIST *nlist;
 543
 544   if (value == 0)
 545     return var;
 546
 547   nlist = expand_compound_array_assignment (var, value, flags);
 548   assign_compound_array_list (var, nlist, flags);
 549
 550   if (nlist)
 551     dispose_words (nlist);
 552   return (var);
 553 }
 554
 555 /* Quote globbing chars and characters in $IFS before the `=' in an assignment
 556    statement (usually a compound array assignment) to protect them from
 557    unwanted filename expansion or word splitting. */
 558 static char *
 559 quote_assign (string)
 560      const char *string;
 561 {
 562   size_t slen;
 563   int saw_eq;
 564   char *temp, *t, *subs;
 565   const char *s, *send;
 566   int ss, se;
 567   DECLARE_MBSTATE;
 568
 569   slen = strlen (string);
 570   send = string + slen;
 571
 572   t = temp = (char *)xmalloc (slen * 2 + 1);
 573   saw_eq = 0;
 574   for (s = string; *s; )
 575     {
 576       if (*s == '=')
 577         saw_eq = 1;
 578       if (saw_eq == 0 && *s == '[')             /* looks like a subscript */
 579         {
 580           ss = s - string;
 581           se = skipsubscript (string, ss, 0);
 582           subs = substring (s, ss, se);
 583           *t++ = '\\';
 584           strcpy (t, subs);
 585           t += se - ss;
 586           *t++ = '\\';
 587           *t++ = ']';
 588           s += se + 1;
 589           free (subs);
 590           continue;
 591         }
 592       if (saw_eq == 0 && (glob_char_p (s) || isifs (*s)))
 593         *t++ = '\\';
 594
 595       COPY_CHAR_P (t, s, send);
 596     }
 597   *t = '\0';
 598   return temp;
 599 }
 600
 601 /* For each word in a compound array assignment, if the word looks like
 602    [ind]=value, quote globbing chars and characters in $IFS before the `='. */
 603 static void
 604 quote_array_assignment_chars (list)
 605      WORD_LIST *list;
 606 {
 607   char *nword;
 608   WORD_LIST *l;
 609
 610   for (l = list; l; l = l->next)
 611     {
 612       if (l->word == 0 || l->word->word == 0 || l->word->word[0] == '\0')
 613         continue;       /* should not happen, but just in case... */
 614       /* Don't bother if it doesn't look like [ind]=value */
 615       if (l->word->word[0] != '[' || mbschr (l->word->word, '=') == 0) /* ] */
 616         continue;
 617       nword = quote_assign (l->word->word);
 618       free (l->word->word);
 619       l->word->word = nword;
 620     }
 621 }
 622
 623 /* skipsubscript moved to subst.c to use private functions. 2009/02/24. */
 624
 625 /* This function is called with SUB pointing to just after the beginning
 626    `[' of an array subscript and removes the array element to which SUB
 627    expands from array VAR.  A subscript of `*' or `@' unsets the array. */
 628 int
 629 unbind_array_element (var, sub)
 630      SHELL_VAR *var;
 631      char *sub;
 632 {
 633   int len;
 634   arrayind_t ind;
 635   char *akey;
 636   ARRAY_ELEMENT *ae;
 637
 638   len = skipsubscript (sub, 0, 0);
 639   if (sub[len] != ']' || len == 0)
 640     {
 641       builtin_error ("%s[%s: %s", var->name, sub, _(bash_badsub_errmsg));
 642       return -1;
 643     }
 644   sub[len] = '\0';
 645
 646   if (ALL_ELEMENT_SUB (sub[0]) && sub[1] == 0)
 647     {
 648       unbind_variable (var->name);
 649       return (0);
 650     }
 651
 652   if (assoc_p (var))
 653     {
 654       akey = expand_assignment_string_to_string (sub, 0);     /* [ */
 655       if (akey == 0 || *akey == 0)
 656         {
 657           builtin_error ("[%s]: %s", sub, _(bash_badsub_errmsg));
 658           return -1;
 659         }
 660       assoc_remove (assoc_cell (var), akey);
 661     }
 662   else
 663     {
 664       ind = array_expand_index (sub, len+1);
 665       if (ind < 0)
 666         {
 667           builtin_error ("[%s]: %s", sub, _(bash_badsub_errmsg));
 668           return -1;
 669         }
 670       ae = array_remove (array_cell (var), ind);
 671       if (ae)
 672         array_dispose_element (ae);
 673     }
 674
 675   return 0;
 676 }
 677
 678 /* Format and output an array assignment in compound form VAR=(VALUES),
 679    suitable for re-use as input. */
 680 void
 681 print_array_assignment (var, quoted)
 682      SHELL_VAR *var;
 683      int quoted;
 684 {
 685   char *vstr;
 686
 687   vstr = array_to_assign (array_cell (var), quoted);
 688
 689   if (vstr == 0)
 690     printf ("%s=%s\n", var->name, quoted ? "'()'" : "()");
 691   else
 692     {
 693       printf ("%s=%s\n", var->name, vstr);
 694       free (vstr);
 695     }
 696 }
 697
 698 /* Format and output an associative array assignment in compound form
 699    VAR=(VALUES), suitable for re-use as input. */
 700 void
 701 print_assoc_assignment (var, quoted)
 702      SHELL_VAR *var;
 703      int quoted;
 704 {
 705   char *vstr;
 706
 707   vstr = assoc_to_assign (assoc_cell (var), quoted);
 708
 709   if (vstr == 0)
 710     printf ("%s=%s\n", var->name, quoted ? "'()'" : "()");
 711   else
 712     {
 713       printf ("%s=%s\n", var->name, vstr);
 714       free (vstr);
 715     }
 716 }
 717
 718 /***********************************************************************/
 719 /*                                                                     */
 720 /* Utility functions to manage arrays and their contents for expansion */
 721 /*                                                                     */
 722 /***********************************************************************/
 723
 724 /* Return 1 if NAME is a properly-formed array reference v[sub]. */
 725 int
 726 valid_array_reference (name)
 727      char *name;
 728 {
 729   char *t;
 730   int r, len;
 731
 732   t = mbschr (name, '[');       /* ] */
 733   if (t)
 734     {
 735       *t = '\0';
 736       r = legal_identifier (name);
 737       *t = '[';
 738       if (r == 0)
 739         return 0;
 740       /* Check for a properly-terminated non-blank subscript. */
 741       len = skipsubscript (t, 0, 0);
 742       if (t[len] != ']' || len == 1)
 743         return 0;
 744       for (r = 1; r < len; r++)
 745         if (whitespace (t[r]) == 0)
 746           return 1;
 747       return 0;
 748     }
 749   return 0;
 750 }
 751
 752 /* Expand the array index beginning at S and extending LEN characters. */
 753 arrayind_t
 754 array_expand_index (s, len)
 755      char *s;
 756      int len;
 757 {
 758   char *exp, *t;
 759   int expok;
 760   arrayind_t val;
 761
 762   exp = (char *)xmalloc (len);
 763   strncpy (exp, s, len - 1);
 764   exp[len - 1] = '\0';
 765   t = expand_arith_string (exp, 0);
 766   this_command_name = (char *)NULL;
 767   val = evalexp (t, &expok);
 768   free (t);
 769   free (exp);
 770   if (expok == 0)
 771     {
 772       last_command_exit_value = EXECUTION_FAILURE;
 773
 774       top_level_cleanup ();
 775       jump_to_top_level (DISCARD);
 776     }
 777   return val;
 778 }
 779
 780 /* Return the name of the variable specified by S without any subscript.
 781    If SUBP is non-null, return a pointer to the start of the subscript
 782    in *SUBP. If LENP is non-null, the length of the subscript is returned
 783    in *LENP.  This returns newly-allocated memory. */
 784 char *
 785 array_variable_name (s, subp, lenp)
 786      char *s, **subp;
 787      int *lenp;
 788 {
 789   char *t, *ret;
 790   int ind, ni;
 791
 792   t = mbschr (s, '[');
 793   if (t == 0)
 794     {
 795       if (subp)
 796         *subp = t;
 797       if (lenp)
 798         *lenp = 0;
 799       return ((char *)NULL);
 800     }
 801   ind = t - s;
 802   ni = skipsubscript (s, ind, 0);
 803   if (ni <= ind + 1 || s[ni] != ']')
 804     {
 805       err_badarraysub (s);
 806       if (subp)
 807         *subp = t;
 808       if (lenp)
 809         *lenp = 0;
 810       return ((char *)NULL);
 811     }
 812
 813   *t = '\0';
 814   ret = savestring (s);
 815   *t++ = '[';           /* ] */
 816
 817   if (subp)
 818     *subp = t;
 819   if (lenp)
 820     *lenp = ni - ind;
 821
 822   return ret;
 823 }
 824
 825 /* Return the variable specified by S without any subscript.  If SUBP is
 826    non-null, return a pointer to the start of the subscript in *SUBP.
 827    If LENP is non-null, the length of the subscript is returned in *LENP. */
 828 SHELL_VAR *
 829 array_variable_part (s, subp, lenp)
 830      char *s, **subp;
 831      int *lenp;
 832 {
 833   char *t;
 834   SHELL_VAR *var;
 835
 836   t = array_variable_name (s, subp, lenp);
 837   if (t == 0)
 838     return ((SHELL_VAR *)NULL);
 839   var = find_variable (t);
 840
 841   free (t);
 842   return (var == 0 || invisible_p (var)) ? (SHELL_VAR *)0 : var;
 843 }
 844
 845 /* Return a string containing the elements in the array and subscript
 846    described by S.  If the subscript is * or @, obeys quoting rules akin
 847    to the expansion of $* and $@ including double quoting.  If RTYPE
 848    is non-null it gets 1 if the array reference is name[*], 2 if the
 849    reference is name[@], and 0 otherwise. */
 850 static char *
 851 array_value_internal (s, quoted, allow_all, rtype)
 852      char *s;
 853      int quoted, allow_all, *rtype;
 854 {
 855   int len;
 856   arrayind_t ind;
 857   char *akey;
 858   char *retval, *t, *temp;
 859   WORD_LIST *l;
 860   SHELL_VAR *var;
 861
 862   var = array_variable_part (s, &t, &len);
 863
 864   /* Expand the index, even if the variable doesn't exist, in case side
 865      effects are needed, like ${w[i++]} where w is unset. */
 866 #if 0
 867   if (var == 0)
 868     return (char *)NULL;
 869 #endif
 870
 871   if (len == 0)
 872     return ((char *)NULL);      /* error message already printed */
 873
 874   /* [ */
 875   if (ALL_ELEMENT_SUB (t[0]) && t[1] == ']')
 876     {
 877       if (rtype)
 878         *rtype = (t[0] == '*') ? 1 : 2;
 879       if (allow_all == 0)
 880         {
 881           err_badarraysub (s);
 882           return ((char *)NULL);
 883         }
 884       else if (var == 0 || value_cell (var) == 0)
 885         return ((char *)NULL);
 886       else if (array_p (var) == 0 && assoc_p (var) == 0)
 887         l = add_string_to_list (value_cell (var), (WORD_LIST *)NULL);
 888       else if (assoc_p (var))
 889         {
 890           l = assoc_to_word_list (assoc_cell (var));
 891           if (l == (WORD_LIST *)NULL)
 892             return ((char *)NULL);
 893         }
 894       else
 895         {
 896           l = array_to_word_list (array_cell (var));
 897           if (l == (WORD_LIST *)NULL)
 898             return ((char *) NULL);
 899         }
 900
 901       if (t[0] == '*' && (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)))
 902         {
 903           temp = string_list_dollar_star (l);
 904           retval = quote_string (temp);
 905           free (temp);
 906         }
 907       else      /* ${name[@]} or unquoted ${name[*]} */
 908         retval = string_list_dollar_at (l, quoted);
 909
 910       dispose_words (l);
 911     }
 912   else
 913     {
 914       if (rtype)
 915         *rtype = 0;
 916       if (var == 0 || array_p (var) || assoc_p (var) == 0)
 917         {
 918           ind = array_expand_index (t, len);
 919           if (ind < 0)
 920             {
 921 index_error:
 922               if (var)
 923                 err_badarraysub (var->name);
 924               else
 925                 {
 926                   t[-1] = '\0';
 927                   err_badarraysub (s);
 928                   t[-1] = '[';  /* ] */
 929                 }
 930               return ((char *)NULL);
 931             }
 932         }
 933       else if (assoc_p (var))
 934         {
 935           t[len - 1] = '\0';
 936           akey = expand_assignment_string_to_string (t, 0);     /* [ */
 937           t[len - 1] = ']';
 938           if (akey == 0 || *akey == 0)
 939             goto index_error;
 940         }
 941
 942       if (var == 0)
 943         return ((char *)NULL);
 944       if (array_p (var) == 0 && assoc_p (var) == 0)
 945         return (ind == 0 ? value_cell (var) : (char *)NULL);
 946       else if (assoc_p (var))
 947         retval = assoc_reference (assoc_cell (var), akey);
 948       else
 949         retval = array_reference (array_cell (var), ind);
 950     }
 951
 952   return retval;
 953 }
 954
 955 /* Return a string containing the elements described by the array and
 956    subscript contained in S, obeying quoting for subscripts * and @. */
 957 char *
 958 array_value (s, quoted, rtype)
 959      char *s;
 960      int quoted, *rtype;
 961 {
 962   return (array_value_internal (s, quoted, 1, rtype));
 963 }
 964
 965 /* Return the value of the array indexing expression S as a single string.
 966    If ALLOW_ALL is 0, do not allow `@' and `*' subscripts.  This is used
 967    by other parts of the shell such as the arithmetic expression evaluator
 968    in expr.c. */
 969 char *
 970 get_array_value (s, allow_all, rtype)
 971      char *s;
 972      int allow_all, *rtype;
 973 {
 974   return (array_value_internal (s, 0, allow_all, rtype));
 975 }
 976
 977 char *
 978 array_keys (s, quoted)
 979      char *s;
 980      int quoted;
 981 {
 982   int len;
 983   char *retval, *t, *temp;
 984   WORD_LIST *l;
 985   SHELL_VAR *var;
 986
 987   var = array_variable_part (s, &t, &len);
 988
 989   /* [ */
 990   if (var == 0 || ALL_ELEMENT_SUB (t[0]) == 0 || t[1] != ']')
 991     return (char *)NULL;
 992
 993   if (array_p (var) == 0 && assoc_p (var) == 0)
 994     l = add_string_to_list ("0", (WORD_LIST *)NULL);
 995   else if (assoc_p (var))
 996     l = assoc_keys_to_word_list (assoc_cell (var));
 997   else
 998     l = array_keys_to_word_list (array_cell (var));
 999   if (l == (WORD_LIST *)NULL)
1000     return ((char *) NULL);
1001
1002   if (t[0] == '*' && (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)))
1003     {
1004       temp = string_list_dollar_star (l);
1005       retval = quote_string (temp);
1006       free (temp);
1007     }
1008   else  /* ${!name[@]} or unquoted ${!name[*]} */
1009     retval = string_list_dollar_at (l, quoted);
1010
1011   dispose_words (l);
1012   return retval;
1013 }
1014 #endif /* ARRAY_VARS */