blob: 26f4879af3d48149d6c74a3895fd6648dccb1311 [file] [log] [blame]
Jari Aaltof73dda02001-11-13 17:56:06 +00001/* arrayfunc.h -- declarations for miscellaneous array functions in arrayfunc.c */
2
Chet Ramey495aee42011-11-22 19:11:26 -05003/* Copyright (C) 2001-2010 Free Software Foundation, Inc.
Jari Aaltof73dda02001-11-13 17:56:06 +00004
5 This file is part of GNU Bash, the Bourne Again SHell.
6
Jari Aalto31859422009-01-12 13:36:28 +00007 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 +000011
Jari Aalto31859422009-01-12 13:36:28 +000012 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 +000016
17 You should have received a copy of the GNU General Public License
Jari Aalto31859422009-01-12 13:36:28 +000018 along with Bash. If not, see <http://www.gnu.org/licenses/>.
19*/
Jari Aaltof73dda02001-11-13 17:56:06 +000020
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 Ramey495aee42011-11-22 19:11:26 -050028/* 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
32
Jari Aaltof73dda02001-11-13 17:56:06 +000033extern SHELL_VAR *convert_var_to_array __P((SHELL_VAR *));
Jari Aalto31859422009-01-12 13:36:28 +000034extern SHELL_VAR *convert_var_to_assoc __P((SHELL_VAR *));
Jari Aaltof73dda02001-11-13 17:56:06 +000035
Chet Rameyac50fba2014-02-26 09:36:43 -050036extern char *make_array_variable_value __P((SHELL_VAR *, arrayind_t, char *, char *, int));
37
Jari Aalto95732b42005-12-07 14:08:12 +000038extern SHELL_VAR *bind_array_variable __P((char *, arrayind_t, char *, int));
Jari Aalto31859422009-01-12 13:36:28 +000039extern SHELL_VAR *bind_array_element __P((SHELL_VAR *, arrayind_t, char *, int));
Jari Aalto95732b42005-12-07 14:08:12 +000040extern SHELL_VAR *assign_array_element __P((char *, char *, int));
Jari Aaltof73dda02001-11-13 17:56:06 +000041
Chet Ramey00018032011-11-21 20:51:19 -050042extern SHELL_VAR *bind_assoc_variable __P((SHELL_VAR *, char *, char *, char *, int));
43
Jari Aaltof73dda02001-11-13 17:56:06 +000044extern SHELL_VAR *find_or_make_array_variable __P((char *, int));
45
Jari Aalto95732b42005-12-07 14:08:12 +000046extern SHELL_VAR *assign_array_from_string __P((char *, char *, int));
47extern SHELL_VAR *assign_array_var_from_word_list __P((SHELL_VAR *, WORD_LIST *, int));
Jari Aalto06285672006-10-10 14:15:34 +000048
Jari Aalto31859422009-01-12 13:36:28 +000049extern WORD_LIST *expand_compound_array_assignment __P((SHELL_VAR *, char *, int));
Jari Aalto06285672006-10-10 14:15:34 +000050extern void assign_compound_array_list __P((SHELL_VAR *, WORD_LIST *, int));
Jari Aalto95732b42005-12-07 14:08:12 +000051extern SHELL_VAR *assign_array_var_from_string __P((SHELL_VAR *, char *, int));
Jari Aaltof73dda02001-11-13 17:56:06 +000052
53extern int unbind_array_element __P((SHELL_VAR *, char *));
Chet Ramey00018032011-11-21 20:51:19 -050054extern int skipsubscript __P((const char *, int, int));
Jari Aalto31859422009-01-12 13:36:28 +000055
Jari Aaltof73dda02001-11-13 17:56:06 +000056extern void print_array_assignment __P((SHELL_VAR *, int));
Jari Aalto31859422009-01-12 13:36:28 +000057extern void print_assoc_assignment __P((SHELL_VAR *, int));
Jari Aaltof73dda02001-11-13 17:56:06 +000058
Chet Rameyac50fba2014-02-26 09:36:43 -050059extern arrayind_t array_expand_index __P((SHELL_VAR *, char *, int));
Jari Aaltof73dda02001-11-13 17:56:06 +000060extern int valid_array_reference __P((char *));
Chet Ramey495aee42011-11-22 19:11:26 -050061extern char *array_value __P((char *, int, int, int *, arrayind_t *));
62extern char *get_array_value __P((char *, int, int *, arrayind_t *));
Jari Aaltof73dda02001-11-13 17:56:06 +000063
Jari Aaltob80f6442004-07-27 13:29:18 +000064extern char *array_keys __P((char *, int));
65
Jari Aaltof73dda02001-11-13 17:56:06 +000066extern char *array_variable_name __P((char *, char **, int *));
67extern SHELL_VAR *array_variable_part __P((char *, char **, int *));
68
Chet Rameyac50fba2014-02-26 09:36:43 -050069#else
70
71#define AV_ALLOWALL 0
72#define AV_QUOTED 0
73#define AV_USEIND 0
74
Jari Aaltof73dda02001-11-13 17:56:06 +000075#endif
76
77#endif /* !_ARRAYFUNC_H_ */