1 /* arrayfunc.c -- High-level array functions used by other parts of the shell. */
3 /* Copyright (C) 2001-2016 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)
33 #include "execute_cmd.h"
37 #if defined (HAVE_MBSTR_H) && defined (HAVE_MBSCHR)
38 # include <mbstr.h> /* mbschr */
41 #include "builtins/common.h"
43 /* This variable means to not expand associative array subscripts more than
44 once, when performing variable expansion. */
45 int assoc_expand_once
= 0;
47 /* Ditto for indexed array subscripts -- currently unused */
48 int array_expand_once
= 0;
50 static SHELL_VAR
*bind_array_var_internal
__P((SHELL_VAR
*, arrayind_t
, char *, char *, int));
51 static SHELL_VAR
*assign_array_element_internal
__P((SHELL_VAR
*, char *, char *, char *, int, char *, int));
53 static char *quote_assign
__P((const char *));
54 static void quote_array_assignment_chars
__P((WORD_LIST
*));
55 static char *array_value_internal
__P((const char *, int, int, int *, arrayind_t
*));
57 /* Standard error message to use when encountering an invalid array subscript */
58 const char * const bash_badsub_errmsg
= N_("bad array subscript");
60 /* **************************************************************** */
62 /* Functions to manipulate array variables and perform assignments */
64 /* **************************************************************** */
66 /* Convert a shell variable to an array variable. The original value is
69 convert_var_to_array (var
)
75 oldval
= value_cell (var
);
76 array
= array_create ();
78 array_insert (array
, 0, oldval
);
80 FREE (value_cell (var
));
81 var_setarray (var
, array
);
83 /* these aren't valid anymore */
84 var
->dynamic_value
= (sh_var_value_func_t
*)NULL
;
85 var
->assign_func
= (sh_var_assign_func_t
*)NULL
;
87 INVALIDATE_EXPORTSTR (var
);
91 VSETATTR (var
, att_array
);
92 VUNSETATTR (var
, att_invisible
);
94 /* Make sure it's not marked as an associative array any more */
95 VUNSETATTR (var
, att_assoc
);
97 /* Since namerefs can't be array variables, turn off nameref attribute */
98 VUNSETATTR (var
, att_nameref
);
103 /* Convert a shell variable to an array variable. The original value is
104 saved as array[0]. */
106 convert_var_to_assoc (var
)
112 oldval
= value_cell (var
);
113 hash
= assoc_create (0);
115 assoc_insert (hash
, savestring ("0"), oldval
);
117 FREE (value_cell (var
));
118 var_setassoc (var
, hash
);
120 /* these aren't valid anymore */
121 var
->dynamic_value
= (sh_var_value_func_t
*)NULL
;
122 var
->assign_func
= (sh_var_assign_func_t
*)NULL
;
124 INVALIDATE_EXPORTSTR (var
);
125 if (exported_p (var
))
126 array_needs_making
++;
128 VSETATTR (var
, att_assoc
);
129 VUNSETATTR (var
, att_invisible
);
131 /* Make sure it's not marked as an indexed array any more */
132 VUNSETATTR (var
, att_array
);
134 /* Since namerefs can't be array variables, turn off nameref attribute */
135 VUNSETATTR (var
, att_nameref
);
141 make_array_variable_value (entry
, ind
, key
, value
, flags
)
151 /* If we're appending, we need the old value of the array reference, so
152 fake out make_variable_value with a dummy SHELL_VAR */
153 if (flags
& ASS_APPEND
)
155 dentry
= (SHELL_VAR
*)xmalloc (sizeof (SHELL_VAR
));
156 dentry
->name
= savestring (entry
->name
);
158 newval
= assoc_reference (assoc_cell (entry
), key
);
160 newval
= array_reference (array_cell (entry
), ind
);
162 dentry
->value
= savestring (newval
);
165 dentry
->value
= (char *)xmalloc (1);
166 dentry
->value
[0] = '\0';
168 dentry
->exportstr
= 0;
169 dentry
->attributes
= entry
->attributes
& ~(att_array
|att_assoc
|att_exported
);
170 /* Leave the rest of the members uninitialized; the code doesn't look
172 newval
= make_variable_value (dentry
, value
, flags
);
173 dispose_variable (dentry
);
176 newval
= make_variable_value (entry
, value
, flags
);
182 bind_array_var_internal (entry
, ind
, key
, value
, flags
)
191 newval
= make_array_variable_value (entry
, ind
, key
, value
, flags
);
193 if (entry
->assign_func
)
194 (*entry
->assign_func
) (entry
, newval
, ind
, key
);
195 else if (assoc_p (entry
))
196 assoc_insert (assoc_cell (entry
), key
, newval
);
198 array_insert (array_cell (entry
), ind
, newval
);
201 VUNSETATTR (entry
, att_invisible
); /* no longer invisible */
203 /* check mark_modified_variables if we ever want to export array vars */
207 /* Perform an array assignment name[ind]=value. If NAME already exists and
208 is not an array, and IND is 0, perform name=value instead. If NAME exists
209 and is not an array, and IND is not 0, convert it into an array with the
210 existing value as name[0].
212 If NAME does not exist, just create an array variable, no matter what
213 IND's value may be. */
215 bind_array_variable (name
, ind
, value
, flags
)
223 entry
= find_shell_variable (name
);
225 if (entry
== (SHELL_VAR
*) 0)
227 /* Is NAME a nameref variable that points to an unset variable? */
228 entry
= find_variable_nameref_for_create (name
, 0);
229 if (entry
== INVALID_NAMEREF_VALUE
)
230 return ((SHELL_VAR
*)0);
231 if (entry
&& nameref_p (entry
))
232 entry
= make_new_array_variable (nameref_cell (entry
));
234 if (entry
== (SHELL_VAR
*) 0)
235 entry
= make_new_array_variable (name
);
236 else if ((readonly_p (entry
) && (flags
&ASS_FORCE
) == 0) || noassign_p (entry
))
238 if (readonly_p (entry
))
242 else if (array_p (entry
) == 0)
243 entry
= convert_var_to_array (entry
);
245 /* ENTRY is an array variable, and ARRAY points to the value. */
246 return (bind_array_var_internal (entry
, ind
, 0, value
, flags
));
250 bind_array_element (entry
, ind
, value
, flags
)
256 return (bind_array_var_internal (entry
, ind
, 0, value
, flags
));
260 bind_assoc_variable (entry
, name
, key
, value
, flags
)
267 if ((readonly_p (entry
) && (flags
&ASS_FORCE
) == 0) || noassign_p (entry
))
269 if (readonly_p (entry
))
274 return (bind_array_var_internal (entry
, 0, key
, value
, flags
));
277 /* Parse NAME, a lhs of an assignment statement of the form v[s], and
278 assign VALUE to that array element by calling bind_array_variable().
279 Flags are ASS_ assignment flags */
281 assign_array_element (name
, value
, flags
)
289 vname
= array_variable_name (name
, (flags
& ASS_NOEXPAND
) != 0, &sub
, &sublen
);
292 return ((SHELL_VAR
*)NULL
);
294 if ((ALL_ELEMENT_SUB (sub
[0]) && sub
[1] == ']') || (sublen
<= 1))
297 err_badarraysub (name
);
298 return ((SHELL_VAR
*)NULL
);
301 entry
= find_variable (vname
);
302 entry
= assign_array_element_internal (entry
, name
, vname
, sub
, sublen
, value
, flags
);
309 assign_array_element_internal (entry
, name
, vname
, sub
, sublen
, value
, flags
)
311 char *name
; /* only used for error messages */
321 if (entry
&& assoc_p (entry
))
323 sub
[sublen
-1] = '\0';
324 if ((flags
& ASS_NOEXPAND
) == 0)
325 akey
= expand_assignment_string_to_string (sub
, 0); /* [ */
327 akey
= savestring (sub
);
329 if (akey
== 0 || *akey
== 0)
331 err_badarraysub (name
);
333 return ((SHELL_VAR
*)NULL
);
335 entry
= bind_assoc_variable (entry
, vname
, akey
, value
, flags
);
339 ind
= array_expand_index (entry
, sub
, sublen
, 0);
340 /* negative subscripts to indexed arrays count back from end */
341 if (entry
&& ind
< 0)
342 ind
= (array_p (entry
) ? array_max_index (array_cell (entry
)) : 0) + 1 + ind
;
345 err_badarraysub (name
);
346 return ((SHELL_VAR
*)NULL
);
348 entry
= bind_array_variable (vname
, ind
, value
, flags
);
354 /* Find the array variable corresponding to NAME. If there is no variable,
355 create a new array variable. If the variable exists but is not an array,
356 convert it to an indexed array. If FLAGS&1 is non-zero, an existing
357 variable is checked for the readonly or noassign attribute in preparation
358 for assignment (e.g., by the `read' builtin). If FLAGS&2 is non-zero, we
359 create an associative array. */
361 find_or_make_array_variable (name
, flags
)
367 var
= find_variable (name
);
370 /* See if we have a nameref pointing to a variable that hasn't been
372 var
= find_variable_last_nameref (name
, 1);
373 if (var
&& nameref_p (var
) && invisible_p (var
))
375 internal_warning (_("%s: removing nameref attribute"), name
);
376 VUNSETATTR (var
, att_nameref
);
378 if (var
&& nameref_p (var
))
380 if (valid_nameref_value (nameref_cell (var
), 2) == 0)
382 sh_invalidid (nameref_cell (var
));
383 return ((SHELL_VAR
*)NULL
);
385 var
= (flags
& 2) ? make_new_assoc_variable (nameref_cell (var
)) : make_new_array_variable (nameref_cell (var
));
390 var
= (flags
& 2) ? make_new_assoc_variable (name
) : make_new_array_variable (name
);
391 else if ((flags
& 1) && (readonly_p (var
) || noassign_p (var
)))
393 if (readonly_p (var
))
395 return ((SHELL_VAR
*)NULL
);
397 else if ((flags
& 2) && array_p (var
))
399 last_command_exit_value
= 1;
400 report_error (_("%s: cannot convert indexed to associative array"), name
);
401 return ((SHELL_VAR
*)NULL
);
403 else if (array_p (var
) == 0 && assoc_p (var
) == 0)
404 var
= convert_var_to_array (var
);
409 /* Perform a compound assignment statement for array NAME, where VALUE is
410 the text between the parens: NAME=( VALUE ) */
412 assign_array_from_string (name
, value
, flags
)
420 if (flags
& ASS_MKASSOC
)
423 var
= find_or_make_array_variable (name
, vflags
);
425 return ((SHELL_VAR
*)NULL
);
427 return (assign_array_var_from_string (var
, value
, flags
));
430 /* Sequentially assign the indices of indexed array variable VAR from the
433 assign_array_var_from_word_list (var
, list
, flags
)
438 register arrayind_t i
;
439 register WORD_LIST
*l
;
442 a
= array_cell (var
);
443 i
= (flags
& ASS_APPEND
) ? array_max_index (a
) + 1 : 0;
445 for (l
= list
; l
; l
= l
->next
, i
++)
446 bind_array_var_internal (var
, i
, 0, l
->word
->word
, flags
& ~ASS_APPEND
);
448 VUNSETATTR (var
, att_invisible
); /* no longer invisible */
454 expand_compound_array_assignment (var
, value
, flags
)
459 WORD_LIST
*list
, *nlist
;
463 /* This condition is true when invoked from the declare builtin with a
465 declare -a d='([1]="" [2]="bdef" [5]="hello world" "test")' */
466 if (*value
== '(') /*)*/
469 val
= extract_array_assignment_list (value
, &ni
);
471 return (WORD_LIST
*)NULL
;
476 /* Expand the value string into a list of words, performing all the
477 shell expansions including pathname generation and word splitting. */
478 /* First we split the string on whitespace, using the shell parser
479 (ksh93 seems to do this). */
480 list
= parse_string_to_word_list (val
, 1, "array assign");
482 if (var
&& assoc_p (var
))
489 /* If we're using [subscript]=value, we need to quote each [ and ] to
490 prevent unwanted filename expansion. This doesn't need to be done
491 for associative array expansion, since that uses a different expansion
492 function (see assign_compound_array_list below). */
494 quote_array_assignment_chars (list
);
496 /* Now that we've split it, perform the shell expansions on each
498 nlist
= list
? expand_words_no_vars (list
) : (WORD_LIST
*)NULL
;
500 dispose_words (list
);
508 /* Callers ensure that VAR is not NULL */
510 assign_compound_array_list (var
, nlist
, flags
)
518 char *w
, *val
, *nval
, *savecmd
;
519 int len
, iflags
, free_val
;
520 arrayind_t ind
, last_ind
;
523 a
= (var
&& array_p (var
)) ? array_cell (var
) : (ARRAY
*)0;
524 h
= (var
&& assoc_p (var
)) ? assoc_cell (var
) : (HASH_TABLE
*)0;
529 /* Now that we are ready to assign values to the array, kill the existing
531 if ((flags
& ASS_APPEND
) == 0)
533 if (a
&& array_p (var
))
535 else if (h
&& assoc_p (var
))
539 last_ind
= (a
&& (flags
& ASS_APPEND
)) ? array_max_index (a
) + 1 : 0;
541 for (list
= nlist
; list
; list
= list
->next
)
543 /* Don't allow var+=(values) to make assignments in VALUES append to
544 existing values by default. */
545 iflags
= flags
& ~ASS_APPEND
;
546 w
= list
->word
->word
;
548 /* We have a word of the form [ind]=value */
549 if ((list
->word
->flags
& W_ASSIGNMENT
) && w
[0] == '[')
551 /* Don't have to handle embedded quotes specially any more, since
552 associative array subscripts have not been expanded yet (see
554 len
= skipsubscript (w
, 0, 0);
556 /* XXX - changes for `+=' */
557 if (w
[len
] != ']' || (w
[len
+1] != '=' && (w
[len
+1] != '+' || w
[len
+2] != '=')))
564 nval
= make_variable_value (var
, w
, flags
);
565 if (var
->assign_func
)
566 (*var
->assign_func
) (var
, nval
, last_ind
, 0);
568 array_insert (a
, last_ind
, nval
);
580 if (ALL_ELEMENT_SUB (w
[1]) && len
== 2)
582 last_command_exit_value
= 1;
584 report_error (_("%s: invalid associative array key"), w
);
586 report_error (_("%s: cannot assign to non-numeric index"), w
);
592 ind
= array_expand_index (var
, w
+ 1, len
, 0);
593 /* negative subscripts to indexed arrays count back from end */
595 ind
= array_max_index (array_cell (var
)) + 1 + ind
;
604 else if (assoc_p (var
))
606 /* This is not performed above, see expand_compound_array_assignment */
608 akey
= expand_assignment_string_to_string (w
+1, 0);
610 /* And we need to expand the value also, see below */
611 if (akey
== 0 || *akey
== 0)
619 /* XXX - changes for `+=' -- just accept the syntax. ksh93 doesn't do this */
620 if (w
[len
+ 1] == '+' && w
[len
+ 2] == '=')
622 iflags
|= ASS_APPEND
;
628 else if (assoc_p (var
))
630 last_command_exit_value
= 1;
631 report_error (_("%s: %s: must use subscript when assigning associative array"), var
->name
, w
);
634 else /* No [ind]=value, just a stray `=' */
641 /* See above; we need to expand the value here */
644 val
= expand_assignment_string_to_string (val
, 0);
647 val
= (char *)xmalloc (1);
648 val
[0] = '\0'; /* like do_assignment_internal */
653 savecmd
= this_command_name
;
655 this_command_name
= (char *)NULL
; /* no command name for errors */
656 bind_array_var_internal (var
, ind
, akey
, val
, iflags
);
658 this_command_name
= savecmd
;
665 /* Perform a compound array assignment: VAR->name=( VALUE ). The
666 VALUE has already had the parentheses stripped. */
668 assign_array_var_from_string (var
, value
, flags
)
678 nlist
= expand_compound_array_assignment (var
, value
, flags
);
679 assign_compound_array_list (var
, nlist
, flags
);
682 dispose_words (nlist
);
685 VUNSETATTR (var
, att_invisible
); /* no longer invisible */
690 /* Quote globbing chars and characters in $IFS before the `=' in an assignment
691 statement (usually a compound array assignment) to protect them from
692 unwanted filename expansion or word splitting. */
694 quote_assign (string
)
699 char *temp
, *t
, *subs
;
700 const char *s
, *send
;
704 slen
= strlen (string
);
705 send
= string
+ slen
;
707 t
= temp
= (char *)xmalloc (slen
* 2 + 1);
709 for (s
= string
; *s
; )
713 if (saw_eq
== 0 && *s
== '[') /* looks like a subscript */
716 se
= skipsubscript (string
, ss
, 0);
717 subs
= substring (s
, ss
, se
);
727 if (saw_eq
== 0 && (glob_char_p (s
) || isifs (*s
)))
730 COPY_CHAR_P (t
, s
, send
);
736 /* For each word in a compound array assignment, if the word looks like
737 [ind]=value, quote globbing chars and characters in $IFS before the `='. */
739 quote_array_assignment_chars (list
)
745 for (l
= list
; l
; l
= l
->next
)
747 if (l
->word
== 0 || l
->word
->word
== 0 || l
->word
->word
[0] == '\0')
748 continue; /* should not happen, but just in case... */
749 /* Don't bother if it hasn't been recognized as an assignment or
750 doesn't look like [ind]=value */
751 if ((l
->word
->flags
& W_ASSIGNMENT
) == 0)
753 if (l
->word
->word
[0] != '[' || mbschr (l
->word
->word
, '=') == 0) /* ] */
756 nword
= quote_assign (l
->word
->word
);
757 free (l
->word
->word
);
758 l
->word
->word
= nword
;
759 l
->word
->flags
|= W_NOGLOB
; /* XXX - W_NOSPLIT also? */
763 /* skipsubscript moved to subst.c to use private functions. 2009/02/24. */
765 /* This function is called with SUB pointing to just after the beginning
766 `[' of an array subscript and removes the array element to which SUB
767 expands from array VAR. A subscript of `*' or `@' unsets the array. */
768 /* If FLAGS&1 we don't expand the subscript; we just use it as-is. */
770 unbind_array_element (var
, sub
, flags
)
780 len
= skipsubscript (sub
, 0, (flags
&1) || (var
&& assoc_p(var
)));
781 if (sub
[len
] != ']' || len
== 0)
783 builtin_error ("%s[%s: %s", var
->name
, sub
, _(bash_badsub_errmsg
));
788 if (ALL_ELEMENT_SUB (sub
[0]) && sub
[1] == 0)
790 if (array_p (var
) || assoc_p (var
))
792 unbind_variable (var
->name
); /* XXX -- {array,assoc}_flush ? */
796 return -2; /* don't allow this to unset scalar variables */
801 akey
= (flags
& 1) ? sub
: expand_assignment_string_to_string (sub
, 0);
802 if (akey
== 0 || *akey
== 0)
804 builtin_error ("[%s]: %s", sub
, _(bash_badsub_errmsg
));
808 assoc_remove (assoc_cell (var
), akey
);
812 else if (array_p (var
))
814 ind
= array_expand_index (var
, sub
, len
+1, 0);
815 /* negative subscripts to indexed arrays count back from end */
817 ind
= array_max_index (array_cell (var
)) + 1 + ind
;
820 builtin_error ("[%s]: %s", sub
, _(bash_badsub_errmsg
));
823 ae
= array_remove (array_cell (var
), ind
);
825 array_dispose_element (ae
);
827 else /* array_p (var) == 0 && assoc_p (var) == 0 */
829 akey
= this_command_name
;
830 ind
= array_expand_index (var
, sub
, len
+1, 0);
831 this_command_name
= akey
;
834 unbind_variable (var
->name
);
838 return -2; /* any subscript other than 0 is invalid with scalar variables */
844 /* Format and output an array assignment in compound form VAR=(VALUES),
845 suitable for re-use as input. */
847 print_array_assignment (var
, quoted
)
853 vstr
= array_to_assign (array_cell (var
), quoted
);
856 printf ("%s=%s\n", var
->name
, quoted
? "'()'" : "()");
859 printf ("%s=%s\n", var
->name
, vstr
);
864 /* Format and output an associative array assignment in compound form
865 VAR=(VALUES), suitable for re-use as input. */
867 print_assoc_assignment (var
, quoted
)
873 vstr
= assoc_to_assign (assoc_cell (var
), quoted
);
876 printf ("%s=%s\n", var
->name
, quoted
? "'()'" : "()");
879 printf ("%s=%s\n", var
->name
, vstr
);
884 /***********************************************************************/
886 /* Utility functions to manage arrays and their contents for expansion */
888 /***********************************************************************/
890 /* Return 1 if NAME is a properly-formed array reference v[sub]. */
892 valid_array_reference (name
, flags
)
899 t
= mbschr (name
, '['); /* ] */
903 r
= legal_identifier (name
);
907 /* Check for a properly-terminated non-null subscript. */
908 len
= skipsubscript (t
, 0, flags
);
909 if (t
[len
] != ']' || len
== 1)
911 if (t
[len
+1] != '\0')
914 /* Could check and allow subscripts consisting only of whitespace for
915 existing associative arrays. */
916 for (r
= 1; r
< len
; r
++)
917 if (whitespace (t
[r
]) == 0)
921 /* This allows blank subscripts */
928 /* Expand the array index beginning at S and extending LEN characters. */
930 array_expand_index (var
, s
, len
, flags
)
936 char *exp
, *t
, *savecmd
;
940 exp
= (char *)xmalloc (len
);
941 strncpy (exp
, s
, len
- 1);
943 #if 0 /* XXX - not yet -- maybe bash-5.0 */
944 if ((flags
& AV_NOEXPAND
) == 0)
945 t
= expand_arith_string (exp
, Q_DOUBLE_QUOTES
|Q_ARITH
|Q_ARRAYSUB
); /* XXX - Q_ARRAYSUB for future use */
949 t
= expand_arith_string (exp
, Q_DOUBLE_QUOTES
|Q_ARITH
|Q_ARRAYSUB
); /* XXX - Q_ARRAYSUB for future use */
950 savecmd
= this_command_name
;
951 this_command_name
= (char *)NULL
;
952 val
= evalexp (t
, 0, &expok
);
953 this_command_name
= savecmd
;
959 last_command_exit_value
= EXECUTION_FAILURE
;
961 if (no_longjmp_on_fatal_error
)
963 top_level_cleanup ();
964 jump_to_top_level (DISCARD
);
969 /* Return the name of the variable specified by S without any subscript.
970 If SUBP is non-null, return a pointer to the start of the subscript
971 in *SUBP. If LENP is non-null, the length of the subscript is returned
972 in *LENP. This returns newly-allocated memory. */
974 array_variable_name (s
, flags
, subp
, lenp
)
990 return ((char *)NULL
);
993 ni
= skipsubscript (s
, ind
, flags
); /* XXX - was 0 not flags */
994 if (ni
<= ind
+ 1 || s
[ni
] != ']')
1001 return ((char *)NULL
);
1005 ret
= savestring (s
);
1016 /* Return the variable specified by S without any subscript. If SUBP is
1017 non-null, return a pointer to the start of the subscript in *SUBP.
1018 If LENP is non-null, the length of the subscript is returned in *LENP. */
1020 array_variable_part (s
, flags
, subp
, lenp
)
1029 t
= array_variable_name (s
, flags
, subp
, lenp
);
1031 return ((SHELL_VAR
*)NULL
);
1032 var
= find_variable (t
); /* XXX - handle namerefs here? */
1035 return var
; /* now return invisible variables; caller must handle */
1038 #define INDEX_ERROR() \
1042 err_badarraysub (var->name); \
1046 err_badarraysub (s); \
1047 t[-1] = '['; /* ] */\
1049 return ((char *)NULL); \
1053 /* Return a string containing the elements in the array and subscript
1054 described by S. If the subscript is * or @, obeys quoting rules akin
1055 to the expansion of $* and $@ including double quoting. If RTYPE
1056 is non-null it gets 1 if the array reference is name[*], 2 if the
1057 reference is name[@], and 0 otherwise. */
1059 array_value_internal (s
, quoted
, flags
, rtype
, indp
)
1061 int quoted
, flags
, *rtype
;
1067 char *retval
, *t
, *temp
;
1071 var
= array_variable_part (s
, (flags
&AV_NOEXPAND
) ? 1 : 0, &t
, &len
); /* XXX */
1073 /* Expand the index, even if the variable doesn't exist, in case side
1074 effects are needed, like ${w[i++]} where w is unset. */
1077 return (char *)NULL
;
1081 return ((char *)NULL
); /* error message already printed */
1085 if (ALL_ELEMENT_SUB (t
[0]) && t
[1] == ']')
1088 *rtype
= (t
[0] == '*') ? 1 : 2;
1089 if ((flags
& AV_ALLOWALL
) == 0)
1091 err_badarraysub (s
);
1092 return ((char *)NULL
);
1094 else if (var
== 0 || value_cell (var
) == 0) /* XXX - check for invisible_p(var) ? */
1095 return ((char *)NULL
);
1096 else if (array_p (var
) == 0 && assoc_p (var
) == 0)
1097 l
= add_string_to_list (value_cell (var
), (WORD_LIST
*)NULL
);
1098 else if (assoc_p (var
))
1100 l
= assoc_to_word_list (assoc_cell (var
));
1101 if (l
== (WORD_LIST
*)NULL
)
1102 return ((char *)NULL
);
1106 l
= array_to_word_list (array_cell (var
));
1107 if (l
== (WORD_LIST
*)NULL
)
1108 return ((char *) NULL
);
1111 /* Caller of array_value takes care of inspecting rtype and duplicating
1112 retval if rtype == 0, so this is not a memory leak */
1113 if (t
[0] == '*' && (quoted
& (Q_HERE_DOCUMENT
|Q_DOUBLE_QUOTES
)))
1115 temp
= string_list_dollar_star (l
, quoted
, (flags
& AV_ASSIGNRHS
) ? PF_ASSIGNRHS
: 0);
1116 retval
= quote_string (temp
);
1119 else /* ${name[@]} or unquoted ${name[*]} */
1120 /* XXX - bash-4.4/bash-5.0 test AV_ASSIGNRHS and pass PF_ASSIGNRHS */
1121 retval
= string_list_dollar_at (l
, quoted
, (flags
& AV_ASSIGNRHS
) ? PF_ASSIGNRHS
: 0);
1129 if (var
== 0 || array_p (var
) || assoc_p (var
) == 0)
1131 if ((flags
& AV_USEIND
) == 0 || indp
== 0)
1133 ind
= array_expand_index (var
, t
, len
, flags
);
1136 /* negative subscripts to indexed arrays count back from end */
1137 if (var
&& array_p (var
))
1138 ind
= array_max_index (array_cell (var
)) + 1 + ind
;
1148 else if (assoc_p (var
))
1151 if ((flags
& AV_NOEXPAND
) == 0)
1152 akey
= expand_assignment_string_to_string (t
, 0); /* [ */
1154 akey
= savestring (t
);
1156 if (akey
== 0 || *akey
== 0)
1163 if (var
== 0 || value_cell (var
) == 0) /* XXX - check invisible_p(var) ? */
1166 return ((char *)NULL
);
1168 if (array_p (var
) == 0 && assoc_p (var
) == 0)
1169 return (ind
== 0 ? value_cell (var
) : (char *)NULL
);
1170 else if (assoc_p (var
))
1172 retval
= assoc_reference (assoc_cell (var
), akey
);
1176 retval
= array_reference (array_cell (var
), ind
);
1182 /* Return a string containing the elements described by the array and
1183 subscript contained in S, obeying quoting for subscripts * and @. */
1185 array_value (s
, quoted
, flags
, rtype
, indp
)
1187 int quoted
, flags
, *rtype
;
1190 return (array_value_internal (s
, quoted
, flags
|AV_ALLOWALL
, rtype
, indp
));
1193 /* Return the value of the array indexing expression S as a single string.
1194 If (FLAGS & AV_ALLOWALL) is 0, do not allow `@' and `*' subscripts. This
1195 is used by other parts of the shell such as the arithmetic expression
1196 evaluator in expr.c. */
1198 get_array_value (s
, flags
, rtype
, indp
)
1203 return (array_value_internal (s
, 0, flags
, rtype
, indp
));
1207 array_keys (s
, quoted
)
1212 char *retval
, *t
, *temp
;
1216 var
= array_variable_part (s
, 0, &t
, &len
);
1219 if (var
== 0 || ALL_ELEMENT_SUB (t
[0]) == 0 || t
[1] != ']')
1220 return (char *)NULL
;
1222 if (var_isset (var
) == 0 || invisible_p (var
))
1223 return (char *)NULL
;
1225 if (array_p (var
) == 0 && assoc_p (var
) == 0)
1226 l
= add_string_to_list ("0", (WORD_LIST
*)NULL
);
1227 else if (assoc_p (var
))
1228 l
= assoc_keys_to_word_list (assoc_cell (var
));
1230 l
= array_keys_to_word_list (array_cell (var
));
1231 if (l
== (WORD_LIST
*)NULL
)
1232 return ((char *) NULL
);
1234 if (t
[0] == '*' && (quoted
& (Q_HERE_DOCUMENT
|Q_DOUBLE_QUOTES
)))
1236 temp
= string_list_dollar_star (l
, quoted
, 0);
1237 retval
= quote_string (temp
);
1240 else /* ${!name[@]} or unquoted ${!name[*]} */
1241 retval
= string_list_dollar_at (l
, quoted
, 0);
1246 #endif /* ARRAY_VARS */