1 /* arrayfunc.c -- High-level array functions used by other parts of the shell. */
3 /* Copyright (C) 2001-2011 Free Software Foundation, Inc.
5 This file is part of GNU Bash, the Bourne Again SHell.
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.
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.
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/>.
23 #if defined (ARRAY_VARS)
25 #if defined (HAVE_UNISTD_H)
37 #include "builtins/common.h"
39 extern char *this_command_name;
40 extern int last_command_exit_value;
41 extern int array_needs_making;
43 static SHELL_VAR *bind_array_var_internal __P((SHELL_VAR *, arrayind_t, char *, char *, int));
44 static SHELL_VAR *assign_array_element_internal __P((SHELL_VAR *, char *, char *, char *, int, char *, int));
46 static char *quote_assign __P((const char *));
47 static void quote_array_assignment_chars __P((WORD_LIST *));
48 static char *array_value_internal __P((char *, int, int, int *, arrayind_t *));
50 /* Standard error message to use when encountering an invalid array subscript */
51 const char * const bash_badsub_errmsg = N_("bad array subscript");
53 /* **************************************************************** */
55 /* Functions to manipulate array variables and perform assignments */
57 /* **************************************************************** */
59 /* Convert a shell variable to an array variable. The original value is
62 convert_var_to_array (var)
68 oldval = value_cell (var);
69 array = array_create ();
71 array_insert (array, 0, oldval);
73 FREE (value_cell (var));
74 var_setarray (var, array);
76 /* these aren't valid anymore */
77 var->dynamic_value = (sh_var_value_func_t *)NULL;
78 var->assign_func = (sh_var_assign_func_t *)NULL;
80 INVALIDATE_EXPORTSTR (var);
84 VSETATTR (var, att_array);
85 VUNSETATTR (var, att_invisible);
90 /* Convert a shell variable to an array variable. The original value is
93 convert_var_to_assoc (var)
99 oldval = value_cell (var);
100 hash = assoc_create (0);
102 assoc_insert (hash, savestring ("0"), oldval);
104 FREE (value_cell (var));
105 var_setassoc (var, hash);
107 /* these aren't valid anymore */
108 var->dynamic_value = (sh_var_value_func_t *)NULL;
109 var->assign_func = (sh_var_assign_func_t *)NULL;
111 INVALIDATE_EXPORTSTR (var);
112 if (exported_p (var))
113 array_needs_making++;
115 VSETATTR (var, att_assoc);
116 VUNSETATTR (var, att_invisible);
122 make_array_variable_value (entry, ind, key, value, flags)
132 /* If we're appending, we need the old value of the array reference, so
133 fake out make_variable_value with a dummy SHELL_VAR */
134 if (flags & ASS_APPEND)
136 dentry = (SHELL_VAR *)xmalloc (sizeof (SHELL_VAR));
137 dentry->name = savestring (entry->name);
139 newval = assoc_reference (assoc_cell (entry), key);
141 newval = array_reference (array_cell (entry), ind);
143 dentry->value = savestring (newval);
146 dentry->value = (char *)xmalloc (1);
147 dentry->value[0] = '\0';
149 dentry->exportstr = 0;
150 dentry->attributes = entry->attributes & ~(att_array|att_assoc|att_exported);
151 /* Leave the rest of the members uninitialized; the code doesn't look
153 newval = make_variable_value (dentry, value, flags);
154 dispose_variable (dentry);
157 newval = make_variable_value (entry, value, flags);
163 bind_array_var_internal (entry, ind, key, value, flags)
172 newval = make_array_variable_value (entry, ind, key, value, flags);
174 if (entry->assign_func)
175 (*entry->assign_func) (entry, newval, ind, key);
176 else if (assoc_p (entry))
177 assoc_insert (assoc_cell (entry), key, newval);
179 array_insert (array_cell (entry), ind, newval);
185 /* Perform an array assignment name[ind]=value. If NAME already exists and
186 is not an array, and IND is 0, perform name=value instead. If NAME exists
187 and is not an array, and IND is not 0, convert it into an array with the
188 existing value as name[0].
190 If NAME does not exist, just create an array variable, no matter what
191 IND's value may be. */
193 bind_array_variable (name, ind, value, flags)
201 entry = find_shell_variable (name);
203 if (entry == (SHELL_VAR *) 0)
204 entry = make_new_array_variable (name);
205 else if (readonly_p (entry) || noassign_p (entry))
207 if (readonly_p (entry))
211 else if (array_p (entry) == 0)
212 entry = convert_var_to_array (entry);
214 /* ENTRY is an array variable, and ARRAY points to the value. */
215 return (bind_array_var_internal (entry, ind, 0, value, flags));
219 bind_array_element (entry, ind, value, flags)
225 return (bind_array_var_internal (entry, ind, 0, value, flags));
229 bind_assoc_variable (entry, name, key, value, flags)
239 if (readonly_p (entry) || noassign_p (entry))
241 if (readonly_p (entry))
246 return (bind_array_var_internal (entry, 0, key, value, flags));
249 /* Parse NAME, a lhs of an assignment statement of the form v[s], and
250 assign VALUE to that array element by calling bind_array_variable(). */
252 assign_array_element (name, value, flags)
260 vname = array_variable_name (name, &sub, &sublen);
263 return ((SHELL_VAR *)NULL);
265 if ((ALL_ELEMENT_SUB (sub[0]) && sub[1] == ']') || (sublen <= 1))
268 err_badarraysub (name);
269 return ((SHELL_VAR *)NULL);
272 entry = find_variable (vname);
273 entry = assign_array_element_internal (entry, name, vname, sub, sublen, value, flags);
280 assign_array_element_internal (entry, name, vname, sub, sublen, value, flags)
282 char *name; /* only used for error messages */
292 if (entry && assoc_p (entry))
294 sub[sublen-1] = '\0';
295 akey = expand_assignment_string_to_string (sub, 0); /* [ */
297 if (akey == 0 || *akey == 0)
299 err_badarraysub (name);
301 return ((SHELL_VAR *)NULL);
303 entry = bind_assoc_variable (entry, vname, akey, value, flags);
307 ind = array_expand_index (entry, sub, sublen);
308 /* negative subscripts to indexed arrays count back from end */
309 if (entry && ind < 0)
310 ind = (array_p (entry) ? array_max_index (array_cell (entry)) : 0) + 1 + ind;
313 err_badarraysub (name);
314 return ((SHELL_VAR *)NULL);
316 entry = bind_array_variable (vname, ind, value, flags);
322 /* Find the array variable corresponding to NAME. If there is no variable,
323 create a new array variable. If the variable exists but is not an array,
324 convert it to an indexed array. If FLAGS&1 is non-zero, an existing
325 variable is checked for the readonly or noassign attribute in preparation
326 for assignment (e.g., by the `read' builtin). If FLAGS&2 is non-zero, we
327 create an associative array. */
329 find_or_make_array_variable (name, flags)
335 var = find_variable (name);
338 /* See if we have a nameref pointing to a variable that hasn't been
340 var = find_variable_last_nameref (name);
341 if (var && nameref_p (var))
342 var = (flags & 2) ? make_new_assoc_variable (nameref_cell (var)) : make_new_array_variable (nameref_cell (var));
346 var = (flags & 2) ? make_new_assoc_variable (name) : make_new_array_variable (name);
347 else if ((flags & 1) && (readonly_p (var) || noassign_p (var)))
349 if (readonly_p (var))
351 return ((SHELL_VAR *)NULL);
353 else if ((flags & 2) && array_p (var))
355 last_command_exit_value = 1;
356 report_error (_("%s: cannot convert indexed to associative array"), name);
357 return ((SHELL_VAR *)NULL);
359 else if (array_p (var) == 0 && assoc_p (var) == 0)
360 var = convert_var_to_array (var);
365 /* Perform a compound assignment statement for array NAME, where VALUE is
366 the text between the parens: NAME=( VALUE ) */
368 assign_array_from_string (name, value, flags)
376 if (flags & ASS_MKASSOC)
379 var = find_or_make_array_variable (name, vflags);
381 return ((SHELL_VAR *)NULL);
383 return (assign_array_var_from_string (var, value, flags));
386 /* Sequentially assign the indices of indexed array variable VAR from the
389 assign_array_var_from_word_list (var, list, flags)
394 register arrayind_t i;
395 register WORD_LIST *l;
398 a = array_cell (var);
399 i = (flags & ASS_APPEND) ? array_max_index (a) + 1 : 0;
401 for (l = list; l; l = l->next, i++)
402 if (var->assign_func)
403 (*var->assign_func) (var, l->word->word, i, 0);
405 array_insert (a, i, l->word->word);
410 expand_compound_array_assignment (var, value, flags)
415 WORD_LIST *list, *nlist;
416 WORD_LIST *hd, *tl, *t, *n;
420 /* This condition is true when invoked from the declare builtin with a
422 declare -a d='([1]="" [2]="bdef" [5]="hello world" "test")' */
423 if (*value == '(') /*)*/
426 val = extract_array_assignment_list (value, &ni);
428 return (WORD_LIST *)NULL;
433 /* Expand the value string into a list of words, performing all the
434 shell expansions including pathname generation and word splitting. */
435 /* First we split the string on whitespace, using the shell parser
436 (ksh93 seems to do this). */
437 list = parse_string_to_word_list (val, 1, "array assign");
439 if (var && assoc_p (var))
446 /* If we're using [subscript]=value, we need to quote each [ and ] to
447 prevent unwanted filename expansion. This doesn't need to be done
448 for associative array expansion, since that uses a different expansion
449 function (see assign_compound_array_list below). */
451 quote_array_assignment_chars (list);
453 /* Now that we've split it, perform the shell expansions on each
455 nlist = list ? expand_words_no_vars (list) : (WORD_LIST *)NULL;
457 dispose_words (list);
465 /* Callers ensure that VAR is not NULL */
467 assign_compound_array_list (var, nlist, flags)
475 char *w, *val, *nval;
476 int len, iflags, free_val;
477 arrayind_t ind, last_ind;
480 a = (var && array_p (var)) ? array_cell (var) : (ARRAY *)0;
481 h = (var && assoc_p (var)) ? assoc_cell (var) : (HASH_TABLE *)0;
486 /* Now that we are ready to assign values to the array, kill the existing
488 if ((flags & ASS_APPEND) == 0)
490 if (a && array_p (var))
492 else if (h && assoc_p (var))
496 last_ind = (a && (flags & ASS_APPEND)) ? array_max_index (a) + 1 : 0;
498 for (list = nlist; list; list = list->next)
501 w = list->word->word;
503 /* We have a word of the form [ind]=value */
504 if ((list->word->flags & W_ASSIGNMENT) && w[0] == '[')
506 /* Don't have to handle embedded quotes specially any more, since
507 associative array subscripts have not been expanded yet (see
509 len = skipsubscript (w, 0, 0);
511 /* XXX - changes for `+=' */
512 if (w[len] != ']' || (w[len+1] != '=' && (w[len+1] != '+' || w[len+2] != '=')))
519 nval = make_variable_value (var, w, flags);
520 if (var->assign_func)
521 (*var->assign_func) (var, nval, last_ind, 0);
523 array_insert (a, last_ind, nval);
535 if (ALL_ELEMENT_SUB (w[1]) && len == 2)
537 last_command_exit_value = 1;
539 report_error (_("%s: invalid associative array key"), w);
541 report_error (_("%s: cannot assign to non-numeric index"), w);
547 ind = array_expand_index (var, w + 1, len);
548 /* negative subscripts to indexed arrays count back from end */
550 ind = array_max_index (array_cell (var)) + 1 + ind;
559 else if (assoc_p (var))
561 /* This is not performed above, see expand_compound_array_assignment */
563 akey = expand_assignment_string_to_string (w+1, 0);
565 /* And we need to expand the value also, see below */
566 if (akey == 0 || *akey == 0)
574 /* XXX - changes for `+=' -- just accept the syntax. ksh93 doesn't do this */
575 if (w[len + 1] == '+' && w[len + 2] == '=')
577 iflags |= ASS_APPEND;
583 else if (assoc_p (var))
585 last_command_exit_value = 1;
586 report_error (_("%s: %s: must use subscript when assigning associative array"), var->name, w);
589 else /* No [ind]=value, just a stray `=' */
596 /* See above; we need to expand the value here */
599 val = expand_assignment_string_to_string (val, 0);
602 val = (char *)xmalloc (1);
603 val[0] = '\0'; /* like do_assignment_internal */
609 this_command_name = (char *)NULL; /* no command name for errors */
610 bind_array_var_internal (var, ind, akey, val, iflags);
618 /* Perform a compound array assignment: VAR->name=( VALUE ). The
619 VALUE has already had the parentheses stripped. */
621 assign_array_var_from_string (var, value, flags)
631 nlist = expand_compound_array_assignment (var, value, flags);
632 assign_compound_array_list (var, nlist, flags);
635 dispose_words (nlist);
639 /* Quote globbing chars and characters in $IFS before the `=' in an assignment
640 statement (usually a compound array assignment) to protect them from
641 unwanted filename expansion or word splitting. */
643 quote_assign (string)
648 char *temp, *t, *subs;
649 const char *s, *send;
653 slen = strlen (string);
654 send = string + slen;
656 t = temp = (char *)xmalloc (slen * 2 + 1);
658 for (s = string; *s; )
662 if (saw_eq == 0 && *s == '[') /* looks like a subscript */
665 se = skipsubscript (string, ss, 0);
666 subs = substring (s, ss, se);
676 if (saw_eq == 0 && (glob_char_p (s) || isifs (*s)))
679 COPY_CHAR_P (t, s, send);
685 /* For each word in a compound array assignment, if the word looks like
686 [ind]=value, quote globbing chars and characters in $IFS before the `='. */
688 quote_array_assignment_chars (list)
694 for (l = list; l; l = l->next)
696 if (l->word == 0 || l->word->word == 0 || l->word->word[0] == '\0')
697 continue; /* should not happen, but just in case... */
698 /* Don't bother if it hasn't been recognized as an assignment or
699 doesn't look like [ind]=value */
700 if ((l->word->flags & W_ASSIGNMENT) == 0)
702 if (l->word->word[0] != '[' || mbschr (l->word->word, '=') == 0) /* ] */
705 nword = quote_assign (l->word->word);
706 free (l->word->word);
707 l->word->word = nword;
708 l->word->flags |= W_NOGLOB; /* XXX - W_NOSPLIT also? */
712 /* skipsubscript moved to subst.c to use private functions. 2009/02/24. */
714 /* This function is called with SUB pointing to just after the beginning
715 `[' of an array subscript and removes the array element to which SUB
716 expands from array VAR. A subscript of `*' or `@' unsets the array. */
718 unbind_array_element (var, sub)
727 len = skipsubscript (sub, 0, 0);
728 if (sub[len] != ']' || len == 0)
730 builtin_error ("%s[%s: %s", var->name, sub, _(bash_badsub_errmsg));
735 if (ALL_ELEMENT_SUB (sub[0]) && sub[1] == 0)
737 unbind_variable (var->name);
743 akey = expand_assignment_string_to_string (sub, 0); /* [ */
744 if (akey == 0 || *akey == 0)
746 builtin_error ("[%s]: %s", sub, _(bash_badsub_errmsg));
750 assoc_remove (assoc_cell (var), akey);
755 ind = array_expand_index (var, sub, len+1);
756 /* negative subscripts to indexed arrays count back from end */
758 ind = array_max_index (array_cell (var)) + 1 + ind;
761 builtin_error ("[%s]: %s", sub, _(bash_badsub_errmsg));
764 ae = array_remove (array_cell (var), ind);
766 array_dispose_element (ae);
772 /* Format and output an array assignment in compound form VAR=(VALUES),
773 suitable for re-use as input. */
775 print_array_assignment (var, quoted)
781 vstr = array_to_assign (array_cell (var), quoted);
784 printf ("%s=%s\n", var->name, quoted ? "'()'" : "()");
787 printf ("%s=%s\n", var->name, vstr);
792 /* Format and output an associative array assignment in compound form
793 VAR=(VALUES), suitable for re-use as input. */
795 print_assoc_assignment (var, quoted)
801 vstr = assoc_to_assign (assoc_cell (var), quoted);
804 printf ("%s=%s\n", var->name, quoted ? "'()'" : "()");
807 printf ("%s=%s\n", var->name, vstr);
812 /***********************************************************************/
814 /* Utility functions to manage arrays and their contents for expansion */
816 /***********************************************************************/
818 /* Return 1 if NAME is a properly-formed array reference v[sub]. */
820 valid_array_reference (name)
826 t = mbschr (name, '['); /* ] */
830 r = legal_identifier (name);
834 /* Check for a properly-terminated non-blank subscript. */
835 len = skipsubscript (t, 0, 0);
836 if (t[len] != ']' || len == 1)
838 for (r = 1; r < len; r++)
839 if (whitespace (t[r]) == 0)
846 /* Expand the array index beginning at S and extending LEN characters. */
848 array_expand_index (var, s, len)
857 exp = (char *)xmalloc (len);
858 strncpy (exp, s, len - 1);
860 t = expand_arith_string (exp, 0);
861 this_command_name = (char *)NULL;
862 val = evalexp (t, &expok);
867 last_command_exit_value = EXECUTION_FAILURE;
869 top_level_cleanup ();
870 jump_to_top_level (DISCARD);
875 /* Return the name of the variable specified by S without any subscript.
876 If SUBP is non-null, return a pointer to the start of the subscript
877 in *SUBP. If LENP is non-null, the length of the subscript is returned
878 in *LENP. This returns newly-allocated memory. */
880 array_variable_name (s, subp, lenp)
894 return ((char *)NULL);
897 ni = skipsubscript (s, ind, 0);
898 if (ni <= ind + 1 || s[ni] != ']')
905 return ((char *)NULL);
909 ret = savestring (s);
920 /* Return the variable specified by S without any subscript. If SUBP is
921 non-null, return a pointer to the start of the subscript in *SUBP.
922 If LENP is non-null, the length of the subscript is returned in *LENP. */
924 array_variable_part (s, subp, lenp)
931 t = array_variable_name (s, subp, lenp);
933 return ((SHELL_VAR *)NULL);
934 var = find_variable (t);
938 return (var == 0 || invisible_p (var)) ? (SHELL_VAR *)0 : var;
940 return var; /* now return invisible variables; caller must handle */
944 #define INDEX_ERROR() \
948 err_badarraysub (var->name); \
952 err_badarraysub (s); \
953 t[-1] = '['; /* ] */\
955 return ((char *)NULL); \
959 /* Return a string containing the elements in the array and subscript
960 described by S. If the subscript is * or @, obeys quoting rules akin
961 to the expansion of $* and $@ including double quoting. If RTYPE
962 is non-null it gets 1 if the array reference is name[*], 2 if the
963 reference is name[@], and 0 otherwise. */
965 array_value_internal (s, quoted, flags, rtype, indp)
967 int quoted, flags, *rtype;
973 char *retval, *t, *temp;
977 var = array_variable_part (s, &t, &len);
979 /* Expand the index, even if the variable doesn't exist, in case side
980 effects are needed, like ${w[i++]} where w is unset. */
987 return ((char *)NULL); /* error message already printed */
991 if (ALL_ELEMENT_SUB (t[0]) && t[1] == ']')
994 *rtype = (t[0] == '*') ? 1 : 2;
995 if ((flags & AV_ALLOWALL) == 0)
998 return ((char *)NULL);
1000 else if (var == 0 || value_cell (var) == 0) /* XXX - check for invisible_p(var) ? */
1001 return ((char *)NULL);
1002 else if (array_p (var) == 0 && assoc_p (var) == 0)
1003 l = add_string_to_list (value_cell (var), (WORD_LIST *)NULL);
1004 else if (assoc_p (var))
1006 l = assoc_to_word_list (assoc_cell (var));
1007 if (l == (WORD_LIST *)NULL)
1008 return ((char *)NULL);
1012 l = array_to_word_list (array_cell (var));
1013 if (l == (WORD_LIST *)NULL)
1014 return ((char *) NULL);
1017 if (t[0] == '*' && (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)))
1019 temp = string_list_dollar_star (l);
1020 retval = quote_string (temp); /* XXX - leak here */
1023 else /* ${name[@]} or unquoted ${name[*]} */
1024 retval = string_list_dollar_at (l, quoted); /* XXX - leak here */
1032 if (var == 0 || array_p (var) || assoc_p (var) == 0)
1034 if ((flags & AV_USEIND) == 0 || indp == 0)
1036 ind = array_expand_index (var, t, len);
1039 /* negative subscripts to indexed arrays count back from end */
1040 if (var && array_p (var))
1041 ind = array_max_index (array_cell (var)) + 1 + ind;
1051 else if (assoc_p (var))
1054 akey = expand_assignment_string_to_string (t, 0); /* [ */
1056 if (akey == 0 || *akey == 0)
1063 if (var == 0 || value_cell (var) == 0) /* XXX - check invisible_p(var) ? */
1066 return ((char *)NULL);
1068 if (array_p (var) == 0 && assoc_p (var) == 0)
1069 return (ind == 0 ? value_cell (var) : (char *)NULL);
1070 else if (assoc_p (var))
1072 retval = assoc_reference (assoc_cell (var), akey);
1076 retval = array_reference (array_cell (var), ind);
1082 /* Return a string containing the elements described by the array and
1083 subscript contained in S, obeying quoting for subscripts * and @. */
1085 array_value (s, quoted, flags, rtype, indp)
1087 int quoted, flags, *rtype;
1090 return (array_value_internal (s, quoted, flags|AV_ALLOWALL, rtype, indp));
1093 /* Return the value of the array indexing expression S as a single string.
1094 If (FLAGS & AV_ALLOWALL) is 0, do not allow `@' and `*' subscripts. This
1095 is used by other parts of the shell such as the arithmetic expression
1096 evaluator in expr.c. */
1098 get_array_value (s, flags, rtype, indp)
1103 return (array_value_internal (s, 0, flags, rtype, indp));
1107 array_keys (s, quoted)
1112 char *retval, *t, *temp;
1116 var = array_variable_part (s, &t, &len);
1119 if (var == 0 || ALL_ELEMENT_SUB (t[0]) == 0 || t[1] != ']')
1120 return (char *)NULL;
1122 if (var_isset (var) == 0 || invisible_p (var))
1123 return (char *)NULL;
1125 if (array_p (var) == 0 && assoc_p (var) == 0)
1126 l = add_string_to_list ("0", (WORD_LIST *)NULL);
1127 else if (assoc_p (var))
1128 l = assoc_keys_to_word_list (assoc_cell (var));
1130 l = array_keys_to_word_list (array_cell (var));
1131 if (l == (WORD_LIST *)NULL)
1132 return ((char *) NULL);
1134 if (t[0] == '*' && (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)))
1136 temp = string_list_dollar_star (l);
1137 retval = quote_string (temp);
1140 else /* ${!name[@]} or unquoted ${!name[*]} */
1141 retval = string_list_dollar_at (l, quoted);
1146 #endif /* ARRAY_VARS */