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 int     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, max_size;
  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 char    *array_reference __P((ARRAY *, arrayind_t));
  44
  45 extern int      array_add_element __P((ARRAY *, arrayind_t, char *));
  46 extern ARRAY_ELEMENT *array_delete_element __P((ARRAY *, arrayind_t));
  47
  48 extern ARRAY_ELEMENT *new_array_element __P((arrayind_t, char *));
  49 extern void     destroy_array_element __P((ARRAY_ELEMENT *));
  50
  51 extern ARRAY    *new_array __P((void));
  52 extern void     empty_array __P((ARRAY *));
  53 extern void     dispose_array __P((ARRAY *));
  54 extern ARRAY    *dup_array __P((ARRAY *));
  55 extern ARRAY    *dup_array_subrange __P((ARRAY *, ARRAY_ELEMENT *, ARRAY_ELEMENT *));
  56 extern ARRAY_ELEMENT *new_array_element __P((arrayind_t, char *));
  57 extern ARRAY_ELEMENT *copy_array_element __P((ARRAY_ELEMENT *));
  58
  59 extern WORD_LIST *array_to_word_list __P((ARRAY *));
  60 extern ARRAY *word_list_to_array __P((WORD_LIST *));
  61 extern ARRAY *assign_word_list __P((ARRAY *, WORD_LIST *));
  62
  63 extern char **array_to_argv __P((ARRAY *));
  64
  65 extern char *array_to_assignment_string __P((ARRAY *));
  66 extern char *quoted_array_assignment_string __P((ARRAY *));
  67 extern char *array_to_string __P((ARRAY *, char *, int));
  68 extern ARRAY *string_to_array __P((char *, char *));
  69
  70 extern char *array_subrange __P((ARRAY *, int, int, int));
  71 extern char *array_pat_subst __P((ARRAY *, char *, char *, int));
  72
  73 extern ARRAY *array_quote __P((ARRAY *));
  74
  75 #define array_num_elements(a)   ((a)->num_elements)
  76 #define array_max_index(a)      ((a)->max_index)
  77 #define array_head(a)           ((a)->head)
  78 #define array_empty(a)          ((a)->num_elements == 0)
  79
  80 #define element_value(ae)       ((ae)->value)
  81 #define element_index(ae)       ((ae)->ind)
  82 #define element_forw(ae)        ((ae)->next)
  83 #define element_back(ae)        ((ae)->prev)
  84
  85 #define ALL_ELEMENT_SUB(c)      ((c) == '@' || (c) == '*')
  86
  87 #endif /* _ARRAY_H_ */