array.h

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