Gitiles
Code Review Sign In
gerrit.witaqua.org / external_bash / d233b485e83c3a784b803fb894280773f16f2deb / . / arrayfunc.h
blob: cd51ee073c0cc59b44d9f8e98863efe11baeb3c8 [file] [log] [blame]
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]1/* arrayfunc.h -- declarations for miscellaneous array functions in arrayfunc.c */
2
Chet Ramey495aee42011-11-22 19:11:26 -0500[diff] [blame]3/* Copyright (C) 2001-2010 Free Software Foundation, Inc.
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]4
5 This file is part of GNU Bash, the Bourne Again SHell.
6
Jari Aalto31859422009-01-12 13:36:28 +0000[diff] [blame]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.
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]11
Jari Aalto31859422009-01-12 13:36:28 +0000[diff] [blame]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.
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]16
17 You should have received a copy of the GNU General Public License
Jari Aalto31859422009-01-12 13:36:28 +0000[diff] [blame]18 along with Bash. If not, see <http://www.gnu.org/licenses/>.
19*/
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]20
21#if !defined (_ARRAYFUNC_H_)
22#define _ARRAYFUNC_H_
23
24/* Must include variables.h before including this file. */
25
26#if defined (ARRAY_VARS)
27
Chet Rameyd233b482019-01-07 09:27:52 -0500[diff] [blame^]28/* This variable means to not expand associative array subscripts more than
29 once, when performing variable expansion. */
30extern int assoc_expand_once;
31
32/* The analog for indexed array subscripts */
33extern int array_expand_once;
34
Chet Ramey495aee42011-11-22 19:11:26 -0500[diff] [blame]35/* Flags for array_value_internal and callers array_value/get_array_value */
36#define AV_ALLOWALL 0x001
37#define AV_QUOTED 0x002
38#define AV_USEIND 0x004
Chet Rameya0c0a002016-09-15 16:59:08 -0400[diff] [blame]39#define AV_USEVAL 0x008 /* XXX - should move this */
40#define AV_ASSIGNRHS 0x010 /* no splitting, special case ${a[@]} */
Chet Rameyd233b482019-01-07 09:27:52 -0500[diff] [blame^]41#define AV_NOEXPAND 0x020 /* don't run assoc subscripts through word expansion */
42
43/* Flags for valid_array_reference. Value 1 is reserved for skipsubscript() */
44#define VA_NOEXPAND 0x001
45#define VA_ONEWORD 0x002
Chet Ramey495aee42011-11-22 19:11:26 -0500[diff] [blame]46
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]47extern SHELL_VAR *convert_var_to_array __P((SHELL_VAR *));
Jari Aalto31859422009-01-12 13:36:28 +0000[diff] [blame]48extern SHELL_VAR *convert_var_to_assoc __P((SHELL_VAR *));
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]49
Chet Rameyac50fba2014-02-26 09:36:43 -0500[diff] [blame]50extern char *make_array_variable_value __P((SHELL_VAR *, arrayind_t, char *, char *, int));
51
Jari Aalto95732b42005-12-07 14:08:12 +0000[diff] [blame]52extern SHELL_VAR *bind_array_variable __P((char *, arrayind_t, char *, int));
Jari Aalto31859422009-01-12 13:36:28 +0000[diff] [blame]53extern SHELL_VAR *bind_array_element __P((SHELL_VAR *, arrayind_t, char *, int));
Jari Aalto95732b42005-12-07 14:08:12 +0000[diff] [blame]54extern SHELL_VAR *assign_array_element __P((char *, char *, int));
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]55
Chet Ramey00018032011-11-21 20:51:19 -0500[diff] [blame]56extern SHELL_VAR *bind_assoc_variable __P((SHELL_VAR *, char *, char *, char *, int));
57
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]58extern SHELL_VAR *find_or_make_array_variable __P((char *, int));
59
Jari Aalto95732b42005-12-07 14:08:12 +0000[diff] [blame]60extern SHELL_VAR *assign_array_from_string __P((char *, char *, int));
61extern SHELL_VAR *assign_array_var_from_word_list __P((SHELL_VAR *, WORD_LIST *, int));
Jari Aalto06285672006-10-10 14:15:34 +0000[diff] [blame]62
Jari Aalto31859422009-01-12 13:36:28 +0000[diff] [blame]63extern WORD_LIST *expand_compound_array_assignment __P((SHELL_VAR *, char *, int));
Jari Aalto06285672006-10-10 14:15:34 +0000[diff] [blame]64extern void assign_compound_array_list __P((SHELL_VAR *, WORD_LIST *, int));
Jari Aalto95732b42005-12-07 14:08:12 +0000[diff] [blame]65extern SHELL_VAR *assign_array_var_from_string __P((SHELL_VAR *, char *, int));
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]66
Chet Rameyd233b482019-01-07 09:27:52 -0500[diff] [blame^]67extern int unbind_array_element __P((SHELL_VAR *, char *, int));
Chet Ramey00018032011-11-21 20:51:19 -0500[diff] [blame]68extern int skipsubscript __P((const char *, int, int));
Jari Aalto31859422009-01-12 13:36:28 +0000[diff] [blame]69
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]70extern void print_array_assignment __P((SHELL_VAR *, int));
Jari Aalto31859422009-01-12 13:36:28 +0000[diff] [blame]71extern void print_assoc_assignment __P((SHELL_VAR *, int));
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]72
Chet Rameyd233b482019-01-07 09:27:52 -0500[diff] [blame^]73extern arrayind_t array_expand_index __P((SHELL_VAR *, char *, int, int));
Chet Rameya0c0a002016-09-15 16:59:08 -0400[diff] [blame]74extern int valid_array_reference __P((const char *, int));
75extern char *array_value __P((const char *, int, int, int *, arrayind_t *));
76extern char *get_array_value __P((const char *, int, int *, arrayind_t *));
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]77
Jari Aaltob80f6442004-07-27 13:29:18 +0000[diff] [blame]78extern char *array_keys __P((char *, int));
79
Chet Rameyd233b482019-01-07 09:27:52 -0500[diff] [blame^]80extern char *array_variable_name __P((const char *, int, char **, int *));
81extern SHELL_VAR *array_variable_part __P((const char *, int, char **, int *));
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]82
Chet Rameyac50fba2014-02-26 09:36:43 -0500[diff] [blame]83#else
84
85#define AV_ALLOWALL 0
86#define AV_QUOTED 0
87#define AV_USEIND 0
Chet Rameya0c0a002016-09-15 16:59:08 -0400[diff] [blame]88#define AV_ASSIGNRHS 0
Chet Rameyac50fba2014-02-26 09:36:43 -0500[diff] [blame]89
Chet Rameyd233b482019-01-07 09:27:52 -0500[diff] [blame^]90#define VA_ONEWORD 0
91
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]92#endif
93
94#endif /* !_ARRAYFUNC_H_ */