]> git.ipfire.org Git - thirdparty/bash.git/blame - arrayfunc.h
bash-4.4-rc2 release
[thirdparty/bash.git] / arrayfunc.h
CommitLineData
f73dda09
JA
1/* arrayfunc.h -- declarations for miscellaneous array functions in arrayfunc.c */
2
6faad625 3/* Copyright (C) 2001-2010 Free Software Foundation, Inc.
f73dda09
JA
4
5 This file is part of GNU Bash, the Bourne Again SHell.
6
2e4498b3
CR
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.
f73dda09 11
2e4498b3
CR
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.
f73dda09
JA
16
17 You should have received a copy of the GNU General Public License
2e4498b3
CR
18 along with Bash. If not, see <http://www.gnu.org/licenses/>.
19*/
f73dda09
JA
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
5f8cde23
CR
28/* Flags for array_value_internal and callers array_value/get_array_value */
29#define AV_ALLOWALL 0x001
30#define AV_QUOTED 0x002
31#define AV_USEIND 0x004
06c3a575 32#define AV_USEVAL 0x008 /* XXX - should move this */
95554387 33#define AV_ASSIGNRHS 0x010 /* no splitting, special case ${a[@]} */
5f8cde23 34
f73dda09 35extern SHELL_VAR *convert_var_to_array __P((SHELL_VAR *));
fdf670ea 36extern SHELL_VAR *convert_var_to_assoc __P((SHELL_VAR *));
f73dda09 37
861a1900
CR
38extern char *make_array_variable_value __P((SHELL_VAR *, arrayind_t, char *, char *, int));
39
d11b8b46 40extern SHELL_VAR *bind_array_variable __P((char *, arrayind_t, char *, int));
6a8fd0ed 41extern SHELL_VAR *bind_array_element __P((SHELL_VAR *, arrayind_t, char *, int));
d11b8b46 42extern SHELL_VAR *assign_array_element __P((char *, char *, int));
f73dda09 43
a3143574
CR
44extern SHELL_VAR *bind_assoc_variable __P((SHELL_VAR *, char *, char *, char *, int));
45
f73dda09
JA
46extern SHELL_VAR *find_or_make_array_variable __P((char *, int));
47
d11b8b46
CR
48extern SHELL_VAR *assign_array_from_string __P((char *, char *, int));
49extern SHELL_VAR *assign_array_var_from_word_list __P((SHELL_VAR *, WORD_LIST *, int));
d3ad40de 50
fdf670ea 51extern WORD_LIST *expand_compound_array_assignment __P((SHELL_VAR *, char *, int));
d3ad40de 52extern void assign_compound_array_list __P((SHELL_VAR *, WORD_LIST *, int));
d11b8b46 53extern SHELL_VAR *assign_array_var_from_string __P((SHELL_VAR *, char *, int));
f73dda09
JA
54
55extern int unbind_array_element __P((SHELL_VAR *, char *));
3eb2d94a 56extern int skipsubscript __P((const char *, int, int));
fdf670ea 57
f73dda09 58extern void print_array_assignment __P((SHELL_VAR *, int));
fdf670ea 59extern void print_assoc_assignment __P((SHELL_VAR *, int));
f73dda09 60
d9e1f41e 61extern arrayind_t array_expand_index __P((SHELL_VAR *, char *, int));
2171061f 62extern int valid_array_reference __P((char *, int));
5f8cde23 63extern char *array_value __P((char *, int, int, int *, arrayind_t *));
68dfe178 64extern char *get_array_value __P((char *, int, int *, arrayind_t *));
f73dda09 65
d3a24ed2
CR
66extern char *array_keys __P((char *, int));
67
f73dda09
JA
68extern char *array_variable_name __P((char *, char **, int *));
69extern SHELL_VAR *array_variable_part __P((char *, char **, int *));
70
c31d56a7
CR
71#else
72
73#define AV_ALLOWALL 0
74#define AV_QUOTED 0
75#define AV_USEIND 0
95554387 76#define AV_ASSIGNRHS 0
c31d56a7 77
f73dda09
JA
78#endif
79
80#endif /* !_ARRAYFUNC_H_ */