Bash-4.3 patch 32

[thirdparty/bash.git] / array.h

diff --git a/array.h b/array.h
index 9c8e5fc54024793da9426ffcb1e198ab9393b236..fb4f789f3f8879002bc02d62342c48c432acd168 100644 (file)
--- a/array.h
+++ b/array.h
@@ -1,23 +1,24 @@
 /* array.h -- definitions for the interface exported by array.c that allows
    the rest of the shell to manipulate array variables. */
 
-/* Copyright (C) 1997 Free Software Foundation, Inc.
+/* Copyright (C) 1997-2009 Free Software Foundation, Inc.
 
    This file is part of GNU Bash, the Bourne Again SHell.
 
-   Bash is free software; you can redistribute it and/or modify it under
-   the terms of the GNU General Public License as published by the Free
-   Software Foundation; either version 2, or (at your option) any later
-   version.
+   Bash is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
 
-   Bash is distributed in the hope that it will be useful, but WITHOUT ANY
-   WARRANTY; without even the implied warranty of MERCHANTABILITY or
-   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
-   for more details.
+   Bash is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with Bash.  If not, see <http://www.gnu.org/licenses/>.
+*/
 
-   You should have received a copy of the GNU General Public License along
-   with Bash; see the file COPYING.  If not, write to the Free Software
-   Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. */
 
 #ifndef _ARRAY_H_
 #define _ARRAY_H_
@@ -30,7 +31,8 @@ enum atype {array_indexed, array_assoc};
 
 typedef struct array {
        enum atype      type;
-       arrayind_t      max_index, num_elements;
+       arrayind_t      max_index;
+       int             num_elements;
        struct array_element *head;
 } ARRAY;
 
@@ -40,7 +42,7 @@ typedef struct array_element {
        struct array_element *next, *prev;
 } ARRAY_ELEMENT;
 
-typedef int sh_ae_map_func_t __P((ARRAY_ELEMENT *));
+typedef int sh_ae_map_func_t __P((ARRAY_ELEMENT *, void *));
 
 /* Basic operations on entire arrays */
 extern ARRAY   *array_create __P((void));
@@ -48,14 +50,22 @@ extern void array_flush __P((ARRAY *));
 extern void    array_dispose __P((ARRAY *));
 extern ARRAY   *array_copy __P((ARRAY *));
 extern ARRAY   *array_slice __P((ARRAY *, ARRAY_ELEMENT *, ARRAY_ELEMENT *));
-extern void    array_walk __P((ARRAY   *, sh_ae_map_func_t *));
+extern void    array_walk __P((ARRAY   *, sh_ae_map_func_t *, void *));
 
 extern ARRAY_ELEMENT *array_shift __P((ARRAY *, int, int));
 extern int     array_rshift __P((ARRAY *, int, char *));
+extern ARRAY_ELEMENT *array_unshift_element __P((ARRAY *));
+extern int     array_shift_element __P((ARRAY *, char *));
+
 extern ARRAY   *array_quote __P((ARRAY *));
+extern ARRAY   *array_quote_escapes __P((ARRAY *));
+extern ARRAY   *array_dequote __P((ARRAY *));
+extern ARRAY   *array_dequote_escapes __P((ARRAY *));
+extern ARRAY   *array_remove_quoted_nulls __P((ARRAY *));
 
-extern char    *array_subrange __P((ARRAY *, arrayind_t, arrayind_t, int));
+extern char    *array_subrange __P((ARRAY *, arrayind_t, arrayind_t, int, int));
 extern char    *array_patsub __P((ARRAY *, char *, char *, int));
+extern char    *array_modcase __P((ARRAY *, char *, int, int));
 
 /* Basic operations on array elements. */
 extern ARRAY_ELEMENT *array_create_element __P((arrayind_t, char *));
@@ -69,6 +79,8 @@ extern char   *array_reference __P((ARRAY *, arrayind_t));
 /* Converting to and from arrays */
 extern WORD_LIST *array_to_word_list __P((ARRAY *));
 extern ARRAY *array_from_word_list __P((WORD_LIST *));
+extern WORD_LIST *array_keys_to_word_list __P((ARRAY *));
+
 extern ARRAY *array_assign_list __P((ARRAY *, WORD_LIST *));
 
 extern char **array_to_argv __P((ARRAY *));
@@ -90,6 +102,18 @@ extern ARRAY *array_from_string __P((char *, char *));
 #define element_forw(ae)       ((ae)->next)
 #define element_back(ae)       ((ae)->prev)
 
+/* Convenience */
+#define array_push(a,v)        \
+  do { array_rshift ((a), 1, (v)); } while (0)
+#define array_pop(a) \
+  do { array_dispose_element (array_shift ((a), 1, 0)); } while (0)
+
+#define GET_ARRAY_FROM_VAR(n, v, a) \
+  do { \
+    (v) = find_variable (n); \
+    (a) = ((v) && array_p ((v))) ? array_cell (v) : (ARRAY *)0; \
+  } while (0)
+
 #define ALL_ELEMENT_SUB(c)     ((c) == '@' || (c) == '*')
 
 #endif /* _ARRAY_H_ */