1 /* array.h -- definitions for the interface exported by array.c that allows 2 the rest of the shell to manipulate array variables. */ 3 4 /* Copyright (C) 1997-2009 Free Software Foundation, Inc. 5 6 This file is part of GNU Bash, the Bourne Again SHell. 7 8 Bash is free software: you can redistribute it and/or modify 9 it under the terms of the GNU General Public License as published by 10 the Free Software Foundation, either version 3 of the License, or 11 (at your option) any later version. 12 13 Bash is distributed in the hope that it will be useful, 14 but WITHOUT ANY WARRANTY; without even the implied warranty of 15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 GNU General Public License for more details. 17 18 You should have received a copy of the GNU General Public License 19 along with Bash. If not, see <http://www.gnu.org/licenses/>. 20 */ 21 22 23 #ifndef _ARRAY_H_ 24 #define _ARRAY_H_ 25 26 #include "stdc.h" 27 28 typedef intmax_t arrayind_t; 29 30 enum atype {array_indexed, array_assoc}; 31 32 typedef struct array { 33 enum atype type; 34 arrayind_t max_index; 35 int num_elements; 36 struct array_element *head; 37 } ARRAY; 38 39 typedef struct array_element { 40 arrayind_t ind; 41 char *value; 42 struct array_element *next, *prev; 43 } ARRAY_ELEMENT; 44 45 typedef int sh_ae_map_func_t __P((ARRAY_ELEMENT *, void *)); 46 47 /* Basic operations on entire arrays */ 48 extern ARRAY *array_create __P((void)); 49 extern void array_flush __P((ARRAY *)); 50 extern void array_dispose __P((ARRAY *)); 51 extern ARRAY *array_copy __P((ARRAY *)); 52 extern ARRAY *array_slice __P((ARRAY *, ARRAY_ELEMENT *, ARRAY_ELEMENT *)); 53 extern void array_walk __P((ARRAY *, sh_ae_map_func_t *, void *)); 54 55 extern ARRAY_ELEMENT *array_shift __P((ARRAY *, int, int)); 56 extern int array_rshift __P((ARRAY *, int, char *)); 57 extern ARRAY_ELEMENT *array_unshift_element __P((ARRAY *)); 58 extern int array_shift_element __P((ARRAY *, char *)); 59 60 extern ARRAY *array_quote __P((ARRAY *)); 61 extern ARRAY *array_quote_escapes __P((ARRAY *)); 62 extern ARRAY *array_dequote __P((ARRAY *)); 63 extern ARRAY *array_dequote_escapes __P((ARRAY *)); 64 extern ARRAY *array_remove_quoted_nulls __P((ARRAY *)); 65 66 extern char *array_subrange __P((ARRAY *, arrayind_t, arrayind_t, int, int)); 67 extern char *array_patsub __P((ARRAY *, char *, char *, int)); 68 extern char *array_modcase __P((ARRAY *, char *, int, int)); 69 70 /* Basic operations on array elements. */ 71 extern ARRAY_ELEMENT *array_create_element __P((arrayind_t, char *)); 72 extern ARRAY_ELEMENT *array_copy_element __P((ARRAY_ELEMENT *)); 73 extern void array_dispose_element __P((ARRAY_ELEMENT *)); 74 75 extern int array_insert __P((ARRAY *, arrayind_t, char *)); 76 extern ARRAY_ELEMENT *array_remove __P((ARRAY *, arrayind_t)); 77 extern char *array_reference __P((ARRAY *, arrayind_t)); 78 79 /* Converting to and from arrays */ 80 extern WORD_LIST *array_to_word_list __P((ARRAY *)); 81 extern ARRAY *array_from_word_list __P((WORD_LIST *)); 82 extern WORD_LIST *array_keys_to_word_list __P((ARRAY *)); 83 84 extern ARRAY *array_assign_list __P((ARRAY *, WORD_LIST *)); 85 86 extern char **array_to_argv __P((ARRAY *)); 87 88 extern char *array_to_assign __P((ARRAY *, int)); 89 extern char *array_to_string __P((ARRAY *, char *, int)); 90 extern ARRAY *array_from_string __P((char *, char *)); 91 92 /* Flags for array_shift */ 93 #define AS_DISPOSE 0x01 94 95 #define array_num_elements(a) ((a)->num_elements) 96 #define array_max_index(a) ((a)->max_index) 97 #define array_head(a) ((a)->head) 98 #define array_empty(a) ((a)->num_elements == 0) 99 100 #define element_value(ae) ((ae)->value) 101 #define element_index(ae) ((ae)->ind) 102 #define element_forw(ae) ((ae)->next) 103 #define element_back(ae) ((ae)->prev) 104 105 /* Convenience */ 106 #define array_push(a,v) \ 107 do { array_rshift ((a), 1, (v)); } while (0) 108 #define array_pop(a) \ 109 do { array_dispose_element (array_shift ((a), 1, 0)); } while (0) 110 111 #define GET_ARRAY_FROM_VAR(n, v, a) \ 112 do { \ 113 (v) = find_variable (n); \ 114 (a) = ((v) && array_p ((v))) ? array_cell (v) : (ARRAY *)0; \ 115 } while (0) 116 117 #define ALL_ELEMENT_SUB(c) ((c) == '@' || (c) == '*') 118 119 #endif /* _ARRAY_H_ */ 120