src/arrayfunc.h

   1 /* arrayfunc.h -- declarations for miscellaneous array functions in arrayfunc.c */
   2
   3 /* Copyright (C) 2001-2020 Free Software Foundation, Inc.
   4
   5    This file is part of GNU Bush, the Bourne Again SHell.
   6
   7    Bush 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.
  11
  12    Bush 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.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with Bush.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  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
  28 /* This variable means to not expand associative array subscripts more than
  29    once, when performing variable expansion. */
  30 extern int assoc_expand_once;
  31
  32 /* The analog for indexed array subscripts */
  33 extern int array_expand_once;
  34
  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
  39 #define AV_USEVAL       0x008   /* XXX - should move this */
  40 #define AV_ASSIGNRHS    0x010   /* no splitting, special case ${a[@]} */
  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
  46
  47 extern SHELL_VAR *convert_var_to_array PARAMS((SHELL_VAR *));
  48 extern SHELL_VAR *convert_var_to_assoc PARAMS((SHELL_VAR *));
  49
  50 extern char *make_array_variable_value PARAMS((SHELL_VAR *, arrayind_t, char *, char *, int));
  51
  52 extern SHELL_VAR *bind_array_variable PARAMS((char *, arrayind_t, char *, int));
  53 extern SHELL_VAR *bind_array_element PARAMS((SHELL_VAR *, arrayind_t, char *, int));
  54 extern SHELL_VAR *assign_array_element PARAMS((char *, char *, int));
  55
  56 extern SHELL_VAR *bind_assoc_variable PARAMS((SHELL_VAR *, char *, char *, char *, int));
  57
  58 extern SHELL_VAR *find_or_make_array_variable PARAMS((char *, int));
  59
  60 extern SHELL_VAR *assign_array_from_string  PARAMS((char *, char *, int));
  61 extern SHELL_VAR *assign_array_var_from_word_list PARAMS((SHELL_VAR *, WORD_LIST *, int));
  62
  63 extern WORD_LIST *expand_compound_array_assignment PARAMS((SHELL_VAR *, char *, int));
  64 extern void assign_compound_array_list PARAMS((SHELL_VAR *, WORD_LIST *, int));
  65 extern SHELL_VAR *assign_array_var_from_string PARAMS((SHELL_VAR *, char *, int));
  66
  67 extern char *expand_and_quote_assoc_word PARAMS((char *, int));
  68 extern void quote_compound_array_list PARAMS((WORD_LIST *, int));
  69
  70 extern int unbind_array_element PARAMS((SHELL_VAR *, char *, int));
  71 extern int skipsubscript PARAMS((const char *, int, int));
  72
  73 extern void print_array_assignment PARAMS((SHELL_VAR *, int));
  74 extern void print_assoc_assignment PARAMS((SHELL_VAR *, int));
  75
  76 extern arrayind_t array_expand_index PARAMS((SHELL_VAR *, char *, int, int));
  77 extern int valid_array_reference PARAMS((const char *, int));
  78 extern char *array_value PARAMS((const char *, int, int, int *, arrayind_t *));
  79 extern char *get_array_value PARAMS((const char *, int, int *, arrayind_t *));
  80
  81 extern char *array_keys PARAMS((char *, int, int));
  82
  83 extern char *array_variable_name PARAMS((const char *, int, char **, int *));
  84 extern SHELL_VAR *array_variable_part PARAMS((const char *, int, char **, int *));
  85
  86 #else
  87
  88 #define AV_ALLOWALL     0
  89 #define AV_QUOTED       0
  90 #define AV_USEIND       0
  91 #define AV_ASSIGNRHS    0
  92
  93 #define VA_ONEWORD      0
  94
  95 #endif
  96
  97 #endif /* !_ARRAYFUNC_H_ */